Home › Engine Lua tables › GameConfiguration

Engine executable. Settings and tools of the game program (CivilizationVI.exe), usable without a mod. Mostly undocumented debug and configuration functionality; descriptions come from analysis of the executable and have not all been tried in the running game.

GameConfiguration

Static table with 82 methods. registered by exe interface GameCore::App::Configuration::Lua::IGame; game scripts call 51 of 82 methods. Registering function 0x1094a0.

Methods are called with a dot (GameConfiguration.Method(...)).

Method	Returns	In game scripts	Example	Status
`GameConfiguration.AddEnabledMods(arg1, [arg2: boolean], …)`	—	3 calls, 2 files	`GameConfiguration.AddEnabledMods( modGUID )`	inferred
`GameConfiguration.ClearEnabledMods()`	—	2 calls, 1 files	`GameConfiguration.ClearEnabledMods()`	inferred
`GameConfiguration.GetAIPlayerCount() -> number`	number	not called	—	inferred
`GameConfiguration.GetAIPlayerIDs() -> table`	table	1 calls, 1 files	`local aAIIDs = GameConfiguration.GetAIPlayerIDs()`	inferred
`GameConfiguration.GetAvailablePlayerCount() -> number`	number	not called	—	inferred
`GameConfiguration.GetAvailablePlayerIDs() -> table`	table	1 calls, 1 files	`local aAvailableIDs = GameConfiguration.GetAvailablePlayerIDs()`	inferred
`GameConfiguration.GetCalendarType() -> number`	number	4 calls, 4 files	`local greatWorkCreationDate:string = Calendar.MakeDateStr(nTurnCreated, GameConfiguration.GetCalendarType()`	inferred
`GameConfiguration.GetCivilizationUsageIDs(…) -> table`	table	not called	—	inferred
`GameConfiguration.GetCloudTurnPlayer() -> number`	number	not called	—	inferred
`GameConfiguration.GetEnableModsMetaString(…) -> 1 value`	1 value	not called	—	inferred
`GameConfiguration.GetEnabledGameModesMetaString(…) -> 1 value`	1 value	1 calls, 1 files	`local enabledModesMetaData : string = GameConfiguration.GetEnabledGameModesMetaString()`	inferred
`GameConfiguration.GetEnabledMods(…) -> table, table, boolean`	table, table, boolean	1 calls, 1 files	`local enabledMods = GameConfiguration.GetEnabledMods()`	inferred
`GameConfiguration.GetFirstAvailablePlayer() -> number`	number	not called	—	inferred
`GameConfiguration.GetGameMode() -> number`	number	not called	—	inferred
`GameConfiguration.GetGameSpeedType() -> number`	number	7 calls, 6 files	`local eGameSpeed = GameConfiguration.GetGameSpeedType()`	inferred
`GameConfiguration.GetGameState() -> number`	number	22 calls, 6 files	`if(GameConfiguration.GetGameState()`	inferred
`GameConfiguration.GetHandicapType() -> number`	number	not called	—	inferred
`GameConfiguration.GetHiddenPlayerCount() -> number`	number	3 calls, 3 files	`local participatingCount = defPlayers + GameConfiguration.GetHiddenPlayerCount()`	inferred
`GameConfiguration.GetHiddenPlayerIDs() -> table`	table	not called	—	inferred
`GameConfiguration.GetHumanPlayerCount() -> number`	number	1 calls, 1 files	`local neededHumanPlayers = humanPlayerCount - GameConfiguration.GetHumanPlayerCount()`	inferred
`GameConfiguration.GetHumanPlayerIDs() -> table`	table	3 calls, 3 files	`local humans = GameConfiguration.GetHumanPlayerIDs()`	inferred
`GameConfiguration.GetInUsePlayerCount() -> number`	number	not called	—	inferred
`GameConfiguration.GetInUsePlayerIDs() -> table`	table	1 calls, 1 files	`local kInUsePlayerIDs : table = GameConfiguration.GetInUsePlayerIDs()`	inferred
`GameConfiguration.GetMaxTurns() -> number`	number	1 calls, 1 files	`local maxTurns :number = GameConfiguration.GetMaxTurns()`	inferred
`GameConfiguration.GetMultiplayerPlayerIDs() -> table`	table	8 calls, 1 files	`local player_ids = GameConfiguration.GetMultiplayerPlayerIDs()`	inferred
`GameConfiguration.GetObserverCount() -> number`	number	not called	—	inferred
`GameConfiguration.GetObserverIDs() -> table`	table	not called	—	inferred
`GameConfiguration.GetParticipatingPlayerCount([arg1: boolean]) -> number`	number	1 calls, 1 files	`if(GameConfiguration.GetParticipatingPlayerCount()`	inferred
`GameConfiguration.GetParticipatingPlayerIDs() -> table`	table	13 calls, 8 files	`local player_ids = GameConfiguration.GetParticipatingPlayerIDs()`	inferred
`GameConfiguration.GetPausePlayer() -> number`	number	1 calls, 1 files	`local pausePlayerID : number = GameConfiguration.GetPausePlayer()`	inferred
`GameConfiguration.GetPossibleParticipatingPlayerIDs() -> table`	table	not called	—	inferred
`GameConfiguration.GetRequiredMods([arg1], …) -> table, table, string, string`	table, table, string, string	not called	—	inferred
`GameConfiguration.GetRuleSet(…) -> 1 value`	1 value	3 calls, 2 files	`local isRuleSet :boolean = GameConfiguration.GetRuleSet()`	inferred
`GameConfiguration.GetStartEra() -> number`	number	6 calls, 3 files	`if (eraDef.Hash ~= GameConfiguration.GetStartEra()`	inferred
`GameConfiguration.GetStartTurn() -> number`	number	31 calls, 16 files	`turn = (turn - GameConfiguration.GetStartTurn()`	inferred
`GameConfiguration.GetStartYear() -> number`	number	not called	—	inferred
`GameConfiguration.GetTeamName(arg1: number, …) -> 1 value`	1 value	17 calls, 11 files	`newPulldownEntry.teamName = GameConfiguration.GetTeamName(-1)`	inferred
`GameConfiguration.GetTeamPlayerCount(arg1, [arg2: boolean]) -> number`	number	5 calls, 2 files	`or (GameConfiguration.GetTeamPlayerCount(teamID)`	inferred
`GameConfiguration.GetTurnLimitType() -> number`	number	not called	—	inferred
`GameConfiguration.GetTurnTimerType() -> number`	number	not called	—	inferred
`GameConfiguration.GetValue(arg1: number\\|string, …) -> 1 value`	1 value	25 calls, 12 files	`local ruleset :string = GameConfiguration.GetValue("RULESET")`	inferred
`GameConfiguration.IsAnyMultiplayer() -> boolean`	boolean	60 calls, 46 files	`if GameConfiguration.IsAnyMultiplayer()`	inferred
`GameConfiguration.IsCrossPlayInternetMultiplayer() -> boolean`	boolean	not called	—	inferred
`GameConfiguration.IsHotseat() -> boolean`	boolean	102 calls, 56 files	`if GameConfiguration.IsHotseat()`	inferred
`GameConfiguration.IsInternetMultiplayer() -> boolean`	boolean	3 calls, 3 files	`elseif(GameConfiguration.IsInternetMultiplayer()`	inferred
`GameConfiguration.IsKickVoting() -> boolean`	boolean	not called	—	inferred
`GameConfiguration.IsLANMultiplayer() -> boolean`	boolean	4 calls, 3 files	`elseif GameConfiguration.IsLANMultiplayer()`	inferred
`GameConfiguration.IsMatchMaking() -> boolean`	boolean	9 calls, 3 files	`if(GameConfiguration.IsMatchMaking()`	inferred
`GameConfiguration.IsNetworkMultiplayer() -> boolean`	boolean	28 calls, 15 files	`if(GameConfiguration.IsNetworkMultiplayer()`	inferred
`GameConfiguration.IsPaused() -> boolean`	boolean	11 calls, 4 files	`if(GameConfiguration.IsPaused()`	inferred
`GameConfiguration.IsPlayByCloud() -> boolean`	boolean	34 calls, 13 files	`if(GameConfiguration.IsPlayByCloud()`	inferred
`GameConfiguration.IsSavedGame() -> boolean`	boolean	5 calls, 3 files	`if (GameConfiguration.IsSavedGame()`	inferred
`GameConfiguration.IsWorldBuilder() -> boolean`	boolean	not called	—	inferred
`GameConfiguration.IsWorldBuilderEditor() -> boolean`	boolean	19 calls, 10 files	`if GameConfiguration.IsWorldBuilderEditor()`	inferred
`GameConfiguration.MakeHash([arg1: integer]) -> number, number`	number, number	not called	—	inferred
`GameConfiguration.PlayersWantPause() -> boolean`	boolean	not called	—	inferred
`GameConfiguration.RegenerateSeeds()`	—	4 calls, 4 files	`GameConfiguration.RegenerateSeeds()`	inferred
`GameConfiguration.RemovePlayer(arg1: integer) -> boolean`	boolean	2 calls, 2 files	`GameConfiguration.RemovePlayer(voidValue1)`	inferred
`GameConfiguration.SetCalendarType(…)`	—	not called	—	inferred
`GameConfiguration.SetCloudTurnPlayer()`	—	not called	—	inferred
`GameConfiguration.SetGameMode()`	—	not called	—	inferred
`GameConfiguration.SetGameSpeedType(arg1, …)`	—	2 calls, 2 files	`GameConfiguration.SetGameSpeedType(gameSpeed)`	inferred
`GameConfiguration.SetGameState(…)`	—	not called	—	inferred
`GameConfiguration.SetHandicapType(arg1, …)`	—	2 calls, 2 files	`GameConfiguration.SetHandicapType(handicap)`	inferred
`GameConfiguration.SetKickVoting(arg1: boolean)`	—	1 calls, 1 files	`GameConfiguration.SetKickVoting(true)`	inferred
`GameConfiguration.SetMatchMaking(arg1: boolean)`	—	2 calls, 1 files	`GameConfiguration.SetMatchMaking(true)`	inferred
`GameConfiguration.SetMaxTurns(arg1: integer)`	—	2 calls, 2 files	`GameConfiguration.SetMaxTurns(maxTurns)`	inferred
`GameConfiguration.SetParticipatingPlayerCount(arg1: integer) -> number`	number	4 calls, 4 files	`GameConfiguration.SetParticipatingPlayerCount(2)`	inferred
`GameConfiguration.SetRuleSet(arg1: string)`	—	4 calls, 3 files	`GameConfiguration.SetRuleSet(ruleSet)`	inferred
`GameConfiguration.SetStartEra(arg1, …)`	—	2 calls, 2 files	`GameConfiguration.SetStartEra(gameStartEra)`	inferred
`GameConfiguration.SetStartTurn([arg1: integer])`	—	not called	—	inferred
`GameConfiguration.SetStartYear([arg1: integer])`	—	not called	—	inferred
`GameConfiguration.SetToDefaultGameName()`	—	1 calls, 1 files	`GameConfiguration.SetToDefaultGameName()`	inferred
`GameConfiguration.SetToDefaults([arg1: integer])`	—	33 calls, 9 files	`GameConfiguration.SetToDefaults()`	inferred
`GameConfiguration.SetToPreGame([arg1: integer])`	—	1 calls, 1 files	`GameConfiguration.SetToPreGame()`	inferred
`GameConfiguration.SetTurnLimitType(arg1, …)`	—	2 calls, 2 files	`GameConfiguration.SetTurnLimitType(TurnLimitTypes.CUSTOM)`	inferred
`GameConfiguration.SetTurnTimerType(…)`	—	not called	—	inferred
`GameConfiguration.SetValue(arg1: number\\|string, arg2, …)`	—	16 calls, 7 files	`GameConfiguration.SetValue(id, value)`	inferred
`GameConfiguration.SetValueHash([arg1: integer], [arg2])`	—	not called	—	inferred
`GameConfiguration.SetWorldBuilder([arg1])`	—	not called	—	inferred
`GameConfiguration.SetWorldBuilderEditor(arg1: boolean)`	—	7 calls, 3 files	`GameConfiguration.SetWorldBuilderEditor(true)`	inferred
`GameConfiguration.UpdateEnabledMods()`	—	2 calls, 2 files	`GameConfiguration.UpdateEnabledMods()`	inferred