Mod API Reference:GameSettings: Difference between revisions
Jump to navigation
Jump to search
Created page with " '''GameSettings''': All settings the game was started with. These are never changed once the game is created. * '''AIsSurrenderWhenOneHumanRemains''' ''boolean'': * '''Allo..." |
m MinimumBootTime and VoteBootTime do not exist in single player |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 23: | Line 23: | ||
* '''CoinPrize''' ''integer'': | * '''CoinPrize''' ''integer'': | ||
* '''Commanders''' ''boolean'': | * '''Commanders''' ''boolean'': | ||
* '''CommerceArmyCostMultiplier''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'': | |||
* '''CommerceCityBaseCost''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'': | |||
* '''CommerceGame''' ''boolean'': | |||
* '''Created''' ''[[Mod API Reference:DateTime|DateTime]]'': | * '''Created''' ''[[Mod API Reference:DateTime|DateTime]]'': | ||
* '''CustomScenario''' ''[[Mod API Reference:CustomScenario|CustomScenario]]'': | * '''CustomScenario''' ''[[Mod API Reference:CustomScenario|CustomScenario]]'': | ||
| Line 39: | Line 42: | ||
* '''InstantSurrender''' ''boolean'': | * '''InstantSurrender''' ''boolean'': | ||
* '''IsArchived''' ''boolean'': | * '''IsArchived''' ''boolean'': | ||
* '''IsCoinsGame''' ''boolean'': | * '''IsCoinsGame''' ''boolean'': | ||
* ''' | * '''IsTournamentLadderQuickmatchOrClanWar''' ''boolean'': | ||
* '''KillRatesAreModified''' ''boolean'': | * '''KillRatesAreModified''' ''boolean'': | ||
* '''LadderID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:LadderID|LadderID]]>'': | * '''LadderID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:LadderID|LadderID]]>'': | ||
| Line 51: | Line 53: | ||
* '''MaxCardsHold''' ''integer'': | * '''MaxCardsHold''' ''integer'': | ||
* '''MinimumArmyBonus''' ''integer'': | * '''MinimumArmyBonus''' ''integer'': | ||
* '''MinimumBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': | * '''MinimumBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': <!-- "Key MinimumBootTime does not exist for reading on GameSettings" in single player --> | ||
* '''MinimumVersionRequired''' ''integer'': | * '''MinimumVersionRequired''' ''integer'': | ||
* '''MoveOrder''' ''[[Mod API Reference:MoveOrderEnum|MoveOrderEnum]] (enum)'': | * '''MoveOrder''' ''[[Mod API Reference:MoveOrderEnum|MoveOrderEnum]] (enum)'': | ||
| Line 77: | Line 79: | ||
* '''TimesCanComeBackFromAI''' ''integer'': | * '''TimesCanComeBackFromAI''' ''integer'': | ||
* '''TournamentID''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'': | * '''TournamentID''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'': | ||
* '''VoteBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': | * '''VoteBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': <!-- "Key VoteBootTime does not exist for reading on GameSettings" in single player --> | ||
* '''WastelandSize''' ''integer'': | * '''WastelandSize''' ''integer'': | ||
[[Category:Mod API Reference]] | |||
Revision as of 14:23, 12 November 2023
GameSettings: All settings the game was started with. These are never changed once the game is created.
- AIsSurrenderWhenOneHumanRemains boolean:
- AllowAttackOnly boolean:
- AllowPercentageAttacks boolean:
- AllowTransferOnly boolean:
- AllowVacations boolean:
- ArmyCap Nullable<number>:
- AtStartDivideIntoTeamsOf integer:
- AutoBootEnabled boolean:
- AutoBootTime TimeSpan:
- AutoForceJoinTime TimeSpan:
- AutomaticTerritoryDistribution boolean:
- AutoStartGame boolean:
- BankDuration integer:
- BankingBootTimes Nullable<integer>:
- BonusArmyPer integer:
- BootedPlayersTurnIntoAIs boolean:
- CardHoldingsAndReceivesFogged boolean:
- CardPlayingsFogged boolean:
- Cards Table<CardID,CardGame>:
- CoinEntryFee integer:
- CoinPrize integer:
- Commanders boolean:
- CommerceArmyCostMultiplier Nullable<integer>:
- CommerceCityBaseCost Nullable<integer>:
- CommerceGame boolean:
- Created DateTime:
- CustomScenario CustomScenario:
- DefenseKillRate number:
- DirectBootTime TimeSpan:
- DirectBootTimeSummaryString string:
- DistributionModeID DistributionID:
- FogLevel GameFogLevel (enum):
- ForceJoinTime TimeSpan:
- HasAnySortOfFog boolean:
- HasSpecialUnits boolean:
- InitialBank TimeSpan:
- InitialNeutralsInDistribution integer:
- InitialNonDistributionArmies integer:
- InitialPlayerArmiesPerTerritory integer:
- InstantSurrender boolean:
- IsArchived boolean:
- IsCoinsGame boolean:
- IsTournamentLadderQuickmatchOrClanWar boolean:
- KillRatesAreModified boolean:
- LadderID Nullable<LadderID>:
- LimitDistributionTerritories integer:
- LocalDeployments boolean:
- LuckModifier number:
- MapID MapID:
- MapTestingGame boolean:
- MaxCardsHold integer:
- MinimumArmyBonus integer:
- MinimumBootTime TimeSpan:
- MinimumVersionRequired integer:
- MoveOrder MoveOrderEnum (enum):
- MultiAttack boolean:
- MultiPlayer boolean:
- Name string:
- NoSplit boolean:
- NumberOfCardsToReceiveEachTurn integer:
- NumberOfWastelands integer:
- OffenseKillRate number:
- OneArmyMustStandGuardOneOrZero integer:
- OneArmyStandsGuard boolean:
- OverriddenBonuses Table<BonusID,integer>:
- PersonalMessage string:
- PrivateMessaging boolean:
- RankedGame boolean:
- RealTimeGame boolean:
- RoundingMode RoundingModeEnum (enum):
- SinglePlayer boolean:
- StartedBy Nullable<PlayerID>:
- StartedByInfo PlayerInfo2:
- SurrenderedPlayersTurnIntoAIs boolean:
- TemplateIDUsed Nullable<TemplateID>:
- TemplateName string:
- TimesCanComeBackFromAI integer:
- TournamentID Nullable<integer>:
- VoteBootTime TimeSpan:
- WastelandSize integer: