Home › Engine Lua tables › UserConfiguration

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.

UserConfiguration

Static table with 52 methods. registered by exe interface GameCore::App::Configuration::Lua::IUser; game scripts call 28 of 52 methods. Registering function 0x1116b0.

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

Method	Returns	In game scripts	Example	Status
`UserConfiguration.CommitToOptions()`	—	1 calls, 1 files	`UserConfiguration.CommitToOptions()`	inferred
`UserConfiguration.GetChatTextValue() -> number`	number	1 calls, 1 files	`local chatTextSize:number = UserConfiguration.GetChatTextValue()`	inferred
`UserConfiguration.GetCivicsTreeFilterIndex() -> number`	number	not called	—	inferred
`UserConfiguration.GetCivicsTreeSearchString(…) -> 1 value`	1 value	not called	—	inferred
`UserConfiguration.GetClockFormat() -> number`	number	4 calls, 3 files	`if (UserConfiguration.GetClockFormat()`	inferred
`UserConfiguration.GetPlayByCloudClientReadyBehavior() -> number`	number	1 calls, 1 files	`local readyUpBehavior :number = UserConfiguration.GetPlayByCloudClientReadyBehavior()`	inferred
`UserConfiguration.GetPlayByCloudEndTurnBehavior() -> number`	number	2 calls, 1 files	`if(UserConfiguration.GetPlayByCloudEndTurnBehavior()`	inferred
`UserConfiguration.GetPlotTooltipDelay() -> number`	number	1 calls, 1 files	`local pauseTime = UserConfiguration.GetPlotTooltipDelay()`	inferred
`UserConfiguration.GetRibbonStats() -> number`	number	not called	—	inferred
`UserConfiguration.GetShowCivicsTreeGovernment() -> boolean`	boolean	1 calls, 1 files	`if UserConfiguration.GetShowCivicsTreeGovernment()`	inferred
`UserConfiguration.GetShowCivicsTreeKey() -> boolean`	boolean	1 calls, 1 files	`if UserConfiguration.GetShowCivicsTreeKey()`	inferred
`UserConfiguration.GetShowTechTreeKey() -> boolean`	boolean	1 calls, 1 files	`if UserConfiguration.GetShowTechTreeKey()`	inferred
`UserConfiguration.GetTechTreeFilterIndex() -> number`	number	not called	—	inferred
`UserConfiguration.GetTechTreeSearchString(…) -> 1 value`	1 value	not called	—	inferred
`UserConfiguration.GetValue(arg1: number\\|string, …) -> 1 value`	1 value	3 calls, 2 files	`if (UserConfiguration.GetValue("RenderViewIsLocked")`	inferred
`UserConfiguration.IsAutoEndTurn(…) -> boolean`	boolean	3 calls, 1 files	`if(UserConfiguration.IsAutoEndTurn()`	inferred
`UserConfiguration.IsAutoProdQueueEnabled() -> boolean`	boolean	3 calls, 1 files	`if GetQueueSize(m_pCity) > 1 or UserConfiguration.IsAutoProdQueueEnabled()`	inferred
`UserConfiguration.IsAutoUnitCycle(…) -> boolean`	boolean	3 calls, 2 files	`if UserConfiguration.IsAutoUnitCycle()`	inferred
`UserConfiguration.IsCityRangeAttackTurnBlocking(…) -> boolean`	boolean	1 calls, 1 files	`return (UserConfiguration.IsCityRangeAttackTurnBlocking()`	inferred
`UserConfiguration.IsEdgePanEnabled() -> boolean`	boolean	1 calls, 1 files	`return UserConfiguration.IsEdgePanEnabled()`	inferred
`UserConfiguration.IsQuickCombat() -> boolean`	boolean	not called	—	inferred
`UserConfiguration.IsQuickMovement() -> boolean`	boolean	not called	—	inferred
`UserConfiguration.IsValueLocked(arg1: number\\|string) -> boolean`	boolean	12 calls, 1 files	`UserConfiguration.IsValueLocked("QuickCombat")`	inferred
`UserConfiguration.LayoutOverride(…) -> number`	number	not called	—	inferred
`UserConfiguration.LockValue(arg1: number\\|string, arg2: boolean)`	—	4 calls, 2 files	`UserConfiguration.LockValue("QuickCombat", false)`	inferred
`UserConfiguration.NoBasicHelp(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ReplaceDragWithClick() -> boolean`	boolean	not called	—	inferred
`UserConfiguration.RestoreCheckpoint()`	—	1 calls, 1 files	`UserConfiguration.RestoreCheckpoint()`	inferred
`UserConfiguration.SaveCheckpoint()`	—	3 calls, 1 files	`UserConfiguration.SaveCheckpoint()`	inferred
`UserConfiguration.SetCivicsTreeFilterIndex()`	—	not called	—	inferred
`UserConfiguration.SetCivicsTreeSearchString(…)`	—	not called	—	inferred
`UserConfiguration.SetLockedValue(arg1: number\\|string, arg2: boolean, …)`	—	9 calls, 3 files	`UserConfiguration.SetLockedValue("AutoUnitCycle", 0)`	inferred
`UserConfiguration.SetShowCivicsTreeGovernment(arg1: boolean)`	—	2 calls, 1 files	`UserConfiguration.SetShowCivicsTreeGovernment(true)`	inferred
`UserConfiguration.SetShowCivicsTreeKey(arg1: boolean)`	—	2 calls, 1 files	`UserConfiguration.SetShowCivicsTreeKey(true)`	inferred
`UserConfiguration.SetShowTechTreeKey(arg1: boolean)`	—	2 calls, 1 files	`UserConfiguration.SetShowTechTreeKey(true)`	inferred
`UserConfiguration.SetTechTreeFilterIndex()`	—	not called	—	inferred
`UserConfiguration.SetTechTreeSearchString(…)`	—	not called	—	inferred
`UserConfiguration.SetValue(arg1: number\\|string, arg2, …)`	—	15 calls, 1 files	`UserConfiguration.SetValue("EdgePan", Options.GetUserOption("Gameplay", "EdgePan"))`	inferred
`UserConfiguration.ShowMapGrid([arg1], …) -> boolean`	boolean	4 calls, 2 files	`UI.ToggleGrid(UserConfiguration.ShowMapGrid()`	inferred
`UserConfiguration.ShowMapLabelsDeserts(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsLakes(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsMountainRanges(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsNationalParks(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsNaturalWonders(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsOceans(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsRivers(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsSeas(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapLabelsVolcanoes(…) -> boolean`	boolean	not called	—	inferred
`UserConfiguration.ShowMapResources([arg1: boolean], …) -> boolean`	boolean	12 calls, 5 files	`UserConfiguration.ShowMapResources(true)`	inferred
`UserConfiguration.ShowMapYield([arg1: boolean], …) -> boolean`	boolean	10 calls, 4 files	`if UserConfiguration.ShowMapYield()`	inferred
`UserConfiguration.TutorialLevel([arg1], …) -> number`	number	11 calls, 6 files	`UserConfiguration.TutorialLevel(m_tutorialLevel)`	inferred
`UserConfiguration.UnitConfirmationLevel(…) -> number`	number	not called	—	inferred