cargofilter_window¶

Source: base/tealdef/gui/line_vehicle_mgmt/cargofilter_window.d.tl

Notes

The per-stop cargo filter popover of the line manager (/gui/line_vehicle_mgmt/cargofilter_window.tl, which returns the window recipe directly).

CargoFilterUtil¶

record global base/tealdef/gui/line_vehicle_mgmt/cargofilter_window.d.tl:4

global record CargoFilterUtil

Load: local CargoFilterWindow = ug_require "/gui/line_vehicle_mgmt/cargofilter_window.tl"

Notes

Per-stop cargo filter popover of the line manager (CargoFilterWindow).

Fields

Name	Type	Description
`CargoFilterWindow`	`Recipe<CargoFilterParams>`	Window recipe of the cargo filter popover, opened by the line manager as a singleton window.

CargoFilterUtil.CargoFilterParams¶

record base/tealdef/gui/line_vehicle_mgmt/cargofilter_window.d.tl:5

record CargoFilterParams

Notes

Parameters of the cargo filter popover for one stop of a line.

Details

The popover edits the stop's stopConfig (cargo to load, max. fill level, force unload, destroy-cargo options), its load mode and its min./max./additional waiting times, and applies them with api.cmd.makeLineUpdateCmd (setting customFilters = true on the line).

Used in the base game: 4 times in 2 files

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:5

local CargoFilterWindow = ug_require "/gui/line_vehicle_mgmt/cargofilter_window.tl" as Recipe<CargoFilterUtil.CargoFilterParams>

base/content/gui/gui/line_vehicle_mgmt/cargofilter_window.tl:277

local CargoFilterContent = react.RegisterRecipe("CargoFilterContent", function(params : CargoFilterUtil.CargoFilterParams) : TreeNodeId

Fields

Name	Type	Description
`lineEntity`	`Engine.Entity`	Line whose stop is configured.
`stopNumber`	`integer`	Stop number shown in the window title (`#<number> - <station group name>`).
`pos`	`Vec2f`	Initial window position (`initialX`/`initialY` of the window).
`stopIndex`	`integer`	zero-based
`gameCtx`	`GameContext`	Game context; its renderer component is used to bind `action`.

Functions

onClose() base/tealdef/gui/line_vehicle_mgmt/cargofilter_window.d.tl:10

Notes

Called when the popover is closed.

action() : TreeNodeId base/tealdef/gui/line_vehicle_mgmt/cargofilter_window.d.tl:13

Notes

Optional renderer action bound to the popover content while it is mounted.

Returns TreeNodeId