layers_button_ridge

Quelle: base/tealdef/gui/layers/layers_button_ridge.d.tl

Hinweise

Der Layer-Button und seine aufklappbare Leiste mit Layer-Buttons (Gelände, Städte, Verkehr, Flüsse, Lärm, Verschmutzung, HUD-Filter) sowie die Parametertypen, die alle Layer-Fenster gemeinsam nutzen.

LayersButtonRidge

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

global record LayersButtonRidge

Hinweise

Der Layer-Button mit seiner Leiste aus Layer-Buttons und die Typen, die die Layer-Fenster gemeinsam nutzen.

Felder

Name	Typ	Beschreibung
ExpandableLayerButton	Recipe<LayerButtonsParam>	Recipe des Layer-Buttons, der sich zur Leiste mit den Layer-Buttons aufklappt.

LayersButtonRidge.LayersMode

enum base/tealdef/gui/layers/layers_button_ridge.d.tl:4

enum LayersMode

Hinweise

Wie ein Layer aus der Leiste geöffnet wird.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/layers/layers_button_ridge.tl:163

mode : LayersButtonRidge.LayersMode

Wert	Beschreibung
"StandaloneTool"	Der Layer kommt als Werkzeug auf den Werkzeug-Stack.
"ConstructionMenuAssist"	Das Layer-Fenster öffnet sich, ohne ein Werkzeug auf den Stack zu legen. So läuft es, während das Baumenü aktiv ist.

LayersButtonRidge.LayerButtonsParam

record base/tealdef/gui/layers/layers_button_ridge.d.tl:8

record LayerButtonsParam

Hinweise

Parameter von ExpandableLayerButton.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/layers/layers_button_ridge.tl:304

