Editing Mod API Reference:GamePlayer

'''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'':


== 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.   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.)
** 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.