town_eow¶

Source: base/tealdef/gui/entity_window/town/town_eow.d.tl

Notes

Plugin types and charts of the town window (town_eow.script.tl).

TownEow¶

record global base/tealdef/gui/entity_window/town/town_eow.d.tl:3

global record TownEow

Load: local town_eow = ug_require "/gui/entity_window/town/town_eow.script.tl"

Notes

Plugin types and charts of the town window.

Fields

Name	Type	Description
`TownCharts`	`Recipe<TownChartsParam>`	Chart of a town's logbook for one information tab, e.g. residential, commercial and industrial counts on "Overview"; can be selected and inspected with the gamepad. used 1× in the base game
`TownEowExtensionPoint`	`ExtensionPoint<TownWidgetPluginParams>`	Extension point of the town window's main tab; register plugins with a resource of type `"react-plugin ::TownEowExtensionPoint"`. used 1× in the base game
`TownEowEditorExtensionPoint`	`ExtensionPoint<TownWidgetPluginParams>`	Extension point of the town window's editor tab; the tab is only shown if at least one plugin is active. Register plugins with a resource of type `"react-plugin ::TownEowEditorExtensionPoint"`. used 1× in the base game
`NotificationPlugin`	`Recipe<TownWidgetPluginParams>`	Notification cards of the town; registered with order 0.
`TownLevelPlugin`	`Recipe<TownWidgetPluginParams>`	Card with town level, population, progress towards the next level and growth state, with the population widget as collapsible part; registered with order 10.
`TownChartsPlugin`	`Recipe<TownWidgetPluginParams>`	"District Sizes" chart card; registered with order 40 and condition `conditionTownCharts`.
`MapEditorTownSuppliesPlugin`	`Recipe<TownWidgetPluginParams>`	"Supplies" card with the editable town supplies in the map editor; registered with order 50 and condition `isMapEditor`.
`TownDebugGraphPlugin`	`Recipe<TownWidgetPluginParams>`	"Debug Graph" card with charts of all town rating logs; registered with order 70, but disabled by `conditionTownDebugGraph`.
`TownEditorCargoDemandPlugin`	`Recipe<TownWidgetPluginParams>`	"Cargo Demand" editor card; registered on the editor extension point with order 10 and condition `isSandboxMode`.
`TownEditorInitialCapacityPlugin`	`Recipe<TownWidgetPluginParams>`	"Target District Capacities" editor card; registered on the editor extension point with order 20 and condition `isSandboxMode`.
`TownEditorDistributionWeightsPlugin`	`Recipe<TownWidgetPluginParams>`	"District Tool" editor card; registered on the editor extension point with order 30 and condition `isSandboxMode`.
`TownEditorRatingsSensitivityPlugin`	`Recipe<TownWidgetPluginParams>`	"Ratings Sensitivity" editor card; registered on the editor extension point with order 40 and condition `isSandboxMode`.

Functions

conditionTownCharts(params : TownEow.TownWidgetPluginParams) : boolean base/tealdef/gui/entity_window/town/town_eow.d.tl:35

Call as town_eow.conditionTownCharts

Notes

Plugin condition; true if the district sizes are visible and the window is not in the map editor.

Returns boolean

isMapEditor(params : TownEow.TownWidgetPluginParams) : boolean base/tealdef/gui/entity_window/town/town_eow.d.tl:38

Call as town_eow.isMapEditor

Notes

Plugin condition; true in the map editor.

Returns boolean

conditionTownDebugGraph(params : TownEow.TownWidgetPluginParams) : boolean base/tealdef/gui/entity_window/town/town_eow.d.tl:41

Call as town_eow.conditionTownDebugGraph

Notes

Plugin condition of the debug graph; always returns false in the base game.

Returns boolean

isSandboxMode(params : TownEow.TownWidgetPluginParams) : boolean base/tealdef/gui/entity_window/town/town_eow.d.tl:44

Call as town_eow.isSandboxMode

Notes

Plugin condition; true in sandbox mode.

Returns boolean

TownEow.TownEowState¶

record base/tealdef/gui/entity_window/town/town_eow.d.tl:4

record TownEowState

Notes

State of the town window passed to the plugins.

Fields

Name	Type	Description
`isSandboxMode`	`boolean`	True in sandbox mode; enables the editor plugins.
`isMapEditor`	`boolean`	True in the map editor.
`districtSizesVisible`	`boolean`	Whether the town information widget currently shows the district sizes chart.

TownEow.TownWidgetPluginParams¶

record base/tealdef/gui/entity_window/town/town_eow.d.tl:10

record TownWidgetPluginParams is EowExtensionUtil.IEowWidgetsExtensionParams

Notes

Parameters passed to the plugins of the town window.

Used in the base game: 14 times in 2 files

base/content/gui/gui/entity_window/town/town.tl:1204

local extensionParams : TownEow.TownWidgetPluginParams = {

base/content/gui/gui/entity_window/town/town_eow.script.tl:116

town_eow.NotificationPlugin = react.RegisterPluginRecipe(town_eow.TownEowExtensionPoint, "NotificationPlugin", function(params : TownEow.TownWidgetPluginParams)

Fields

Name	Type	Description
`state`	`TownEowState`	Window state.

TownEow.TownEditorWidgetPluginParams¶

record base/tealdef/gui/entity_window/town/town_eow.d.tl:13

record TownEditorWidgetPluginParams is EowExtensionUtil.IEowWidgetsExtensionParams

Notes

Parameters for the plugins of the town editor tab.

Fields

Name	Type	Description
`state`	`TownEowState`	Window state.

TownEow.TownChartsParam¶

record base/tealdef/gui/entity_window/town/town_eow.d.tl:19

record TownChartsParam

Notes

Parameters of TownEow.TownCharts.

Used in the base game: 1 time in 1 file

base/content/gui/gui/entity_window/town/town_eow.script.tl:151

town_eow.TownCharts = react.RegisterRecipe("TownCharts", function(params : TownEow.TownChartsParam) : TreeNodeId

Fields

Name	Type	Description
`entityId`	`Engine.Entity`	Town entity.
`tabType`	`TownReactUtil.TownInfoTabType`	Town information tab whose chart is shown (e.g. `"Overview"` for district sizes, `"Reputation"`, `"Supplies"`, `"Traffic"`, `"Happiness"`).
`chartStepTimer`	`boolean`
`styleClass`	`string`	Style class of the chart.
`showTimeScaleSlider`	`boolean`	Shows the time scale slider (not used for every tab).
`legendOrientation`	`Builtin.Type.Orientation`	Orientation of the chart widget's layout.