cargo_react_util¶
Quelle: base/tealdef/gui/main/cargo_react_util.d.tl
Hinweise
React-Recipes und Knoten-Bauer für Güter: Güter-Icons, Güterlisten von Fahrzeugen, Linien und Lagern
(Anzahl/Kapazität pro Güterart mit Tendenz, Qualität und Ladezustand), die Eingang/Ausgang-Anzeige
mit Pfeil bei Industrien und Abzeichen für die Spezialisierung auf Güterklassen. Du lädst es mit
ug_require "/gui/main/cargo_react_util.tl". Die Daten kommen aus CargoUtil.
CargoReactUtil¶
record global base/tealdef/gui/main/cargo_react_util.d.tl:3
global record CargoReactUtil
Laden: local cargo_react_util = ug_require "::/gui/main/cargo_react_util.tl" as CargoReactUtil
Hinweise
Recipes und Bauer, die Güter-Icons und Güterlisten anzeigen.
Felder
| Name | Typ | Beschreibung |
|---|---|---|
LineCargoInfo |
Recipe<LineCargoInfoParams> |
Zeigt die Ladung aller Fahrzeuge einer Linie (Anzahl/Kapazität pro Güterart, Ladeanimation und Anzeigen für Unzufriedene und Verspätete).Im Spiel Warte auf Güter · {count} unzufriedener Passagier / {count} unzufriedene Passagiere · {count} verspätete Lieferung / {count} verspätete LieferungenIm Code: Waiting For Cargo · {count} Unhappy Passenger / {count} Unhappy Passengers · {count} Delayed Delivery / {count} Delayed Deliveries 1-mal im Basisspiel verwendet |
WarehouseCargoInfo |
Recipe<WarehouseCargoInfoParams> |
Zeigt den Bestand eines Lagers pro Güterart (Anzahl/Kapazität, optional Tendenz, Anzeigen für Unzufriedene und Verspätete).Im Spiel Warte auf Güter · Durchschnittliche verbleibende Lieferzeit: {quality}Im Code: Waiting For Cargo · Average Remaining Delivery Time: {quality} 3-mal im Basisspiel verwendet |
CargoList |
Recipe<CargoListParams> |
|
LocationCargoList |
Recipe<LocationCargoListParams> |
Listet die Güterarten an einem Ort auf, ein Eintrag pro Güterart, gebaut von getCargoItemLayout. |
CargoInputOutputIndicator |
Recipe<CargoInputOutputParams> |
Zeigt die Eingangsgüter, einen Pfeil und die Ausgangsgüter einer Bestandsliste, wie auf den HUD-Icons von Industrien und in der Ebene der Güterströme.Im Spiel Produktion · Verbrauch · Beliebiger GütertypIm Code: Production · Consumption · Any Cargo 13-mal im Basisspiel verwendet |
CargoIconLabelIndicator |
Recipe<CargoIconLabelIndicatorParams> |
Recipe-Fassung von makeCargoIconLabelIndicator. 2-mal im Basisspiel verwendet |
CargoClassSpecialization |
Recipe<CargoSpecializationParams> |
Zeigt pro Güterklasse ein Abzeichen mit dem Klassennamen und einem Rahmen in der Farbe der Klasse.Im Spiel Passagiere · Passagiere und alle Güterarten · Alle GüterIm Code: Passengers · Passengers and All Cargo Types · All Cargo 2-mal im Basisspiel verwendet |
Funktionen
makeVehicleCargoInfo(VehicleCargoInfoParams) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:25
Aufruf: cargo_react_util.makeVehicleCargoInfo(…)
Hinweise
Baut eine LocationCargoList, die die Ladung eines Fahrzeugs nach Kapazität sortiert in einem Flow-Layout zeigt.
Im Spiel Warte auf Güter
· Durchschnittliche Zufriedenheit: {happiness}
· Durchschnittliche verbleibende Lieferzeit: {quality}
Im Code: Waiting For Cargo
· Average Happiness: {happiness}
· Average Remaining Delivery Time: {quality}
Rückgabe TreeNodeId: Der Listenknoten mit dem Transportzustand Vehicle.
Im Basisspiel verwendet: 8-mal in 5 Dateien
base/content/gui/gui/entity_window/entity_window_hud.tl:335
base/content/gui/gui/entity_window/vehicle/vehicle_eow.script.tl:865
base/content/gui/gui/layers/layer_cargo.tl:112
base/content/gui/gui/layers/layer_public_transport.tl:142
base/content/gui/gui/main/hud_icon_toolbox.tl:312
makeIcon(class : string, icon : string, tooltip : string, forceFocusable? : boolean) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:29
Aufruf: cargo_react_util.makeIcon(…)
Hinweise
Baut einen builtin.ImageView mit der angegebenen Style-Klasse, dem Bildpfad und dem Tooltip.
| Parameter | Typ | Beschreibung |
|---|---|---|
class |
string |
Style-Klasse. |
icon |
string |
Bildpfad. |
tooltip |
string |
Text des Tooltips. |
forceFocusable? |
boolean |
Geht an meta.forceFocusable. |
Rückgabe TreeNodeId
makeCargoIcon(CargoTypeId, ?string, ?string, withoutTooltip? : boolean, forceFocusable? : boolean, tooltipModifier? : function(string) : string) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:30
Aufruf: cargo_react_util.makeCargoIcon(…)
Hinweise
Baut das Icon einer Güterart mit ihrem Namen als Tooltip.
| Parameter | Typ | Beschreibung |
|---|---|---|
#1 |
CargoTypeId |
Güterart-ID. |
#2 |
?string |
Style-Klasse. |
#3 |
?string |
Bildpfad, der statt des Icons der Güterart verwendet wird. |
withoutTooltip? |
boolean |
Bei true wird kein Tooltip gesetzt. |
forceFocusable? |
boolean |
Geht an meta.forceFocusable. |
tooltipModifier? |
function(string) : string |
Wird mit dem Text des Tooltips (oder nil) aufgerufen; sein Ergebnis wird zum Tooltip. |
Rückgabe TreeNodeId
Im Basisspiel verwendet: 15-mal in 11 Dateien
base/content/gui/gui/entity_window/entity_window_util.tl:319
local child = cargo_react_util.makeCargoIcon(cargoTypeId, cargoState:old().overflow and "text-icon-size-hack" or "")
base/content/gui/gui/entity_window/industry/industry_eow.script.tl:229
cargo_react_util.makeCargoIcon(cargoTypeState:old(), nil, nil, nil, app_util.isGamepadInputMode(), tooltipModifier)
base/content/gui/gui/entity_window/town/town.tl:221
cargo_react_util.makeCargoIcon(cargoTypeState:old(), nil, nil, nil, app_util.isGamepadInputMode(), tooltipModifier)
base/content/gui/gui/line_vehicle_mgmt/line_react_util.tl:709
passengerChild = cargo_react_util.makeCargoIcon(cargoDisplayState:old().passengerCargoTypeId, "cargo-icon-only")
base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:241
base/content/gui/gui/main/town_hud_react_util.tl:161
… und 5 weitere Dateien.
makeCargoClassIcon(CargoTypeId, ?string) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:31
Aufruf: cargo_react_util.makeCargoClassIcon(…)
Hinweise
Baut eine horizontale Zeile mit den Icons aller Güterklassen einer Güterart, jedes mit dem Klassennamen als Tooltip.
| Parameter | Typ | Beschreibung |
|---|---|---|
#1 |
CargoTypeId |
Güterart-ID. |
#2 |
?string |
Style-Klasse der Icons. |
Rückgabe TreeNodeId
makeTooltipStockCompatibility(Engine.Component.TransportVehicle.LoadSpeedModifiers) : string base/tealdef/gui/main/cargo_react_util.d.tl:33
Aufruf: cargo_react_util.makeTooltipStockCompatibility(…)
Hinweise
Baut den Tooltip-Text „Specialized Warehouse“ (im deutschen Spiel „Spezialisiertes Lager“) mit dem Bonus auf die Ladegeschwindigkeit durch die Spezialisierung des Lagers.
Im Spiel Spezialisiertes Lager: {boost}
Im Code: Specialized Warehouse: {boost}
Rückgabe string
makeTooltipVehicleCompatibility(Engine.Component.TransportVehicle.LoadSpeedModifiers) : string base/tealdef/gui/main/cargo_react_util.d.tl:34
Aufruf: cargo_react_util.makeTooltipVehicleCompatibility(…)
Hinweise
Baut die Tooltip-Zeilen, die den Anteil des Terminals an der Ladegeschwindigkeit erklären (spezialisiertes Terminal, unpassende Spezialisierung, zu kurzes Terminal).
Im Spiel Spezialisiertes Terminal: {boost}
· Spezialisierungen stimmen nicht überein: {penalty}
· Terminal zu kurz: {penalty}
Im Code: Specialized Terminal: {boost}
· Specializations Don't Match: {penalty}
· Terminal Too Short: {penalty}
Rückgabe string: Übersetzte Zeilen, durch Zeilenumbrüche verbunden.
makeCargoIconLabelIndicator(CargoIconLabelIndicatorParams) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:50
Aufruf: cargo_react_util.makeCargoIconLabelIndicator(…)
Hinweise
Baut eine Icon/Label-Anzeige für eine Güterart, in der Icon und Name der Güterart schon eingetragen sind.
Rückgabe TreeNodeId
Details
Ruft GuiReactUtil.makeContentLabelIndictator mit den Güter-Icons als iconPath und den
Güternamen als iconTooltip auf.
Im Basisspiel verwendet: 5-mal in 4 Dateien
base/content/game_mechanics/game_mechanics/towns/town_react_util.tl:150
base/content/gui/gui/entity_window/entity_window_util.tl:705
base/content/gui/gui/entity_window/town_building/town_building.tl:129
base/content/gui/gui/layers/layer_public_transport.tl:54
makeCargoInputOutputDataForStorage(entity : Engine.Entity) : CargoReactUtil.CargoInputOutputData base/tealdef/gui/main/cargo_react_util.d.tl:99
Aufruf: cargo_react_util.makeCargoInputOutputDataForStorage(…)
Hinweise
Baut CargoInputOutputData für ein Lager und führt die angenommenen Güterarten (oder „beliebige Güter“) als Eingänge ohne Mengen auf.
| Parameter | Typ | Beschreibung |
|---|---|---|
entity |
Engine.Entity |
Bestandslisten-Entität. |
Rückgabe CargoReactUtil.CargoInputOutputData
makeCargoInputOutputDataForStocklist(entity : Engine.Entity, inputCount : boolean, inputMax : boolean, outputCount : boolean, outputMax : boolean) : CargoInputOutputData base/tealdef/gui/main/cargo_react_util.d.tl:100
Aufruf: cargo_react_util.makeCargoInputOutputDataForStocklist(…)
Hinweise
Baut CargoInputOutputData aus den Eingängen und Ausgängen der Regeln einer Bestandsliste.
| Parameter | Typ | Beschreibung |
|---|---|---|
entity |
Engine.Entity |
Bestandslisten-Entität (z. B. Industry.stockList). |
inputCount |
boolean |
Bei true wird count der Eingänge mit dem Verbrauch pro Jahr gefüllt. |
inputMax |
boolean |
Bei true wird max der Eingänge mit dem maximalen Verbrauch pro Jahr gefüllt. |
outputCount |
boolean |
Bei true wird count der Ausgänge mit der Produktion pro Jahr gefüllt. |
outputMax |
boolean |
Bei true wird max der Ausgänge mit der maximalen Produktion pro Jahr gefüllt. |
Rückgabe CargoInputOutputData
Beispiel
Im Basisspiel verwendet: 8-mal in 5 Dateien
base/content/gui/gui/construction/constructionHudIconMaster.tl:137
return cargo_react_util.makeCargoInputOutputDataForStocklist(param.entity, false, false, false, false)
base/content/gui/gui/entity_window/entity_window_hud.tl:45
return cargo_react_util.makeCargoInputOutputDataForStocklist(industry.stockList, false, false, false, false)
base/content/gui/gui/layers/layer_cargo_flow.tl:98
stockListData = cargo_react_util.makeCargoInputOutputDataForStocklist(param.entity, false, true, false, true)
base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:929
stockList = cargo_react_util.makeCargoInputOutputDataForStocklist(hudIconParam.entity, false, false, false, false),
base/content/gui/gui/statistics/statistics.tl:92
makeCargoInputOutputDataForConstructionData(entity : Engine.Entity) : CargoInputOutputData base/tealdef/gui/main/cargo_react_util.d.tl:102
Aufruf: cargo_react_util.makeCargoInputOutputDataForConstructionData(…)
Hinweise
Baut CargoInputOutputData mit den Güteranforderungen einer Konstruktion als Eingängen.
| Parameter | Typ | Beschreibung |
|---|---|---|
entity |
Engine.Entity |
Konstruktions-Entität. |
Rückgabe CargoInputOutputData
Details
Liest die Anforderungen aus den persistenten Metadaten der Konstruktion. Eingänge kommen nur
hinzu, solange die Konstruktion über Stufe 0 und unter ihrer letzten Stufe liegt.
CargoReactUtil.VehicleCargoInfoParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:4
record VehicleCargoInfoParams
Hinweise
Parameter von makeVehicleCargoInfo.
Im Basisspiel verwendet: 1-mal in 1 Datei
base/content/gui/gui/main/cargo_react_util.tl:260
Felder
| Name | Typ | Beschreibung |
|---|---|---|
vehicleEntity |
Engine.Entity |
Fahrzeug, dessen Ladung angezeigt wird. |
showEmpty |
boolean |
show with number 0 if empty |
showLoadingIndicator |
boolean |
Bei true läuft die Lade- und Entladeanimation, solange das Fahrzeug an einem Terminal steht (nicht im Modus EntityWindow). |
mode |
GuiReactUtil.LabelMode |
Label-Modus der Einträge. EntityWindow fasst zusätzlich freie Kapazitäten zusammen und fügt die Anzeigen für Unzufriedene und Verspätete hinzu. |
Funktionen
cargoTypeFilter(CargoTypeId) : boolean base/tealdef/gui/main/cargo_react_util.d.tl:9
Hinweise
Funktion, die für anzuzeigende Güterarten true liefert.
Rückgabe boolean
getEmptyItem() : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:11
use special recipe if empty
Rückgabe TreeNodeId
CargoReactUtil.LineCargoInfoParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:13
record LineCargoInfoParams
Hinweise
Parameter des Recipes LineCargoInfo.
Im Basisspiel verwendet: 1-mal in 1 Datei
base/content/gui/gui/main/cargo_react_util.tl:280
Felder
| Name | Typ | Beschreibung |
|---|---|---|
lineEntity |
Engine.Entity |
Linie, deren Ladung angezeigt wird. |
makeEmptyItem |
TreeNodeId |
Erscheint, wenn die Linie nichts transportiert. Bei nil werden stattdessen die leeren Güterarten aufgeführt. |
mode |
GuiReactUtil.LabelMode |
Label-Modus der Einträge. |
CargoReactUtil.WarehouseCargoInfoParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:18
record WarehouseCargoInfoParams
Hinweise
Parameter des Recipes WarehouseCargoInfo.
Im Basisspiel verwendet: 1-mal in 1 Datei
base/content/gui/gui/main/cargo_react_util.tl:303
Felder
| Name | Typ | Beschreibung |
|---|---|---|
warehouseEntity |
Engine.Entity |
Lager (oder anderer Besitzer einer Bestandsliste), dessen Bestand angezeigt wird. |
makeEmptyItem |
TreeNodeId |
Erscheint, wenn der Bestand leer ist. Bei nil werden stattdessen die leeren Güterarten aufgeführt (außer im Modus HudIconLayer). |
showTendency |
boolean |
Bei true erscheinen Tendenzpfeile (nicht in den HUD-Modi). |
mode |
GuiReactUtil.LabelMode |
Label-Modus der Einträge. |
CargoReactUtil.CargoIconLabelIndicatorParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:36
record CargoIconLabelIndicatorParams
Hinweise
Parameter von makeCargoIconLabelIndicator und CargoIconLabelIndicator.
Felder
| Name | Typ | Beschreibung |
|---|---|---|
cargoType |
CargoTypeId |
Güterart, deren Icon erscheint. Wird ignoriert, wenn cargoTypes gesetzt ist. |
cargoTypes |
{CargoTypeId} |
Mehrere Güterarten; ihre Icons stehen nebeneinander, jedes mit seinem Namen als Tooltip. |
iconStyle |
string |
|
label |
string |
Textlabel, meist die Anzahl. |
richLabel |
GuiReactUtil.RichLabel |
Label mit Text und Icon; hat Vorrang vor label. |
labelFontColor |
GuiReactUtil.LabelFontColor |
Farbe des Labels. |
labelMode |
GuiReactUtil.LabelMode |
Layout-Modus. |
labelTooltip |
string |
Tooltip des Labels. |
indicatorIconPath |
string |
Bildpfad eines kleinen Anzeige-Icons neben dem Label, z. B. ein Tendenzpfeil. |
iconOverride |
string |
|
loadingIndicator |
TreeNodeId |
Knoten über der Anzeige, z. B. die Ladeanimation. |
shippingState |
GuiReactUtil.ShippingState |
Wo sich die Güter befinden; fügt die passende Style-Klasse hinzu. |
CargoReactUtil.CargoListParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:52
record CargoListParams
Die Spieldateien enthalten hierzu noch keine Beschreibung.
Felder
| Name | Typ | Beschreibung |
|---|---|---|
gameCtx |
GameContext |
|
cargoTypeLoadSpeed |
{{CargoTypeId, number}} |
|
allCargo |
boolean |
CargoReactUtil.LocationCargoListParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:59
record LocationCargoListParams
Hinweise
Parameter des Recipes LocationCargoList.
Im Basisspiel verwendet: 1-mal in 1 Datei
base/content/gui/gui/main/cargo_react_util.tl:390
Felder
| Name | Typ | Beschreibung |
|---|---|---|
locationParams |
CargoUtil.CargoLocationParams |
Wo die Güter gesammelt werden (Fahrzeug, Besitzer einer Bestandsliste, Linie). |
layout |
LocationCargoListLayout |
Anordnung der Einträge. Alles außer FLOW oder VERTICAL ergibt eine horizontale Box. |
sortOrder |
CargoUtil.CargoListSortOrder |
Sortierreihenfolge der Güterarten. |
groupIfAllEmpty |
boolean |
Bei true, wenn der Ort ein Fahrzeug mit showEmpty ist, kommen die freien Kapazitäten des Fahrzeugs hinzu (Kapazitäten für eine Art zu ihrer Güterart, Kapazitäten für mehrere Arten als eigene Einträge). |
shippingState |
GuiReactUtil.ShippingState |
Transportzustand, der an die Layout-Funktionen der Einträge geht. |
Funktionen
cargoTypeFilter(CargoTypeId) : boolean base/tealdef/gui/main/cargo_react_util.d.tl:67
Hinweise
Geht an CargoUtil.getSortedProducedCargoTypes (dort steht, wann er wirkt).
Rückgabe boolean
getCargoItemLayout(CargoUtil.CargoTypeInfo, GuiReactUtil.ShippingState) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:71
Hinweise
Baut den Knoten eines Eintrags für eine Güterart.
Rückgabe TreeNodeId
getFrownyIconLayout(summary : UtilCargo.CargoQualityData, cargoIsPassengers : boolean, shippingState : GuiReactUtil.ShippingState) : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:72
Hinweise
Wenn gesetzt, baut es die Anzeige für unzufriedene Passagiere und verdorbene Güter; wird nur aufgerufen, wenn der Ort solche Güter hat.
Rückgabe TreeNodeId
getEmptyItem() : TreeNodeId base/tealdef/gui/main/cargo_react_util.d.tl:73
Hinweise
Baut den Knoten, der erscheint, wenn die Liste keine Einträge hat.
Rückgabe TreeNodeId
CargoReactUtil.LocationCargoListParams.LocationCargoListLayout¶
enum base/tealdef/gui/main/cargo_react_util.d.tl:60
enum LocationCargoListLayout
Hinweise
Wie die Einträge einer LocationCargoList angeordnet sind.
| Wert | Beschreibung |
|---|---|
"VERTICAL" |
Vertikales Box-Layout. |
"HORIZONTAL" |
Horizontales Box-Layout. |
"FLOW" |
Flow-Layout, das die Einträge auf Zeilen umbricht. |
CargoReactUtil.CargoInputOutputData¶
record base/tealdef/gui/main/cargo_react_util.d.tl:79
record CargoInputOutputData
Hinweise
Eingangs- und Ausgangsgüter einer Bestandsliste für CargoInputOutputIndicator.
Im Basisspiel verwendet: 25-mal in 7 Dateien
base/content/gui/gui/construction/constructionHudIconMaster.tl:135
local generalCargoDataState = engine_react_util.useStepStateTimer(function() : CargoReactUtil.CargoInputOutputData
base/content/gui/gui/entity_window/entity_window_hud.tl:37
local isIndustryProducingSomeOfCargoTypes = function(entity : Engine.Entity, cargoItems : {CargoTypeId : CargoUtil.StockProperties}, checkAlsoIfConsuming? : boo
base/content/gui/gui/layers/layer_cargo_flow.tl:54
base/content/gui/gui/layers/layer_react_util.tl:181
base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:903
base/content/gui/gui/main/cargo_react_util.tl:623
… und 1 weitere Dateien.
Felder
| Name | Typ | Beschreibung |
|---|---|---|
inputs |
{CargoData} |
Einträge der Eingangsgüter. |
outputs |
{CargoData} |
Einträge der Ausgangsgüter. |
CargoReactUtil.CargoInputOutputData.CargoData¶
record base/tealdef/gui/main/cargo_react_util.d.tl:80
record CargoData
Hinweise
Ein Gütereintrag von CargoInputOutputData.
Im Basisspiel verwendet: 9-mal in 4 Dateien
base/content/gui/gui/construction/constructionHudIconMaster.tl:154
base/content/gui/gui/layers/layer_cargo_flow.tl:83
base/content/gui/gui/line_vehicle_mgmt/manager_hud_util.tl:1028
base/content/gui/gui/main/cargo_react_util.tl:491
Felder
| Name | Typ | Beschreibung |
|---|---|---|
count |
integer |
Aktuelle Menge, z. B. Verbrauch oder Produktion pro Jahr. nil, wenn nicht angezeigt. |
max |
integer |
Höchstmenge, z. B. maximaler Verbrauch oder maximale Produktion pro Jahr. nil, wenn nicht angezeigt. |
cargoType |
CargoTypeId |
Güterart-ID. |
allCargoType |
boolean |
true, wenn der Eintrag für beliebige Güter steht; er erscheint mit dem Icon für gemischte Güter. |
CargoReactUtil.CargoInputOutputParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:90
record CargoInputOutputParams
Hinweise
Parameter des Recipes CargoInputOutputIndicator.
Im Basisspiel verwendet: 1-mal in 1 Datei
base/content/gui/gui/main/cargo_react_util.tl:477
Felder
| Name | Typ | Beschreibung |
|---|---|---|
data |
CargoInputOutputData |
Anzuzeigende Eingangs- und Ausgangsgüter. |
inputDistrict |
LandUseType |
optional, default is nil |
outputDistrict |
LandUseType |
optional, default is nil |
showPercentage |
boolean |
Bei true zeigen Einträge mit count und max den Wert count / max als Prozentsatz statt count/max. |
CargoReactUtil.CargoSpecializationParams¶
record base/tealdef/gui/main/cargo_react_util.d.tl:104
record CargoSpecializationParams
Hinweise
Parameter des Recipes CargoClassSpecialization.
Felder