warehouse_eow¶

Source: base/tealdef/gui/entity_window/warehouse/warehouse_eow.d.tl

Notes

Plugin types of the warehouse window (warehouse_eow.script.tl).

WarehouseEow¶

record global base/tealdef/gui/entity_window/warehouse/warehouse_eow.d.tl:3

global record WarehouseEow

Load: local warehouse_eow = ug_require "/gui/entity_window/warehouse/warehouse_eow.script.tl"

Notes

Plugin types of the warehouse window.

Fields

Name	Type	Description
`WarehouseStocksPlugin`	`Recipe<WarehouseEow.WarehouseWidgetPluginParams>`	"Stocks" card with the stored cargo; when modifiable, a collapsible part with the stocks, discard buttons and cargo type pin buttons; registered with order 20.
`WarehouseDiagramPlugin`	`Recipe<WarehouseEow.WarehouseWidgetPluginParams>`	"Statistics" chart of incoming and outgoing cargo (`itemsUnloaded`, `itemsLoaded`); registered with order 30 and condition `isModifiable`.
`WarehouseEowExtensionPoint`	`ExtensionPoint<WarehouseWidgetPluginParams>`	Extension point of the warehouse window; register plugins with a resource of type `"react-plugin ::WarehouseEowExtensionPoint"`. used 1× in the base game

Functions

isModifiable(WarehouseEow.WarehouseWidgetPluginParams) : boolean base/tealdef/gui/entity_window/warehouse/warehouse_eow.d.tl:15

Call as warehouse_eow.isModifiable

Notes

Plugin condition; true if the warehouse is owned by the player or by nobody.

Returns boolean

Used in the base game: 1 time in 1 file

base/content/gui/gui/entity_window/warehouse/warehouse.tl:66

if warehouse_eow.isModifiable(extensionParams) then

WarehouseEow.WarehouseEowState¶

record base/tealdef/gui/entity_window/warehouse/warehouse_eow.d.tl:4

record WarehouseEowState

Notes

State of the warehouse window passed to the plugins.

Used in the base game: 1 time in 1 file

base/content/gui/gui/entity_window/warehouse/warehouse.tl:36

local makeState = function() : WarehouseEow.WarehouseEowState

Fields

Name	Type	Description
`isModifiable`	`boolean`	True if the warehouse's construction is owned by the player or by nobody.

WarehouseEow.WarehouseWidgetPluginParams¶

record base/tealdef/gui/entity_window/warehouse/warehouse_eow.d.tl:8

record WarehouseWidgetPluginParams is EowExtensionUtil.IEowWidgetsExtensionParams

Notes

Parameters passed to the plugins of the warehouse window.

Used in the base game: 4 times in 2 files

base/content/gui/gui/entity_window/warehouse/warehouse.tl:46

local extensionParams : WarehouseEow.WarehouseWidgetPluginParams = {

base/content/gui/gui/entity_window/warehouse/warehouse_eow.script.tl:106

warehouse_eow.WarehouseStocksPlugin = react.RegisterPluginRecipe(warehouse_eow.WarehouseEowExtensionPoint, "WarehouseStocksPlugin", function(params : WarehouseE

Fields

Name	Type	Description
`state`	`WarehouseEowState`	Window state.