layer_cargo_flow¶

Source: base/tealdef/gui/layers/layer_cargo_flow.d.tl

Notes

The "Cargo Flow" map layer (button menu.layers.cargoFlowButton).

LayerCargoFlow¶

record global base/tealdef/gui/layers/layer_cargo_flow.d.tl:3

global record LayerCargoFlow

Load: local layer_cargo_flow = ug_require "/gui/layers/layer_cargo_flow.tl"

Notes

The "Cargo Flow" layer, which shows where cargo is supplied and demanded.

Fields

Name	Type	Description
`Legend`	`Recipe0`	Recipe of the layer legend.
`Layer`	`Recipe<LayersButtonRidge.LayerContentParam>`	Recipe of the layer window content. used 1× in the base game
`HudIconMaster`	`Recipe2<Builtin.HudIconParam, LayersButtonRidge.HudIconUserParam>`	HUD icon recipe of the layer; shows supply and demand of town districts, industry and warehouse stocks, and vehicle cargo. used 1× in the base game

Functions

getConfig(includePassengers : boolean) : LayerConfig base/tealdef/gui/layers/layer_cargo_flow.d.tl:4

Call as layer_cargo_flow.getConfig

Notes

Builds the layer config.

Parameter	Type	Description
`includePassengers`	`boolean`	Include passengers in the coloring and the cargo edges; the layer window passes `false`.

Returns LayerConfig: A new LayerConfig.

getHudIconPreFilter() : {Engine.ComponentType} base/tealdef/gui/layers/layer_cargo_flow.d.tl:7

Call as layer_cargo_flow.getHudIconPreFilter

Notes

Component types that get HUD icons in this layer.

Returns {Engine.ComponentType}: TRANSPORT_VEHICLE, TOWN, INDUSTRY and WAREHOUSE.

LayerCargoFlow.HudIconUserParam¶

record base/tealdef/gui/layers/layer_cargo_flow.d.tl:10

record HudIconUserParam is LayersButtonRidge.HudIconUserParam

Notes

User parameter of LayerCargoFlow.HudIconMaster.

Used in the base game: 2 times in 2 files

base/content/gui/gui/layers/layer_cargo_flow.tl:50

layer_cargo_flow.HudIconMaster = react.RegisterRecipe("LayerCargoFlowHudIconMaster", function(param : Builtin.HudIconParam, userParam : LayerCargoFlow.HudIconUs

base/content/gui/gui/entity_window/entity_window_hud.tl:564

local layerCargoFlowHudIconUserParam : LayerCargoFlow.HudIconUserParam = {

Fields

Name	Type	Description
`includePassengers`	`boolean`	For town districts, include passenger demand from residential line usage.
`districtsDemandsShowPercentage`	`boolean`	Show district demands as percentages.