Editing Mod API Reference:ClientGame
Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 8: | Line 8: | ||
* '''Settings''' ''[[Mod API Reference:GameSettings|GameSettings]]'': The settings this game uses. | * '''Settings''' ''[[Mod API Reference:GameSettings|GameSettings]]'': The settings this game uses. | ||
* '''LatestStanding''' ''[[Mod API Reference:GameStanding|GameStanding]]'': The latest state of the game. | * '''LatestStanding''' ''[[Mod API Reference:GameStanding|GameStanding]]'': The latest state of the game. | ||
| − | * '''GetDistributionStanding''': A function used to get the [[Mod API Reference:GameStanding|GameStanding]] during the picking phase of this game. Pass this function your own callback function which takes a [[Mod API Reference:GameStanding|GameStanding]] as an argument. For example: <code>game.GetDistributionStanding(function(standing) print('got ' .. standing) end)</code>. Your function will be called with nil if the distribution standing is not available, for example if it's an automatic distribution game. In the event of an error, such as lack of an internet connection, your callback will not be called | + | * '''GetDistributionStanding''': A function used to get the [[Mod API Reference:GameStanding|GameStanding]] during the picking phase of this game. Pass this function your own callback function which takes a [[Mod API Reference:GameStanding|GameStanding]] as an argument. For example: <code>game.GetDistributionStanding(function(standing) print('got ' .. standing) end)</code>. Your function will be called with nil if the distribution standing is not available, for example if it's an automatic distribution game. In the event of an error, such as lack of an internet connection, your callback will not be called. |
| − | * '''GetStanding''': A function used to get the [[Mod API Reference:GameStanding|GameStanding]] for any turn of the game. Pass this function two arguments: first, an integer | + | * '''GetStanding''': A function used to get the [[Mod API Reference:GameStanding|GameStanding]] for any turn of the game. Pass this function two arguments: first, an integer represneting what turn to get (0 for the start of the game, 1 for the second turn, 2 for the third turn, etc.) Second, pass a callback function that will get called with the [[Mod API Reference:GameStanding|GameStanding]]. See GetDistributionStanding for an example. |
* '''GetTurn''': A function used to get the [[Mod API Reference:GameTurn|GameTurn]] for any turn of the game. Identical to GetStanding in every way, except that it calls back your function with a [[Mod API Reference:GameTurn|GameTurn]]. | * '''GetTurn''': A function used to get the [[Mod API Reference:GameTurn|GameTurn]] for any turn of the game. Identical to GetStanding in every way, except that it calls back your function with a [[Mod API Reference:GameTurn|GameTurn]]. | ||
| − | * '''Orders''' '' | + | * '''Orders''' ''List<[[Mod API Reference:GameOrder|GameOrder]]>'': Allows you to read and write the orders that the player is building up in the orders list for the current turn. You can call this property to see the orders, or assign a list of orders to it to replace the player's orders with your list. |
* '''CreateDialog''': A function used to create a new dialog on the screen for players to interact with. Pass a single function callback as a argument to CreateDialog. Your function callback will be passed the same arguments as the the Client_PresentMenuUI hook, documented at [[Mod Hooks]] | * '''CreateDialog''': A function used to create a new dialog on the screen for players to interact with. Pass a single function callback as a argument to CreateDialog. Your function callback will be passed the same arguments as the the Client_PresentMenuUI hook, documented at [[Mod Hooks]] | ||
* '''SendGameCustomMessage''': A function used to send a message to the server, which will be handled by the Server_GameCustomMessage hook as documented at [[Mod Hooks]]. Note that this message is rate-limited to 5 calls every 5 seconds per client to avoid extra tax on the server. Arguments: | * '''SendGameCustomMessage''': A function used to send a message to the server, which will be handled by the Server_GameCustomMessage hook as documented at [[Mod Hooks]]. Note that this message is rate-limited to 5 calls every 5 seconds per client to avoid extra tax on the server. Arguments: | ||
| Line 17: | Line 17: | ||
# '''payload''': Data that will be delivered to the Server_GameCustomMessage hook. Must be a lua table. | # '''payload''': Data that will be delivered to the Server_GameCustomMessage hook. Must be a lua table. | ||
# '''callback''': A function you provide which will be called back when the message is complete. If the message fails, such as due to a disconnected internet connection or an error in the server hook, this callback will not be invoked. If it is invoked, it will be passed a single argument of a lua table that the Server_GameCustomMessage hook provided as a return value. | # '''callback''': A function you provide which will be called back when the message is complete. If the message fails, such as due to a disconnected internet connection or an error in the server hook, this callback will not be invoked. If it is invoked, it will be passed a single argument of a lua table that the Server_GameCustomMessage hook provided as a return value. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
[[Category:Mod API Reference]] | [[Category:Mod API Reference]] | ||