Home › Engine Lua tables › UILens

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.

UILens

Static table with 28 methods. registered by exe interface GameCore::App::UI::Lua::ILenses; game scripts call 27 of 28 methods. Registering function 0x19a100.

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

Method	Returns	In game scripts	Example	Status
`UILens.ClearHex(arg1, plot: integer, …)`	—	5 calls, 2 files	`UILens.ClearHex(m_PurchasePlot, g_growthPlotId)`	inferred
`UILens.ClearHexes(arg1, arg2, …)`	—	1 calls, 1 files	`UILens.ClearHexes(m_YieldIcons, m_PlotYieldsChanged)`	inferred
`UILens.ClearLayerHexes(arg1, …)`	—	73 calls, 15 files	`UILens.ClearLayerHexes( g_Numbers )`	inferred
`UILens.ClearPressureWaves(arg1, …)`	—	2 calls, 1 files	`UILens.ClearPressureWaves(m_CulturalIdentityLens)`	inferred
`UILens.CreateLensLayerHash(arg1: string) -> number`	number	114 calls, 26 files	`local mapHexMask : number = UILens.CreateLensLayerHash("Map_Hex_Mask")`	inferred
`UILens.CreatePressureWaves(arg1: number, arg2: table, …)`	—	2 calls, 1 files	`UILens.CreatePressureWaves(m_CulturalIdentityLens, waves)`	inferred
`UILens.FocusCity(arg1, arg2, …)`	—	3 calls, 1 files	`UILens.FocusCity(m_HexColoringReligion, pCity)`	inferred
`UILens.FocusHex(arg1, arg2: integer, [arg3: string], …)`	—	3 calls, 2 files	`UILens.FocusHex(g_AttackRange, plotID)`	inferred
`UILens.GetOverlay(arg1: integer) -> 1 value`	1 value	99 calls, 13 files	`local pOverlay:object = UILens.GetOverlay("MapSearch")`	inferred
`UILens.HideOverlays(arg1: string)`	—	2 calls, 2 files	`UILens.HideOverlays("MapSearch")`	inferred
`UILens.IsLayerOn(arg1, …) -> boolean`	boolean	39 calls, 10 files	`if UILens.IsLayerOn(m_HexColoringWaterAvail)`	inferred
`UILens.IsLayerTogglable(…) -> boolean`	boolean	not called	—	inferred
`UILens.IsLensActive(arg1: string) -> boolean`	boolean	22 calls, 9 files	`if UILens.IsLensActive(m_TradeRoute)`	inferred
`UILens.IsPlayerLensSetToActive() -> boolean`	boolean	1 calls, 1 files	`if(UILens.IsPlayerLensSetToActive()`	inferred
`UILens.RestoreActiveLens()`	—	6 calls, 5 files	`UILens.RestoreActiveLens()`	inferred
`UILens.SaveActiveLens()`	—	5 calls, 5 files	`UILens.SaveActiveLens()`	inferred
`UILens.SetActive(arg1: string, …)`	—	74 calls, 23 files	`UILens.SetActive("Appeal")`	inferred
`UILens.SetAdjacencyBonusDistict(arg1: integer, arg2, arg3: table, …)`	—	4 calls, 2 files	`UILens.SetAdjacencyBonusDistict( plotInfo.index, plotInfo.hexArtdef, plotInfo.adjacent )`	inferred
`UILens.SetDesaturation(arg1: number)`	—	11 calls, 3 files	`UILens.SetDesaturation(1.0)`	inferred
`UILens.SetLayerGrowthHex(arg1, arg2: integer, arg3: integer, arg4: integer, arg5: string, …)`	—	6 calls, 2 files	`UILens.SetLayerGrowthHex(m_PurchasePlot, Game.GetLocalPlayer(), g_growthPlotId, 1, "GrowthHexBG")`	inferred
`UILens.SetLayerHexesArea(arg1, arg2: integer, arg3: table, [arg4], [arg5: table], …)`	—	43 calls, 8 files	`UILens.SetLayerHexesArea( mapHexMask, Game.GetLocalPlayer(), kHexIndexes )`	inferred
`UILens.SetLayerHexesColoredArea(arg1, localPlayer: integer, arg3: table, arg4: integer, [arg5: string], …)`	—	25 calls, 3 files	`UILens.SetLayerHexesColoredArea( m_HexColoringOwningCiv, localPlayer, plots, primaryColor )`	inferred
`UILens.SetLayerHexesPath(arg1, arg2: integer, arg3, arg4: table, [arg5: integer], …)`	—	5 calls, 2 files	`UILens.SetLayerHexesPath(g_MovementPath, eLocalPlayer, pPathSegment, { })`	inferred
`UILens.ShowOverlays(arg1: string)`	—	2 calls, 2 files	`UILens.ShowOverlays("MapSearch")`	inferred
`UILens.ToggleLayerOff(arg1: string, …)`	—	45 calls, 13 files	`UILens.ToggleLayerOff( m_PurchasePlot )`	inferred
`UILens.ToggleLayerOn(arg1, …)`	—	39 calls, 9 files	`UILens.ToggleLayerOn( m_YieldIcons )`	inferred
`UILens.UnFocusCity(arg1, arg2, …)`	—	3 calls, 1 files	`UILens.UnFocusCity(m_HexColoringReligion, pCity)`	inferred
`UILens.UnFocusHex(arg1, arg2: integer, [arg3: string], …)`	—	9 calls, 2 files	`UILens.UnFocusHex(g_AttackRange, 0)`	inferred