Mod API Reference:GameSettings - Revision history

Fizzer at 05:45, 15 March 2025

2025-03-15T05:45:43Z

← Older revision		Revision as of 05:45, 15 March 2025
Line 23:		Line 23:
	* '''CoinPrize''' ''integer'':		* '''CoinPrize''' ''integer'':
	* '''Commanders''' ''boolean'':		* '''Commanders''' ''boolean'':
	* '''CommerceArmyCostMultiplier''' ''[[Mod API Reference:Nullable\|Nullable]]<integer>'':		* '''CommerceArmyCostMultiplier''' ''[[Mod API Reference:Nullable\|Nullable]]<integer>'': The army cost multiplier that determines how expensive armies are in commerce games. If set to a number, this game is a commerce game. If nil, it's not.
	* '''CommerceCityBaseCost''' ''[[Mod API Reference:Nullable\|Nullable]]<integer>'':		* '''CommerceCityBaseCost''' ''[[Mod API Reference:Nullable\|Nullable]]<integer>'':
	* '''CommerceGame''' ''boolean'':		* '''CommerceGame''' ''boolean'': A read-only property that checks if the game is a commerce game. This just checks if CommerceArmyCostMultiplier is not nil.
	* '''Created''' ''[[Mod API Reference:DateTime\|DateTime]]'':		* '''Created''' ''[[Mod API Reference:DateTime\|DateTime]]'':
	* '''CustomScenario''' ''[[Mod API Reference:CustomScenario\|CustomScenario]]'':		* '''CustomScenario''' ''[[Mod API Reference:CustomScenario\|CustomScenario]]'':

Fizzer at 14:35, 16 June 2024

2024-06-16T14:35:59Z

← Older revision		Revision as of 14:35, 16 June 2024
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]]'':

DanWL60: MinimumBootTime and VoteBootTime do not exist in single player

2023-11-12T14:23:47Z

MinimumBootTime and VoteBootTime do not exist in single player

← Older revision		Revision as of 14:23, 12 November 2023
Line 53:		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 79:		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]]		[[Category:Mod API Reference]]

JK 3: Removed IsCustomCoinGame key since using it gives missing key errors

2023-04-07T20:10:20Z

Removed IsCustomCoinGame key since using it gives missing key errors

← Older revision		Revision as of 20:10, 7 April 2023
Line 42:		Line 42:
	* '''InstantSurrender''' ''boolean'':		* '''InstantSurrender''' ''boolean'':
	* '''IsArchived''' ''boolean'':		* '''IsArchived''' ''boolean'':
	* '''IsCoinsGame''' ''boolean'':		* '''IsCoinsGame''' ''boolean'':
	* '''IsCustomCoinGame''' ''boolean'':
	* '''IsTournamentLadderQuickmatchOrClanWar''' ''boolean'':		* '''IsTournamentLadderQuickmatchOrClanWar''' ''boolean'':
	* '''KillRatesAreModified''' ''boolean'':		* '''KillRatesAreModified''' ''boolean'':

Fizzer at 13:40, 20 March 2023

2023-03-20T13:40:26Z

← Older revision		Revision as of 13:40, 20 March 2023
Line 44:		Line 44:
	* '''IsCoinsGame''' ''boolean'':		* '''IsCoinsGame''' ''boolean'':
	* '''IsCustomCoinGame''' ''boolean'':		* '''IsCustomCoinGame''' ''boolean'':
	* '''~~IsTournamentOrLadder~~''' ''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]]>'':

DanWL60 at 17:23, 4 December 2018

2018-12-04T17:23:22Z

← Older revision		Revision as of 17:23, 4 December 2018
Line 82:		Line 82:
	* '''VoteBootTime''' ''[[Mod API Reference:TimeSpan\|TimeSpan]]'':		* '''VoteBootTime''' ''[[Mod API Reference:TimeSpan\|TimeSpan]]'':
	* '''WastelandSize''' ''integer'':		* '''WastelandSize''' ''integer'':
			[[Category:Mod API Reference]]

Fizzer at 23:02, 8 August 2017

2017-08-08T23:02:13Z

← Older revision		Revision as of 23:02, 8 August 2017
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]]'':

Fizzer: Created page with " '''GameSettings''': All settings the game was started with. These are never changed once the game is created. * '''AIsSurrenderWhenOneHumanRemains''' ''boolean'': * '''Allo..."

2017-04-04T06:09:41Z

Created page with " '''GameSettings''': All settings the game was started with. These are never changed once the game is created. * '''AIsSurrenderWhenOneHumanRemains''' ''boolean'': * '''Allo..."

New page

