Mod API Reference:GamePlayer - Revision history

DanWL60 at 17:23, 4 December 2018

2018-12-04T17:23:03Z

← Older revision		Revision as of 17:23, 4 December 2018
Line 45:		Line 45:
	** bypassArmyCap: If this game has the army cap enabled, pass true here to bypass it and get what their income would be if the army cap didn't exist.		** bypassArmyCap: If this game has the army cap enabled, pass true here to bypass it and get what their income would be if the army cap didn't exist.
	** ignoreSanctionCards: If this game has sanction cards, and the player is being affected by them, pass true here to bypass them and get what their income would be if they weren't affected by sanction cards.		** ignoreSanctionCards: If this game has sanction cards, and the player is being affected by them, pass true here to bypass them and get what their income would be if they weren't affected by sanction cards.
			[[Category:Mod API Reference]]

Fizzer: Resources got moved to GameStanding

2017-12-05T01:25:11Z

Resources got moved to GameStanding

← Older revision		Revision as of 01:25, 5 December 2017
Line 22:		Line 22:
	* '''PlayersAcceptedMySurrender''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':		* '''PlayersAcceptedMySurrender''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':
	* '''PlayersVotedToBoot''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':		* '''PlayersVotedToBoot''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':
	* '''Resources''' ''Table<[[Mod API Reference:ResourceType\|ResourceType]] (enum),integer>'': In [[Commerce]] games, this indicates how much gold a player has. Note that this structure can be nil, which means the player has 0 gold or the information is fogged.
	* '''ScenarioID''' ''integer'':		* '''ScenarioID''' ''integer'':
	* '''SeenEndGameWindow''' ''boolean'':		* '''SeenEndGameWindow''' ''boolean'':

Fizzer at 23:05, 8 August 2017

2017-08-08T23:05:00Z

← Older revision		Revision as of 23:05, 8 August 2017
Line 22:		Line 22:
	* '''PlayersAcceptedMySurrender''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':		* '''PlayersAcceptedMySurrender''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':
	* '''PlayersVotedToBoot''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':		* '''PlayersVotedToBoot''' ''Table<[[Mod API Reference:PlayerID\|PlayerID]],[[Mod API Reference:DateTime\|DateTime]]>'':
			* '''Resources''' ''Table<[[Mod API Reference:ResourceType\|ResourceType]] (enum),integer>'': In [[Commerce]] games, this indicates how much gold a player has. Note that this structure can be nil, which means the player has 0 gold or the information is fogged.
	* '''ScenarioID''' ''integer'':		* '''ScenarioID''' ''integer'':
	* '''SeenEndGameWindow''' ''boolean'':		* '''SeenEndGameWindow''' ''boolean'':

Fizzer: DisplayName works in server hooks now

2017-06-13T22:47:08Z

DisplayName works in server hooks now

← Older revision		Revision as of 22:47, 13 June 2017
Line 38:		Line 38:
	== Functions ==		== Functions ==

	* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments. ~~Note that this function should only ever be called from Client hooks, as the server does not load player names.~~ Keep in mind that players can change their names, so a mod should never depend on a player having the same name from one turn to the next.		* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments. Keep in mind that players can change their names, so a mod should never depend on a player having the same name from one turn to the next.

	* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)		* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)

Fizzer at 22:21, 12 June 2017

2017-06-12T22:21:10Z

← Older revision		Revision as of 22:21, 12 June 2017
Line 38:		Line 38:
	== Functions ==		== Functions ==

	* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments. Note that this function should only ever be called from Client hooks, as the server does not load player names.		* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments. Note that this function should only ever be called from Client hooks, as the server does not load player names. Keep in mind that players can change their names, so a mod should never depend on a player having the same name from one turn to the next.

	* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)		* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)

Fizzer at 14:05, 4 June 2017

2017-06-04T14:05:32Z

← Older revision		Revision as of 14:05, 4 June 2017
Line 38:		Line 38:
	== Functions ==		== Functions ==

	* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments.		* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments. Note that this function should only ever be called from Client hooks, as the server does not load player names.

	* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)		* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)

Fizzer at 17:32, 2 June 2017

2017-06-02T17:32:41Z

← Older revision		Revision as of 17:32, 2 June 2017
Line 38:		Line 38:
	== Functions ==		== Functions ==

	* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string:		* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string: Gets the name of a player. Typically you will just pass nil and false to the two arguments.

			* '''Income'''('''armiesFromReinforcementCards''' ''integer'', '''standing''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''bypassArmyCap''' ''boolean'', '''ignoreSanctionCards''' ''boolean'') returns [[Mod API Reference:PlayerIncome\|PlayerIncome]]: Determine's a player's income (number of armies they receive per turn.)
			** armiesFromReinforcementCards: Pass in how many armies this player is receiving from playing reinforcement cards. Simply pass 0 if they're not playing any or you want to assume they won't play any in this calculation.
			** standing: To get a player's current income, simply pass the latest standing. Otherwise, if you're looking at history, you can pass a standing to get their income at that point in time.
			** bypassArmyCap: If this game has the army cap enabled, pass true here to bypass it and get what their income would be if the army cap didn't exist.
			** ignoreSanctionCards: If this game has sanction cards, and the player is being affected by them, pass true here to bypass them and get what their income would be if they weren't affected by sanction cards.

Fizzer at 00:46, 18 May 2017

2017-05-18T00:46:37Z

← Older revision		Revision as of 00:46, 18 May 2017
Line 34:		Line 34:
	* '''TurnSince''' ''[[Mod API Reference:DateTime\|DateTime]]'':		* '''TurnSince''' ''[[Mod API Reference:DateTime\|DateTime]]'':
	* '''WasOpenSeat''' ''boolean'':		* '''WasOpenSeat''' ''boolean'':


			== Functions ==

			* '''DisplayName'''('''standingOpt''' ''[[Mod API Reference:GameStanding\|GameStanding]]'', '''includeAIWas''' ''boolean'') returns string:

Fizzer: Created page with "'''GamePlayer''': All details about a player in a game. * '''AIPlayerID''' ''Nullable'': * '''Autopilo..."

