Mod API Reference:GameSettings: Difference between revisions
Jump to navigation
Jump to search
Removed IsCustomCoinGame key since using it gives missing key errors |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 31: | Line 31: | ||
* '''DirectBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': | * '''DirectBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': | ||
* '''DirectBootTimeSummaryString''' ''string'': | * '''DirectBootTimeSummaryString''' ''string'': | ||
* '''DistributionModeID''' ''[[Mod API Reference:DistributionID|DistributionID]]'': | * '''DistributionModeID''' ''[[Mod API Reference:DistributionID|DistributionID]]'': This can be assigned the numeric distribution mode that a map makes available, or to one of the following constants: | ||
** WL.DistributionMode.FullDistribution | |||
** WL.DistributionMode.RandomWarlordsDistribution | |||
** WL.DistributionMode.RandomCitiesDistribution | |||
** WL.DistributionMode.CustomScenario | |||
* '''FogLevel''' ''[[Mod API Reference:GameFogLevel|GameFogLevel]] (enum)'': | * '''FogLevel''' ''[[Mod API Reference:GameFogLevel|GameFogLevel]] (enum)'': | ||
* '''ForceJoinTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': | * '''ForceJoinTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'': | ||
| Line 53: | Line 57: | ||
* '''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 79: | Line 83: | ||
* '''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]] | [[Category:Mod API Reference]] | ||
Latest revision as of 14:35, 16 June 2024
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: This can be assigned the numeric distribution mode that a map makes available, or to one of the following constants:
- WL.DistributionMode.FullDistribution
- WL.DistributionMode.RandomWarlordsDistribution
- WL.DistributionMode.RandomCitiesDistribution
- WL.DistributionMode.CustomScenario
- 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: