Home › Engine Lua tables › Options

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.

Options

Static table with 21 methods. named from how the game scripts call it (21 of 21 methods matched). Registering function 0x4d3c70.

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

Method	Returns	In game scripts	Example	Status
`Options.ApplyGraphicsOptions() -> boolean`	boolean	1 calls, 1 files	`local bSuccess = Options.ApplyGraphicsOptions()`	inferred
`Options.GetAppOption(arg1: string, arg2: string, …)`	—	43 calls, 10 files	`local adapter_index = Options.GetAppOption("Video", "DeviceID")`	inferred
`Options.GetAudioOption(arg1: string, arg2: string, …)`	—	14 calls, 2 files	`value = Options.GetAudioOption("Sound", "SFX Volume")`	inferred
`Options.GetAvailableDisplayAdapters(…) -> table`	table	1 calls, 1 files	`local adapters = Options.GetAvailableDisplayAdapters()`	inferred
`Options.GetAvailableDisplayModes() -> table, table, number, number, number`	table, table, number, number, number	1 calls, 1 files	`local modes = Options.GetAvailableDisplayModes()`	inferred
`Options.GetDisplayHeight()`	—	2 calls, 1 files	`local display_height = Options.GetDisplayHeight()`	inferred
`Options.GetDisplayWidth()`	—	2 calls, 1 files	`local display_width = Options.GetDisplayWidth()`	inferred
`Options.GetGraphicsDefault(arg1: string, arg2: string, …)`	—	2 calls, 1 files	—	inferred
`Options.GetGraphicsOption(arg1: string, arg2: string, …)`	—	40 calls, 1 files	`value = Options.GetGraphicsOption("General", "MinimapSize")`	inferred
`Options.GetUserOption(arg1: string, arg2: string, …)`	—	76 calls, 16 files	`value = Options.GetUserOption("Interface", "ChatTextValue")`	inferred
`Options.IsAppInMainMenuState() -> number`	number	1 calls, 1 files	`local is_in_game = Options.IsAppInMainMenuState()`	inferred
`Options.IsMultiNodeGPU() -> number`	number	1 calls, 1 files	`Controls.MultiGPUCheckbox:SetDisabled( Options.IsMultiNodeGPU()`	inferred
`Options.IsUIUpscaleAllowed([arg1]) -> boolean`	boolean	3 calls, 1 files	`if (Options.IsUIUpscaleAllowed(v[2] + 1.0)`	inferred
`Options.ResetOptions()`	—	1 calls, 1 files	`Options.ResetOptions()`	inferred
`Options.RevertOptions([arg1])`	—	1 calls, 1 files	`Options.RevertOptions()`	inferred
`Options.RevertResolutionChanges()`	—	1 calls, 1 files	`Options.RevertResolutionChanges()`	inferred
`Options.SaveOptions([arg1])`	—	21 calls, 11 files	`Options.SaveOptions()`	inferred
`Options.SetAppOption(arg1: string, arg2: string, arg3: number, …)`	—	24 calls, 4 files	`Options.SetAppOption("Video", "UIUpscale", option)`	inferred
`Options.SetAudioOption(arg1: string, arg2: string, arg3: integer, arg4: integer, …)`	—	24 calls, 2 files	`Options.SetAudioOption("Sound", "SFX Volume", value, 0)`	inferred
`Options.SetGraphicsOption(arg1: string, arg2: string, arg3: number, [arg4: number], …)`	—	32 calls, 1 files	`Options.SetGraphicsOption("Video", "VSync", option)`	inferred
`Options.SetUserOption(arg1: string, arg2: string, arg3: number, …)`	—	48 calls, 11 files	`Options.SetUserOption("Gameplay", "QuickCombat", option)`	inferred