2017-04-07T20:36:33Z

Created page with "'''GamePlayer''': All details about a player in a game. * '''AIPlayerID''' ''Nullable<PlayerID>'': * '''Autopilo..."

New page

'''GamePlayer''': All details about a player in a game.
* '''AIPlayerID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:PlayerID|PlayerID]]>'':
* '''AutopilotUsedForNLCFirstTurn''' ''boolean'':
* '''BegunFirstTurn''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:DateTime|DateTime]]>'':
* '''BootedBy''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:PlayerID|PlayerID]]>'':
* '''BootedDuration''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:TimeSpan|TimeSpan]]>'':
* '''Color''' ''[[Mod API Reference:GameColor|GameColor]]'':
* '''ColorLockedIn''' ''boolean'':
* '''DateInvited''' ''[[Mod API Reference:DateTime|DateTime]]'':
* '''EndedFirstTurn''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:DateTime|DateTime]]>'':
* '''GameID''' ''[[Mod API Reference:GameID|GameID]]'':
* '''GamePlayerID''' ''integer'':
* '''HasCommittedOrders''' ''boolean'':
* '''HighestTurnWatched''' ''integer'':
* '''HumanTurnedIntoAI''' ''boolean'':
* '''ID''' ''[[Mod API Reference:PlayerID|PlayerID]]'':
* '''IsAI''' ''boolean'':
* '''IsAIOrHumanTurnedIntoAI''' ''boolean'':
* '''LastGameSpeed''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''OrdersRevision''' ''integer'':
* '''PlayerID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:PlayerID|PlayerID]]>'':
* '''PlayersAcceptedMySurrender''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],[[Mod API Reference:DateTime|DateTime]]>'':
* '''PlayersVotedToBoot''' ''Table<[[Mod API Reference:PlayerID|PlayerID]],[[Mod API Reference:DateTime|DateTime]]>'':
* '''ScenarioID''' ''integer'':
* '''SeenEndGameWindow''' ''boolean'':
* '''Slot''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:Slot|Slot]]>'':
* '''SpeedRecordBase''' ''[[Mod API Reference:DateTime|DateTime]]'':
* '''SpeedSamplesForBoot''' ''Array<integer>'':
* '''State''' ''[[Mod API Reference:GamePlayerState|GamePlayerState]] (enum)'':
* '''Surrendered''' ''boolean'':
* '''Team''' ''[[Mod API Reference:TeamID|TeamID]]'':
* '''TimesBooted''' ''integer'':
* '''TimesComeBackFromAI''' ''integer'':
* '''TurnSince''' ''[[Mod API Reference:DateTime|DateTime]]'':
* '''WasOpenSeat''' ''boolean'':