'''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''' ''[[Mod API Reference:Nullable|Nullable]]<number>'':
* '''AtStartDivideIntoTeamsOf''' ''integer'':
* '''AutoBootEnabled''' ''boolean'':
* '''AutoBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''AutoForceJoinTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''AutomaticTerritoryDistribution''' ''boolean'':
* '''AutoStartGame''' ''boolean'':
* '''BankDuration''' ''integer'':
* '''BankingBootTimes''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'':
* '''BonusArmyPer''' ''integer'':
* '''BootedPlayersTurnIntoAIs''' ''boolean'':
* '''CardHoldingsAndReceivesFogged''' ''boolean'':
* '''CardPlayingsFogged''' ''boolean'':
* '''Cards''' ''Table<[[Mod API Reference:CardID|CardID]],[[Mod API Reference:CardGame|CardGame]]>'':
* '''CoinEntryFee''' ''integer'':
* '''CoinPrize''' ''integer'':
* '''Commanders''' ''boolean'':
* '''Created''' ''[[Mod API Reference:DateTime|DateTime]]'':
* '''CustomScenario''' ''[[Mod API Reference:CustomScenario|CustomScenario]]'':
* '''DefenseKillRate''' ''number'':
* '''DirectBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''DirectBootTimeSummaryString''' ''string'':
* '''DistributionModeID''' ''[[Mod API Reference:DistributionID|DistributionID]]'':
* '''FogLevel''' ''[[Mod API Reference:GameFogLevel|GameFogLevel]] (enum)'':
* '''ForceJoinTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''HasAnySortOfFog''' ''boolean'':
* '''HasSpecialUnits''' ''boolean'':
* '''InitialBank''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''InitialNeutralsInDistribution''' ''integer'':
* '''InitialNonDistributionArmies''' ''integer'':
* '''InitialPlayerArmiesPerTerritory''' ''integer'':
* '''InstantSurrender''' ''boolean'':
* '''IsArchived''' ''boolean'':
* '''IsCoinsGame''' ''boolean'':
* '''IsCustomCoinGame''' ''boolean'':
* '''IsTournamentOrLadder''' ''boolean'':
* '''KillRatesAreModified''' ''boolean'':
* '''LadderID''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:LadderID|LadderID]]>'':
* '''LimitDistributionTerritories''' ''integer'':
* '''LocalDeployments''' ''boolean'':
* '''LuckModifier''' ''number'':
* '''MapID''' ''[[Mod API Reference:MapID|MapID]]'':
* '''MapTestingGame''' ''boolean'':
* '''MaxCardsHold''' ''integer'':
* '''MinimumArmyBonus''' ''integer'':
* '''MinimumBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''MinimumVersionRequired''' ''integer'':
* '''MoveOrder''' ''[[Mod API Reference:MoveOrderEnum|MoveOrderEnum]] (enum)'':
* '''MultiAttack''' ''boolean'':
* '''MultiPlayer''' ''boolean'':
* '''Name''' ''string'':
* '''NoSplit''' ''boolean'':
* '''NumberOfCardsToReceiveEachTurn''' ''integer'':
* '''NumberOfWastelands''' ''integer'':
* '''OffenseKillRate''' ''number'':
* '''OneArmyMustStandGuardOneOrZero''' ''integer'':
* '''OneArmyStandsGuard''' ''boolean'':
* '''OverriddenBonuses''' ''Table<[[Mod API Reference:BonusID|BonusID]],integer>'':
* '''PersonalMessage''' ''string'':
* '''PrivateMessaging''' ''boolean'':
* '''RankedGame''' ''boolean'':
* '''RealTimeGame''' ''boolean'':
* '''RoundingMode''' ''[[Mod API Reference:RoundingModeEnum|RoundingModeEnum]] (enum)'':
* '''SinglePlayer''' ''boolean'':
* '''StartedBy''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:PlayerID|PlayerID]]>'':
* '''StartedByInfo''' ''[[Mod API Reference:PlayerInfo2|PlayerInfo2]]'':
* '''SurrenderedPlayersTurnIntoAIs''' ''boolean'':
* '''TemplateIDUsed''' ''[[Mod API Reference:Nullable|Nullable]]<[[Mod API Reference:TemplateID|TemplateID]]>'':
* '''TemplateName''' ''string'':
* '''TimesCanComeBackFromAI''' ''integer'':
* '''TournamentID''' ''[[Mod API Reference:Nullable|Nullable]]<integer>'':
* '''VoteBootTime''' ''[[Mod API Reference:TimeSpan|TimeSpan]]'':
* '''WastelandSize''' ''integer'':