construction_desc_react_util¶

Quelle: base/tealdef/gui/construction/construction_desc_react_util.d.tl

Hinweise

Hilfsmodul für den Infobereich der Einträge im Baumenü (::/gui/construction/construction_desc_react_util.tl). Es sammelt die Kennzahlen (Kosten, Unterhalt, Emissionen, Effekte, Genehmigungen) aus einer Definition und ihren Metadaten, formatiert sie für die Anzeige und enthält die Standardkonfigurationen der HUD-Icons, die configureHudIconsScript-Skripte verwenden.

ConstructionDescReactUtil¶

record global base/tealdef/gui/construction/construction_desc_react_util.d.tl:3

global record ConstructionDescReactUtil

Laden: local construction_desc_react_util = ug_require "::/gui/construction/construction_desc_react_util.tl" as ConstructionDescReactUtil

Hinweise

Hilfsmodul für den Infobereich der Einträge im Baumenü. Lade es mit ug_require "::/gui/construction/construction_desc_react_util.tl".

Felder

Name	Typ	Beschreibung
`ConstructionInfoNumberList`	`Recipe<ConstructionInfoNumberListParam>`	Recipe, das eine Zeile formatierter Zahlen zeigt (Icon und Text pro Element). 2-mal im Basisspiel verwendet

Funktionen

getAttributesFromConstructionResult(updateFnResult1 : ConstructionResult) : {string : {number, number, {string}}} base/tealdef/gui/construction/construction_desc_react_util.d.tl:65

Aufruf: construction_desc_react_util.getAttributesFromConstructionResult(…)

Hinweise

Zieht die Attribute für den Infobereich aus dem Ergebnis der Update-Funktion einer Konstruktion.

Rückgabe {string : {number, number, {string}}}: Attribute nach Schlüssel (cost, maintenanceCost, noise, pollution, radius, pollutionRadius, capacityPassenger, comfortFactor, maintenanceCapacity, ...), jeweils {min, max} mit max = -1 für einen Einzelwert.

Details

Die Unterhaltskosten werden mit infrastructureMaintenanceScale aus der Basiskonfiguration skaliert.

cache may be nil. Is only required for getting the number available permits.

collectNumbers(metadata : ConstructionDescMetadata, definition : ConstructionDefinition, cache : ConstructionReactUtil.ItemDisableCache, attributes : {string : {number, number, {string}}}) : Numbers base/tealdef/gui/construction/construction_desc_react_util.d.tl:68

Aufruf: construction_desc_react_util.collectNumbers(…)

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Rückgabe Numbers

Im Basisspiel verwendet: 3-mal in 2 Dateien

base/content/game_mechanics/game_mechanics/company/company_react_util.tl:70

newPerk.numbers = construction_desc_react_util.collectNumbers(perk.metadata, perk, nil, nil)

base/content/gui/gui/entity_window/perk/perk_eow.script.tl:43

numbers = construction_desc_react_util.collectNumbers(desc.metadata, nil, nil, nil)

formatNumbers(numbers : Numbers) : {{FormatNumberDesc}} base/tealdef/gui/construction/construction_desc_react_util.d.tl:69

Aufruf: construction_desc_react_util.formatNumbers(…)

Hinweise

Formatiert gesammelte Kennzahlen für den Infobereich.

Im Spiel Einzigartige Nutzung · Nutzungen: {numAvailable} · Abklingzeit: {cooldown}Im Code: Unique Use · Uses: {numAvailable} · Cooldown: {cooldown}

Rückgabe {{FormatNumberDesc}}: Zeilen mit formatierten Zahlen. Jede Zeile wird nach dem layoutType ihres ersten Elements platziert.

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/game_mechanics/game_mechanics/company/company.tl:125

and construction_desc_react_util.formatNumbers(currentPerk.numbers)

base/content/gui/gui/entity_window/perk/perk_eow.script.tl:57

state.formattedNumbers = construction_desc_react_util.formatNumbers(numbers)

getDepotHudIconsConfig(capturedParams : ConstructionDescReactUtil.DepotHudIconsConfigParams) : ConstructionActionHudIcons base/tealdef/gui/construction/construction_desc_react_util.d.tl:86