local ExpandableLayerButton = react.RegisterRecipe("ExpandableLayerButton", function(param : LayersButtonRidge.LayerButtonsParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
layersEnabled	{ButtonKey : boolean}	Welche Layer-Buttons erscheinen. Im Karten-Editor schaltet das Basisspiel nur Terrain, Civilization und HUDFilter ein.
gameCtx	GameContext	GUI-Kontext des Spiels.

LayersButtonRidge.LayerButtonsParam.ButtonKey

enum base/tealdef/gui/layers/layers_button_ridge.d.tl:9

enum ButtonKey

Hinweise

Schlüssel der Layer-Buttons in der Leiste.

Wert	Beschreibung
"Terrain"	Gelände-Layer.
"Civilization"	Städte-Layer.
"Infrastructure"	Infrastruktur-Layer.
"Traffic"	Verkehrs-Layer (LayerTraffic).
"Satisfaction"	Layer Passagierzufriedenheit (LayerPublicTransport).
"DeliveryOnTime"	Layer Güterzufriedenheit (LayerCargo).
"PassengerFlow"	Passagierfluss-Layer.
"CargoFlow"	Güterfluss-Layer (LayerCargoFlow).
"Noise"	Lärm-Layer (LayerNoise).
"Pollution"	Verschmutzungs-Layer (LayerPollution).
"HUDFilter"	Fenster HUD-Filter (HUDFilter).

LayersButtonRidge.LayerContentParam

record base/tealdef/gui/layers/layers_button_ridge.d.tl:27

record LayerContentParam is ToolReactUtil.ToolWindowParamPayload<LayerToolParam>

Hinweise

Parameter jedes Recipes für Layer-Inhalte (das Feld Layer der Layer-Module). Er trägt den LayerToolParam als toolParam.

Im Basisspiel verwendet: 27-mal in 12 Dateien

base/content/gui/gui/layers/layer_cargo.tl:265

local CargoLayerWindowContent = react.RegisterRecipe("CargoLayerWindowContent", function(param : LayersButtonRidge.LayerContentParam) : TreeNodeId

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

local CargoLayerWindowContent = react.RegisterRecipe("CargoLayerWindowContent", function(param : LayersButtonRidge.LayerContentParam) : TreeNodeId

base/content/gui/gui/layers/layer_civilization.tl:76

local TownsLayerWindowContent = react.RegisterRecipe("TownsLayerWindowContent", function(param : LayersButtonRidge.LayerContentParam) : TreeNodeId

base/content/gui/gui/layers/layer_hud_filter.tl:10

local HUDFilterWindowContent = react.RegisterRecipe("HUDFilterWindowContent", function(param : LayersButtonRidge.LayerContentParam) : TreeNodeId

base/content/gui/gui/layers/layer_infrastructure.tl:150

local SpeedLayerWindowContent = react.RegisterRecipe("SpeedLayerWindowContent", function(param : LayersButtonRidge.LayerContentParam) : TreeNodeId

base/content/gui/gui/layers/layer_noise.tl:166

local NoiseLayerWindowContent = react.RegisterRecipe("NoiseLayerWindowContent", function(param : LayersButtonRidge.LayerContentParam) : TreeNodeId

… und 6 weitere Dateien.

Felder

Name	Typ	Beschreibung
meta	Meta	Metadaten des Knotens. Die Layer-Recipes setzen darin einen Tag wie menu.layers.noise.

LayersButtonRidge.LayerToolParam

record base/tealdef/gui/layers/layers_button_ridge.d.tl:31

record LayerToolParam is ToolReactUtil.IToolParam

Hinweise

Werkzeugparameter eines offenen Layer-Fensters. Die Leiste erzeugt ihn für den gewählten Button.

Im Basisspiel verwendet: 6-mal in 1 Datei

base/content/gui/gui/layers/layers_button_ridge.tl:22

local record LayerToolWindowParam is ToolReactUtil.IToolWindowParam<LayersButtonRidge.LayerToolParam>

Felder

Name	Typ	Beschreibung
data	Data	Fenstertitel, Style-Klasse und Inhalts-Recipe des Layers.

Funktionen

onBack() base/tealdef/gui/layers/layers_button_ridge.d.tl:40

Hinweise

Wird beim Verlassen des Layers aufgerufen. Gibt nur dann an onBack der Leiste weiter, wenn der Layer gestapelt geöffnet wurde.

switchToPrevious() base/tealdef/gui/layers/layers_button_ridge.d.tl:41

Hinweise

Wechselt zum vorherigen Layer der Leiste (in den Layer-Fenstern für IA_NAV_UP).

switchToNext() base/tealdef/gui/layers/layers_button_ridge.d.tl:42

Hinweise

Wechselt zum nächsten Layer der Leiste (in den Layer-Fenstern für IA_NAV_DOWN).

reduce() base/tealdef/gui/layers/layers_button_ridge.d.tl:43

Hinweise

Schließt den Layer (ruft onBack auf und nimmt das Layer-Werkzeug vom Stack). Im Gamepad-Modus schließt es auch die Leiste.

onMount(ReactRefWrap) base/tealdef/gui/layers/layers_button_ridge.d.tl:44

Hinweise

Layer-Fenster rufen die Funktion beim Einhängen mit ihrer eigenen Knotenreferenz auf.

LayersButtonRidge.LayerToolParam.Data

record base/tealdef/gui/layers/layers_button_ridge.d.tl:32

record Data

Hinweise

Was das Layer-Fenster zeigt.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/layers/layers_button_ridge.tl:159

layerData : LayersButtonRidge.LayerToolParam.Data

Felder

Name	Typ	Beschreibung
title	string	Fenstertitel.
class	string	Style-Klasse, die das Fenster bekommt.
content	Recipe<LayerContentParam>	Recipe des Fensterinhalts, etwa LayerNoise.Layer.
gameCtx	GameContext	GUI-Kontext des Spiels.

LayersButtonRidge.HudIconUserParam

interface base/tealdef/gui/layers/layers_button_ridge.d.tl:47

interface HudIconUserParam is HudIconToolbox.HudIconMasterUserParam

Hinweise

Benutzerparameter der HUD-Icon-Master-Recipes der Layer, gleich HudIconToolbox.HudIconMasterUserParam (die Layer füllen accessNotificationCacheFn).

Im Basisspiel verwendet: 5-mal in 5 Dateien

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

local layerHudIconUserParam : LayersButtonRidge.HudIconUserParam = {

base/content/gui/gui/layers/layer_noise.tl:47

layer_noise.HudIconMaster = react.RegisterRecipe("LayerNoiseHudIconMaster", function(params : Builtin.HudIconParam, userParam : LayersButtonRidge.HudIconUserPar

base/content/gui/gui/layers/layer_pollution.tl:32

layer_pollution.HudIconMaster = react.RegisterRecipe("LayerPollutionHudIconMaster", function(params : Builtin.HudIconParam, userParam : LayersButtonRidge.HudIco

base/content/gui/gui/layers/layer_public_transport.tl:71

layer_public_transport.HudIconMaster = react.RegisterRecipe("LayerPublicTransportHudIconMaster", function(params : Builtin.HudIconParam, userParam : LayersButto

base/content/gui/gui/layers/layer_traffic.tl:49

layer_traffic.HudIconMaster = react.RegisterRecipe("LayerTrafficHudIconMaster", function(params : Builtin.HudIconParam, userParam : LayersButtonRidge.HudIconUse

LayersButtonRidge.OpenLayerRidgeEventParams

record base/tealdef/gui/layers/layers_button_ridge.d.tl:49

record OpenLayerRidgeEventParams

Hinweise

Nutzlast des Ereignisses openLayerRidge. Es klappt die Layer-Leiste auf und öffnet auf Wunsch einen Layer.

Beispiel

-- from game_mechanics/towns/town_util.tl
onClickEvent = {"openLayerRidge", { layer = "menu.layers.trafficButton", stack = true }},

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/layers/layers_button_ridge.tl:497

local params = eventParam as LayersButtonRidge.OpenLayerRidgeEventParams

Felder

Name	Typ	Beschreibung
layer	string	Button-ID des zu öffnenden Layers, etwa "menu.layers.noiseButton".
stack	boolean	Bei wahr kommt das Layer-Werkzeug oben auf das aktuelle Werkzeug, statt es zu ersetzen.

LayersButtonRidge.PreferredLayerConfigEvent

record base/tealdef/gui/layers/layers_button_ridge.d.tl:54

record PreferredLayerConfigEvent

Hinweise

Nutzlast des Ereignisses preferredLayerConfig, das Layer-Fenster beim Öffnen auslösen (beim Schließen mit nil). Die Bauwerkzeuge verwenden diese Konfiguration statt ihrer eigenen.

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/gui/gui/construction/construction.tl:4436

local eventParam = param as LayersButtonRidge.PreferredLayerConfigEvent

base/content/gui/gui/construction/construction_react_util.tl:1372

local eventParam = param as LayersButtonRidge.PreferredLayerConfigEvent

base/content/gui/gui/main/game.tl:131

local eventParam = param as LayersButtonRidge.PreferredLayerConfigEvent

Felder

Name	Typ	Beschreibung
config	LayerConfig	Layer-Konfiguration des offenen Layers.