Mod API Reference:ServerGame - Revision history

Fizzer at 23:16, 31 July 2019

2019-07-31T23:16:51Z

← Older revision		Revision as of 23:16, 31 July 2019
Line 25:		Line 25:
	** Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.		** Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.
	** Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.		** Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.
			** Note that this function should never be called while a game is in territory distribution. Player's don't officially have gold until after territories are distributed, so wait until then to start modifying gold.
	[[Category:Mod API Reference]]		[[Category:Mod API Reference]]

DanWL60 at 17:30, 4 December 2018

2018-12-04T17:30:59Z

← Older revision		Revision as of 17:30, 4 December 2018
Line 25:		Line 25:
	** Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.		** Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.
	** Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.		** Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.
			[[Category:Mod API Reference]]

Fizzer at 22:53, 8 August 2017

2017-08-08T22:53:03Z

← Older revision		Revision as of 22:53, 8 August 2017
Line 21:		Line 21:

	* '''SetPlayerResource'''('''pid''' ''[[Mod API Reference:PlayerID\|PlayerID]]'', '''type''' ''[[Mod API Reference:ResourceType\|ResourceType]] (enum)'', '''newValue''' ''integer''): Used to set the resources of a player, such as the amount of gold they have in a [[commerce]] game.		* '''SetPlayerResource'''('''pid''' ''[[Mod API Reference:PlayerID\|PlayerID]]'', '''type''' ''[[Mod API Reference:ResourceType\|ResourceType]] (enum)'', '''newValue''' ''integer''): Used to set the resources of a player, such as the amount of gold they have in a [[commerce]] game.
	This will set their resource value immediately, and update their displayed value on the player's screen so they can spend it immediately for their upcoming turn.		** This will set their resource value immediately, and update their displayed value on the player's screen so they can spend it immediately for their upcoming turn.
	When this function is used, the next turn will start with a GameOrderEvent which tells players that a mod updated their resource value. This way, there's still a log that something happened in history.		** When this function is used, the next turn will start with a GameOrderEvent which tells players that a mod updated their resource value. This way, there's still a log that something happened in history.
	Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.		** Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.
	Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.		** Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.

Fizzer at 22:50, 8 August 2017

2017-08-08T22:50:57Z

← Older revision		Revision as of 22:50, 8 August 2017
Line 17:		Line 17:
	* '''Settings''' ''[[Mod API Reference:GameSettings\|GameSettings]]'':		* '''Settings''' ''[[Mod API Reference:GameSettings\|GameSettings]]'':
	* '''TurnZeroStanding''' ''[[Mod API Reference:GameStanding\|GameStanding]]'':		* '''TurnZeroStanding''' ''[[Mod API Reference:GameStanding\|GameStanding]]'':

			== Functions ==

			* '''SetPlayerResource'''('''pid''' ''[[Mod API Reference:PlayerID\|PlayerID]]'', '''type''' ''[[Mod API Reference:ResourceType\|ResourceType]] (enum)'', '''newValue''' ''integer''): Used to set the resources of a player, such as the amount of gold they have in a [[commerce]] game.
			This will set their resource value immediately, and update their displayed value on the player's screen so they can spend it immediately for their upcoming turn.
			When this function is used, the next turn will start with a GameOrderEvent which tells players that a mod updated their resource value. This way, there's still a log that something happened in history.
			Note that if you reduce a player's gold value after they've committed orders, it may mess up their turn as they won't be able to spend as much gold as they were expecting, leading to failed deployments and failed attacks. Take care to only do this if the player approves it.
			Note that this function should never be called from an AdvanceTurn hook. Doing so will produce an error message. If you wish to change a player's resource from an AdvanceTurn hook, instead insert a [[Mod API Reference:GameOrderEvent\|GameOrderEvent]] to change it.

Fizzer: Created page with "'''ServerGame''': While GameWL contains public information about a game, ServerGame contains private information that's never shared with clients...."

2017-04-07T20:45:47Z

Created page with "'''ServerGame''': While GameWL contains public information about a game, ServerGame contains private information that's never shared with clients...."

New page

'''ServerGame''': While [[Mod API Reference:GameWL|GameWL]] contains public information about a game, ServerGame contains private information that's never shared with clients. This structure is only available in Server hooks.
* '''ActiveTerritoryPicks''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Array<[[Mod API Reference:TerritoryID|TerritoryID]]>>'':
* '''ActiveTurnOrders''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],Array<[[Mod API Reference:GameOrder|GameOrder]]>>'':
* '''CoinCreationFee''' ''integer'':
* '''CoinEntryFee''' ''integer'':
* '''CoinPrize''' ''integer'':
* '''CreatedByAPI''' ''boolean'':
* '''CyclicMoveOrder''' ''Array<[[Mod API Reference:PlayerID|PlayerID]]>'':
* '''DistributionStanding''' ''[[Mod API Reference:GameStanding|GameStanding]]'':
* '''Game''' ''[[Mod API Reference:GameWL|GameWL]]'':
* '''IsCustomCoinGame''' ''boolean'':
* '''LatestTurnStanding''' ''[[Mod API Reference:GameStanding|GameStanding]]'':
* '''PendingStateTransitions''' ''Array<[[Mod API Reference:PendingStateTransition|PendingStateTransition]]>'':
* '''PickOrder''' ''Array<[[Mod API Reference:PlayerID|PlayerID]]>'':
* '''PreviousTurnStanding''' ''[[Mod API Reference:GameStanding|GameStanding]]'':
* '''RequiredPlayerCount''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'':
* '''Settings''' ''[[Mod API Reference:GameSettings|GameSettings]]'':
* '''TurnZeroStanding''' ''[[Mod API Reference:GameStanding|GameStanding]]'':