Aufruf: construction_desc_react_util.getDepotHudIconsConfig(…)

Hinweise

HUD-Icons zum Platzieren eines Depots (Stationen, Depots, bei Bahn Signale, dazu der Pool der Wartungsstation), gefiltert nach Verkehrsträger.

Rückgabe ConstructionActionHudIcons

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:8

return construction_desc_react_util.getDepotHudIconsConfig(capturedParams)

base/content/gui/gui/construction/tools/rail_electrification_tool.script.tl:22

hudIcons = construction_desc_react_util.getDepotHudIconsConfig{

getStationHudIconsConfig(capturedParams : ConstructionDescReactUtil.StationHudIconsConfigParams) : ConstructionActionHudIcons base/tealdef/gui/construction/construction_desc_react_util.d.tl:87

Aufruf: construction_desc_react_util.getStationHudIconsConfig(…)

Hinweise

HUD-Icons zum Platzieren einer Station (Stationen, Städte, Industrien, dazu Signale oder Lager), mit angezeigten Stadtgebieten.

Rückgabe ConstructionActionHudIcons

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:5

return construction_desc_react_util.getStationHudIconsConfig(capturedParams)

getStreetBuilderHudIconsConfig() : ConstructionActionHudIcons base/tealdef/gui/construction/construction_desc_react_util.d.tl:88

Aufruf: construction_desc_react_util.getStreetBuilderHudIconsConfig(…)

Hinweise

HUD-Icons für den Straßenbau (Knoten, Industrien, Städte, Stationen, Straßendepots, Lager).

Rückgabe ConstructionActionHudIcons

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:32

return construction_desc_react_util.getStreetBuilderHudIconsConfig()

getTrackBuilderHudIconsConfig() : ConstructionActionHudIcons base/tealdef/gui/construction/construction_desc_react_util.d.tl:89

Aufruf: construction_desc_react_util.getTrackBuilderHudIconsConfig(…)

Hinweise

HUD-Icons für den Gleisbau (Industrien, Städte, Signale, Stationen, Bahndepots, Lager).

Rückgabe ConstructionActionHudIcons

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:35

return construction_desc_react_util.getTrackBuilderHudIconsConfig()

getLandmarkConstructionHudIconsConfig() : ConstructionActionHudIcons base/tealdef/gui/construction/construction_desc_react_util.d.tl:90

Aufruf: construction_desc_react_util.getLandmarkConstructionHudIconsConfig(…)

Hinweise

HUD-Icons zum Platzieren eines Wahrzeichens (Städte und Wahrzeichen-Konstruktionen, mit showPerksAndTowns).

Rückgabe ConstructionActionHudIcons

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:38

return construction_desc_react_util.getLandmarkConstructionHudIconsConfig()

getDefaultHudIconsConfig() : ConstructionActionHudIcons base/tealdef/gui/construction/construction_desc_react_util.d.tl:91

Aufruf: construction_desc_react_util.getDefaultHudIconsConfig(…)

Hinweise

Standard-HUD-Icons (Städte, mit Stadtgrenzen).

Rückgabe ConstructionActionHudIcons

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:41

return construction_desc_react_util.getDefaultHudIconsConfig()

formatEffectPercentage(value : number) : string base/tealdef/gui/construction/construction_desc_react_util.d.tl:93

Aufruf: construction_desc_react_util.formatEffectPercentage(…)

Hinweise

Formatiert einen Effektfaktor als prozentuale Änderung (Faktor minus 1, zum Beispiel 1.2 als +20 %).

Rückgabe string

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/game_mechanics/game_mechanics/towns/town_react_util.tl:1324

local percentageStr = construction_desc_react_util.formatEffectPercentage(effectModifier.value)

vehicleEffectMoreIsBetter(effectType : string) : boolean base/tealdef/gui/construction/construction_desc_react_util.d.tl:94

Aufruf: construction_desc_react_util.vehicleEffectMoreIsBetter(…)

Hinweise

Gibt an, ob ein höherer Wert eines Fahrzeugeffekts eine Verbesserung ist.

Rückgabe boolean: true für topSpeed und comfort, false für noise und pollution. Bei anderen Typen protokolliert die Funktion einen Fehler und gibt true zurück.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/game_mechanics/game_mechanics/towns/town_react_util.tl:1325

local isPositive = effectModifier.value > 1 == construction_desc_react_util.vehicleEffectMoreIsBetter(effect)

getVehicleEffectName(effect : string, carrier : string) : string base/tealdef/gui/construction/construction_desc_react_util.d.tl:95

Aufruf: construction_desc_react_util.getVehicleEffectName(…)

Hinweise

Gibt die übersetzte Beschriftung eines Fahrzeugeffekts für einen Verkehrsträger zurück, zum Beispiel „Zug-Höchstgeschwindigkeit“.

Im Spiel Strassenfahrzeug-Höchstgeschwindigkeit · Zug-Lärm · Schiff-KomfortIm Code: Road Vehicle Top Speed · Train Noise · Ship Comfort

Parameter	Typ	Beschreibung
`effect`	`string`	Effekttyp: `topSpeed`, `noise`, `pollution` oder `comfort`.
`carrier`	`string`	Verkehrsträger (`ROAD`, `RAIL`, `AIR`, `WATER`, `TRAM`). Andere Werte ergeben die allgemeine Beschriftung „Fahrzeug ...“.

Rückgabe string: Die Beschriftung oder nil bei einem unbekannten Effekt.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/game_mechanics/game_mechanics/towns/town_react_util.tl:1381

text = construction_desc_react_util.getVehicleEffectName(row.effect, row.carrier),

ConstructionDescReactUtil.CargoAndAmount¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:4

record CargoAndAmount

Hinweise

Eine Güterart mit Menge (zum Beispiel der Ressourcenbedarf eines Wahrzeichens).

Im Basisspiel verwendet: 6-mal in 2 Dateien

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

local formatCargoTypeSet = function(cargoTypeIds : { ConstructionDescReactUtil.CargoAndAmount }) : TreeNodeId

base/content/gui/gui/construction/construction_desc_react_util.tl:425

local formatCargoCosts = function(cargoCosts : { ConstructionDescReactUtil.CargoAndAmount }) : { ConstructionDescReactUtil.FormatNumberDesc }

Felder

Name	Typ	Beschreibung
`cargoType`	`integer`	Id der Güterart.
`amount`	`integer`	Menge. `-1`, wo nur die Güterart zählt.

ConstructionDescReactUtil.MinMax¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:9

record MinMax

Hinweise

Ein Wertebereich für den Infobereich.

Im Basisspiel verwendet: 19-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_react_util.tl:23

local function getMinMaxPerKmFactor(minMax : ConstructionDescReactUtil.MinMax) : ConstructionDescReactUtil.MinMax

Felder

Name	Typ	Beschreibung
`min`	`number`	Unterer Wert (oder der einzige Wert).
`max`	`number`	Oberer Wert. Bei Kosten kennzeichnet `-1` einen Einzelwert.
`range`	`number`	Radius einer Lärm- oder Verschmutzungsemission.

ConstructionDescReactUtil.Effect¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:14

record Effect

Hinweise

Ein Effekt, den der Infobereich zeigt.

Im Basisspiel verwendet: 5-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_react_util.tl:227

local getVehicleEffectFunction = function(effect : ConstructionDescReactUtil.Effect) : ConstructionDescReactUtil.FormatNumberDesc

Felder

Name	Typ	Beschreibung
`type`	`string`	Effekttyp, zum Beispiel `topSpeed`, `noise`, `pollution`, `comfort`, `marketing`, `greenifyNoise` oder `greenifyPollution`.
`value`	`number`	Effektfaktor (`1` heißt keine Änderung, angezeigt als Prozentwert) oder bei `marketing` die Dauer in Millisekunden.
`carrier`	`string`	Verkehrsträger, für den der Fahrzeugeffekt gilt (`ROAD`, `RAIL`, `AIR`, `WATER`, `TRAM`). Andere Werte ergeben eine allgemeine Fahrzeugbeschriftung.

ConstructionDescReactUtil.Numbers¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:19

record Numbers

Hinweise

Kennzahlen eines Menüeintrags, gesammelt von collectNumbers und formatiert von formatNumbers.

Im Basisspiel verwendet: 6-mal in 3 Dateien

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

numbers : ConstructionDescReactUtil.Numbers

base/content/gui/gui/construction/construction_desc_react_util.tl:279

local function formatPermitKey(numbers : ConstructionDescReactUtil.Numbers) : ConstructionDescReactUtil.FormatNumberDesc

base/content/gui/gui/entity_window/perk/perk_eow.script.tl:28

local numbers : ConstructionDescReactUtil.Numbers = {}

Felder

Name	Typ	Beschreibung
`companyRank`	`MinMax`
`xpIncrease`	`MinMax`	Steigerung des Stadtwachstums (aus den Metadaten zum Stadtwachstum).
`trafficRatingIncrease`	`MinMax`	Steigerung der Verkehrsbewertung (aus den Metadaten zum Stadtwachstum).
`reputationRecoveryBoost`	`MinMax`	Schnellere Rufwiederherstellung (aus den Metadaten zum Stadtwachstum).
`noise`	`MinMax`	Lärmemission. Negative Werte erscheinen als Lärmminderung.
`pollution`	`MinMax`	Verschmutzungsemission. Negative Werte erscheinen als Reinigung.
`noiseModifier`	`MinMax`
`pollutionModifier`	`MinMax`
`maxSpeedModifier`	`MinMax`
`speedLimit`	`MinMax`	Höchstgeschwindigkeit (aus den Metadaten der Gleisbeschreibung oder dem Attribut `speedLimit`).
`numLanes`	`MinMax`	Anzahl der Spuren (aus den Metadaten der Gleisbeschreibung).
`numAvailable`	`integer`	Übrige Nutzungen der Unternehmensgenehmigung. Braucht den Cache.
`capacityPassenger`	`MinMax`	Passagierkapazität.
`comfortFactor`	`MinMax`	Komfortbonus.
`effects`	`{Effect}`	Effekte wie Modifikatoren für Fahrzeuggeschwindigkeit, Lärm oder Verschmutzung.
`cost`	`MinMax`	Baukosten in Spielwährung.
`maintenanceCost`	`MinMax`	Unterhaltskosten in Spielwährung pro Jahr.
`maintenanceCapacity`	`MinMax`	Wartungskapazität.
`costPerKm`	`boolean`	Zeigt Kosten und Emissionen pro km oder Meile (aus `attributesCostPerKm`).
`cargoCosts`	`{ConstructionDescReactUtil.CargoAndAmount}`	Güter, die zum Bau nötig sind (Bedarf von Wahrzeichen, skaliert mit der Option `landmarkResources`).
`depotCapacity`	`MinMax`
`permitKey`	`ResName`	Schlüssel der Unternehmensgenehmigung des Eintrags.
`perkCategory`	`CompanyMetadata.ConstructionDesc.PerkCategory`	Bonuskategorie des Eintrags.
`cooldownInSeconds`	`number`	Abklingzeit der Genehmigung in Sekunden.

ConstructionDescReactUtil.LayoutType¶

enum base/tealdef/gui/construction/construction_desc_react_util.d.tl:47

enum LayoutType

Hinweise

Wo eine formatierte Zahl im Infobereich steht.

Im Basisspiel verwendet: 5-mal in 1 Datei

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

local makeBelowInfoPictureLayout = function(textOnImage : { ConstructionDescReactUtil.LayoutType : {{ConstructionDescReactUtil.FormatNumberDesc}} }, disabled? :

Wert	Beschreibung
`"TopLeft"`	Oben links am Vorschaubild (für negative Werte wie Emissionen).
`"TopRight"`	Oben rechts am Vorschaubild (für positive Werte wie die Höchstgeschwindigkeit).
`"BottomLeft"`	Unten links am Vorschaubild (Dauern, Abklingzeiten, übrige Nutzungen).
`"BottomRight"`	Unten rechts am Vorschaubild.
`"BelowImageLeft"`	Unter dem Bild links, in der Titelschrift (Kosten, Güterbedarf).
`"BelowImageRight"`	Unter dem Bild rechts (Unterhaltskosten).

ConstructionDescReactUtil.FormatNumberDesc¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:56

record FormatNumberDesc

Hinweise

Eine formatierte Zahl für den Infobereich.

Im Basisspiel verwendet: 33-mal in 4 Dateien

base/content/game_mechanics/game_mechanics/company/company.tl:124

local formattedNumbers : {{ConstructionDescReactUtil.FormatNumberDesc}} = (currentPerk and currentPerk.numbers)

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

local makeBelowInfoPictureLayout = function(textOnImage : { ConstructionDescReactUtil.LayoutType : {{ConstructionDescReactUtil.FormatNumberDesc}} }, disabled? :

base/content/gui/gui/construction/construction_desc_react_util.tl:70

local formatNumber : {{string, function(ConstructionDescReactUtil.MinMax) : ConstructionDescReactUtil.FormatNumberDesc }} = {

base/content/gui/gui/entity_window/perk/perk_eow.script.tl:22

formattedNumbers : {{ConstructionDescReactUtil.FormatNumberDesc}}

Felder

Name	Typ	Beschreibung
`icon`	`string`	Icon neben dem Text.
`text`	`string`	Anzuzeigender Text.
`singleLine`	`boolean`	Setzt das Element in eine eigene Zeile.
`attributeBubbleStyle`	`string`	Zusätzliche Style-Klasse der Attributblase (zum Beispiel `noise`, `noise-good`, `pollution`, `pollution-good`).
`textFirst`	`boolean`	Zeigt den Text vor dem Icon.
`layoutType`	`LayoutType`	Platzierung im Infobereich.

ConstructionDescReactUtil.ConstructionInfoNumberListParam¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:71

record ConstructionInfoNumberListParam

Hinweise

Parameter von ConstructionInfoNumberList.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/construction/construction_desc_react_util.tl:906

construction_desc_react_util.ConstructionInfoNumberList = react.RegisterRecipe("ConstructionInfoNumberList", function(param : ConstructionDescReactUtil.Construc

Felder

Name	Typ	Beschreibung
`line`	`{FormatNumberDesc}`	Anzuzeigende formatierte Zahlen.
`vertical`	`boolean`	Stapelt die Elemente senkrecht statt in einem Fließlayout.
`useTitleFont`	`boolean`	Verwendet die Überschriftenschrift statt der Textschrift.

ConstructionDescReactUtil.DepotHudIconsConfigParams¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:78

record DepotHudIconsConfigParams

Hinweise

Parameter von getDepotHudIconsConfig.

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:7

configureDepotHudIconsFn = function(capturedParams : ConstructionDescReactUtil.DepotHudIconsConfigParams) : ConstructionActionHudIcons

base/content/gui/gui/construction/construction_desc_react_util.tl:1017

construction_desc_react_util.getDepotHudIconsConfig = function(capturedParams : ConstructionDescReactUtil.DepotHudIconsConfigParams) : ConstructionActionHudIcon

Felder

Name	Typ	Beschreibung
`depotType`	`ConstructionActionHudIconConstructionType`	Verkehrsträger des Depots.

ConstructionDescReactUtil.StationHudIconsConfigParams¶

record base/tealdef/gui/construction/construction_desc_react_util.d.tl:81

record StationHudIconsConfigParams

Hinweise

Parameter von getStationHudIconsConfig.

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/construction/construction_desc_hud_icons.script.tl:4

configureStationHudIconsFn = function(capturedParams : ConstructionDescReactUtil.StationHudIconsConfigParams) : ConstructionActionHudIcons

base/content/gui/gui/construction/construction_desc_react_util.tl:1041

construction_desc_react_util.getStationHudIconsConfig = function(capturedParams : ConstructionDescReactUtil.StationHudIconsConfigParams) : ConstructionActionHud

Felder

Name	Typ	Beschreibung
`cargo`	`boolean`	Güterstation. Fügt Lager-Icons hinzu.
`rail`	`boolean`	Bahnstation. Fügt Signal-Icons hinzu.