game_windows¶

Source: base/tealdef/gui/main/game_windows.d.tl

Notes

Parameter types of some in-game windows and tools, notably the context help window and the construction tool.

UILoansWindowParam¶

record global base/tealdef/gui/main/game_windows.d.tl:3

global record UILoansWindowParam

No description in the game files yet.

Functions

onClose() base/tealdef/gui/main/game_windows.d.tl:4

No description in the game files yet.

UIMarketingWindowParam¶

record global base/tealdef/gui/main/game_windows.d.tl:7

global record UIMarketingWindowParam

No description in the game files yet.

Fields

Name	Type	Description
`townEntityId`	`Engine.Entity`

Functions

onClose() base/tealdef/gui/main/game_windows.d.tl:8

No description in the game files yet.

ContextHelperWindowParam¶

record global base/tealdef/gui/main/game_windows.d.tl:12

global record ContextHelperWindowParam

Notes

Parameters of the context help window (gui/context_helper/context_helper_react.tl), which the game bar opens as a singleton window.

Fields

Name	Type	Description
`gameCtx`	`GameContext`	The in-game GUI context.
`startWithWelcome`	`boolean`

Functions

onClose() base/tealdef/gui/main/game_windows.d.tl:13

Notes

Called when the window is closed.

ConstructionToolParam¶

record global base/tealdef/gui/main/game_windows.d.tl:18

global record ConstructionToolParam is ToolReactUtil.IToolParam

Notes

Tool parameters of the construction menu tool (construction.ConstructionTool in gui/construction/construction.tl).

Details

gui/main/game.tl sets most flags from the game mode: map editor only (hasHeightMapGenerator, hasTownGenerator, hasIndustryGenerator), map editor except on consoles (hasHeightMapImporter, hasHeightMapExporter), map editor or sandbox (hasHeightMapTextureTool).

Fields

Name	Type	Description
`terrainToolData`	`TerrainToolData`	Terrain tool size limits.
`hasHeightMapGenerator`	`boolean`	Whether height map generator tools are available (map editor).
`hasHeightMapImporter`	`boolean`	Whether a height map can be imported (map editor, not on consoles).
`hasHeightMapExporter`	`boolean`	Whether the height map can be exported (map editor, not on consoles).
`hasHeightMapTextureTool`	`boolean`	Whether the terrain height map texture tools are available (map editor and sandbox mode).
`hasTownGenerator`	`boolean`	Whether the town generator is available (map editor).
`hasIndustryGenerator`	`boolean`	Whether the industry generator is available (map editor).
`bulldozerHudIconFilter`	`{Engine.ComponentType}`	Component types whose HUD icons are shown while the bulldozer category is active. Must not change at runtime.
`tabKey`	`string`	Id of the construction menu category (tab) the tool was pushed for; returned as the tool's active variant.
`popDueToPushRef`	`ReactRefT<boolean>`	Set to `true` by the construction menu while it switches tabs by pushing a new tool, so that `onPop` is not called for the replaced one.

Functions

onBack() base/tealdef/gui/main/game_windows.d.tl:35

No description in the game files yet.

onPop() base/tealdef/gui/main/game_windows.d.tl:38

Notes

Called when the tool is popped, except when it is popped because the menu switches to another tab.

ConstructionToolParam.TerrainToolData¶

record base/tealdef/gui/main/game_windows.d.tl:19

record TerrainToolData

Notes

Size limits of the terrain tools, taken from the base config.

Used in the base game: 5 times in 2 files

base/content/gui/gui/construction/construction_react_util.tl:401

construction_react_util.getAllCompanyDefinitions = function(terrainToolData : ConstructionToolParam.TerrainToolData) : { ConstructionDefinition }

base/content/gui/gui/main/game.tl:103

local terrainToolDataRef = react.useRefLazy(function() : ConstructionToolParam.TerrainToolData

Fields

Name	Type	Description
`minSize`	`number`	Minimum brush size, from `baseConfig.terrainPainterMinSize`.
`maxSize`	`number`	Maximum brush size, from `baseConfig.terrainToolMaxSizeEditor` in the map editor and `baseConfig.terrainToolMaxSize` otherwise.
`scale`	`number`	Terrain tool scale, from `baseConfig.terrainToolScale`.

ConstructionToolWindowParam¶

record global base/tealdef/gui/main/game_windows.d.tl:41

global record ConstructionToolWindowParam is ToolReactUtil.IToolWindowParam<ConstructionToolParam>

Notes

Parameters of the construction menu window (ConstructionListWindow). The payload carries the ConstructionToolParam.