Skip to content

layer_pollution

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

Notes

The "Pollution" map layer (button menu.layers.pollutionButton).

LayerPollution

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

global record LayerPollution

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

Notes

The "Pollution" layer, which shows pollution emission, the averaged pollution map, wind and town areas.

Fields

Name Type Description
Legend Recipe0 Recipe of the layer legend. used 1× in the base game
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; default icons for vehicles, notifications and the pollution rating for towns. used 1× in the base game

Functions

getConfig() : LayerConfig base/tealdef/gui/layers/layer_pollution.d.tl:4

Call as layer_pollution.getConfig

Notes

Builds the layer config; the pollution cleanup facility also uses it.

Returns LayerConfig: A new LayerConfig.

Used in the base game: 2 times in 2 files

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

layerConfig = layer_pollution.getConfig()
base/content/game_mechanics/game_mechanics/emission/pollution_cleanup_facility_layer.script.tl:5
return layerPollution.getConfig()

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

Call as layer_pollution.getHudIconPreFilter

Notes

Component types that get HUD icons in this layer.

Returns {Engine.ComponentType}: TRANSPORT_VEHICLE and TOWN.

Used in the base game: 1 time in 1 file

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

filter = layer_pollution.getHudIconPreFilter()