entity_window_util¶

Quelle: base/tealdef/gui/entity_window/entity_window_util.d.tl

Hinweise

Gemeinsame React-Recipes und Hilfsfunktionen der Infofenster (Infofenster von Fahrzeugen, Stationen, Industrien, Städten, Personen …): Bestandsbalken, Diagramme, Aktionsleisten, Bewertungs- und Fortschrittsbalken, Personentabellen, Benachrichtigungskarten. Geladen wird die Datei mit ug_require "/gui/entity_window/entity_window_util.tl".

Globale Namen¶

Typen

Name	Definition	Beschreibung
`PopoverReactUtil`	`hier deklariert, definiert in PopoverReactUtil`	Recipes für Popover-Fenster.

EntityWindowUtil¶

record global base/tealdef/gui/entity_window/entity_window_util.d.tl:5

global record EntityWindowUtil

Laden: local entity_window_util = ug_require "::/gui/entity_window/entity_window_util.tl" as EntityWindowUtil

Hinweise

Bibliothek mit React-Recipes und Hilfsfunktionen, die sich die Infofenster teilen.

Details

Die meisten Einträge sind Recipes (Recipe<...>). Du rufst sie mit ihrem Parameter-Record auf und erhältst eine TreeNodeId, z. B. entity_window_util.ProgressDisplay{ value = 0.5, text = "50%" }. Viele von ihnen fragen den Engine-Zustand mit engine_react_util.useStepState in jedem Schritt ab.

Felder

Name	Typ	Beschreibung
`VehicleCell`	`Recipe<Builtin.TableCellParam>`	Recipe einer Tabellenzelle. Es zeigt Namen und Symbol des Fahrzeugs der Zeile als Knopf, der das Fahrzeug auswählt (und sein Fenster öffnet). 1-mal im Basisspiel verwendet
`VehicleTable`	`Recipe<VehicleTableParams>`	Sortierbare Datentabelle von Fahrzeugen. Die Zeilen kommen aus `getVehicleEntities` und werden in jedem Schritt aktualisiert. 1-mal im Basisspiel verwendet
`VehicleCondition`	`Recipe<VehicleConditionParams>`	Fortschrittsbalken des durchschnittlichen Fahrzeugzustands (Wartungszustand) mit Zustandstext und Trendpfeil.Im Spiel Fahrzeugzustand: {amount}Im Code: Vehicle Condition: {amount} 1-mal im Basisspiel verwendet
`MaintenanceBar`	`Recipe<MaintenanceBarParam>`	Info-Blase (Callout) mit den Unterhalts- oder Betriebskosten einer Entität je Zeitraum: Unterhalt der Stationsgruppe, Betriebskosten eines Fahrzeugs oder skalierter Unterhalt einer Konstruktion (oder der übergeordneten Konstruktion einer Unterkonstruktion). Bei Kosten von 0 zeigt sie nichts an.Im Spiel Betriebskosten · UnterhaltIm Code: Running Costs · Upkeep 5-mal im Basisspiel verwendet
`MaintenanceStationPoolProgressBar`	`Recipe<MaintenanceStationPoolProgressBarParams>`	Fortschrittsbalken der Fahrzeuge, die einem Wartungsgebäude zugeordnet sind, gemessen an seiner Wartungspool-Größe. Bei einem Pool von 0 zeigt er „No Maintenance Pool“ (dt. „Kein Wartungspool“).Im Spiel Pool-Nutzung: {amount} · Kein WartungspoolIm Code: Pool Usage: {amount} · No Maintenance Pool 3-mal im Basisspiel verwendet
`EntityStockCountsWidget`	`Recipe<StockCountsWidgetParams>`	Liste der Bestände einer Entität, gruppiert nach Spezialisierung der Güterklasse, jeweils mit Gütersymbolen, Text „gelagert/Kapazität“ und Füllbalken.Im Spiel Spezialisierung: · Alle Güterarten · Alle Güter entsorgenIm Code: Specialization: · All Cargo Types · Discard All Cargo 1-mal im Basisspiel verwendet
`CombinedStockGroupedCounts`	`Recipe<CombinedStockGroupedCountsParam>`	Inhaltskarten „Input Stocks“ und „Output Stocks“ (dt. „Eingangsbestände“ und „Ausgangsbestände“) der Bestandsliste einer Entität, mit kompakten Güterzahlen und einem optionalen einklappbaren Teil.Im Spiel Eingangsbestände · AusgangsbeständeIm Code: Input Stocks · Output Stocks 3-mal im Basisspiel verwendet
`EntityDiagramWidget`	`Recipe<DiagramParams>`	Diagramm des Logbuch- oder Kontoverlaufs einer Entität mit optionaler Legende und Zeitrahmen-Schieberegler. Wird in jedem Schritt aktualisiert.Im Spiel Zeitrahmen · {years} JahreIm Code: Time Scale · {years} Years 17-mal im Basisspiel verwendet
`EntityWindowButton`	`Recipe<EntityWindowButtonParams>`	Symbolknopf mit Tooltip.
`ActionButtonBar`	`Recipe<ActionButtonBarParams>`	Waagerechte Leiste aus primären Knöpfen (Symbol und Text), gefolgt von sekundären Symbolknöpfen. 8-mal im Basisspiel verwendet
`PersonCapacityWidget`	`Recipe<WorkplacesProgressBarWidgetParams>`	Personensymbol (Tooltip je nach Flächennutzungstyp „Residents“, „Customers“ oder „Workers“, dt. „Einwohner“, „Kunden“, „Arbeiter“), gefolgt von einem `WorkplacesProgressBarWidget`.Im Spiel Einwohner · Kunden · ArbeiterIm Code: Residents · Customers · Workers 2-mal im Basisspiel verwendet
`SimPersonDestinationButton`	`Recipe<SimPersonDestinationButtonParams>`	Knopf mit dem Zielsymbol, der die Ziel-Entität der Sim-Person zum angegebenen Zielindex auswählt.
`InhabitantsTable`	`Recipe<InhabitantsTableParam>`	Tabelle der Sim-Personen eines Gebäudes (Name, Zufriedenheit, ob gerade vor Ort oder unterwegs, bei Nicht-Wohngebäuden die Fortbewegungsart). Ist sie leer, zeigt sie einen Hinweis zum öffentlichen Verkehr.Im Spiel Derzeit hier · Unterwegs · Erschliesse diesen Standort mit dem öffentlichen Verkehr, um den Einwohnern zu ermöglichen, dort zu leben.Im Code: Currently Here · On the Way · Connect this location with public transport to enable residents to live here. 3-mal im Basisspiel verwendet
`WorkersTable`	`Recipe<WorkersTableParam>`	Tabelle der Arbeiter (Besucher) einer Entität mit der jeweils verbleibenden Zeit. Ist sie leer, zeigt sie einen Hinweis zum öffentlichen Verkehr.Im Spiel Zeit übrig · Erschliesse diesen Standort mit dem öffentlichen Verkehr, um den Einwohnern zu ermöglichen, dort zu arbeiten.Im Code: Time Left · Connect this location with public transport to allow residents to work here. 2-mal im Basisspiel verwendet
`EnterCockpitButton`	`Recipe2<GameContext, Engine.Entity>`	Primärer Knopf „Enter Cockpit“ (dt. „Im Cockpit Platz nehmen“). Er legt das Werkzeug für die freie Kamera im Cockpitmodus für die angegebene Entität auf den Stapel.Im Spiel Im Cockpit Platz nehmenIm Code: Enter Cockpit 6-mal im Basisspiel verwendet
`WorkplacesProgressBarWidget`	`Recipe<WorkplacesProgressBarWidgetParams>`	Text „belegt/Kapazität“ und Fortschrittsbalken einer Entität mit `PERSON_CAPACITY` (Anzahl der Sim-Personen, die sie als Ziel haben).
`PassengersWidget`	`Recipe<PassengerWidgetParams>`	Tabelle der Sim-Personen in einem Fahrzeug mit Zufriedenheit und ihren anderen Zielen. Ist sie leer, zeigt sie „Currently no passengers in this vehicle.“ (dt. „Aktuell keine Passagiere im Fahrzeug.“).Im Spiel Aktuell keine Passagiere im Fahrzeug.Im Code: Currently no passengers in this vehicle. 1-mal im Basisspiel verwendet
`RatingBar`	`Recipe<RatingBarParam>`	Segmentierter Bewertungsbalken mit optionalem Symbol, Trendpfeil und Bewertungstext. 3-mal im Basisspiel verwendet
`SubconstructionBalance`	`Recipe<SubconstructionBalanceParams>`	Geldbetrag (als negativ oder positiv gestaltet) des Ertrags der übergeordneten Konstruktion einer Unterkonstruktion über das letzte Spieljahr. 1-mal im Basisspiel verwendet
`SpeedIndicator`	`Recipe<Engine.Entity>`	Statuszeilen eines Fahrzeugs oder einer Sim-Person im Auto: Geschwindigkeit, „Stopped“/„Stopping“, „No Path“, „Waiting for Free Path“ (dt. „Angehalten“/„Halte an“, „Kein Weg“, „Warte auf freie Wege“) oder Be- und Entladen je Gütertyp mit Abzügen bei der Ladegeschwindigkeit an einem Terminal.Im Spiel Angehalten · Kein Weg · Warte auf freie WegeIm Code: Stopped · No Path · Waiting for Free Path 2-mal im Basisspiel verwendet
`SendCommandButton`	`Recipe<SendCommandButtonParams>`	Symbolknopf, der beim Klick den von `makeCommand` gebauten Befehl abschickt und je nach `isActive` aktiv ist.
`NoiseAndPollution`	`Recipe<NoiseAndPollutionParams>`	Textzeile mit den aktuellen Lärm- und Verschmutzungswerten.Im Spiel Aktueller Lärm: {formattedNoise} · Aktuelle Verschmutzung: {formattedPollution}Im Code: Current Noise: {formattedNoise} · Current Pollution: {formattedPollution} 3-mal im Basisspiel verwendet
`ProgressDisplay`	`Recipe<ProgressDisplayParam>`	Fortschrittsbalken mit optionalem Symbol, zentriertem Text, einem zweiten (zusätzlichen) Füllwert, Trendpfeil und zusätzlichem Kind-Element. 3-mal im Basisspiel verwendet
`NotificationWidget`	`Recipe<Engine.Entity>`	Liste von Karten für die dauerhaften Benachrichtigungen einer Entität. Gibt es keine, zeigt es nichts an. 8-mal im Basisspiel verwendet
`ContentWidgetScrollContainer`	`Recipe2<{TreeNodeId}, boolean>`	Senkrechter Scrollbereich für die Inhalts-Widgets eines Infofensters. Der boolesche Parameter fügt die Style-Klasse `first` hinzu. 19-mal im Basisspiel verwendet

Funktionen

GetDestinationIcon(DestinationIconParams) : TreeNodeId base/tealdef/gui/entity_window/entity_window_util.d.tl:247

Aufruf: entity_window_util.GetDestinationIcon(…)

Hinweise

Erzeugt das Symbol eines Ziels einer Sim-Person (Wohnsitz, Einkaufen oder Arbeit).

Im Spiel Wohnsitz · Einkaufen · ArbeitIm Code: Home · Shop · Work

Parameter	Typ	Beschreibung
`#1`	`DestinationIconParams`	Zielindex (0 Wohnsitz, 1 Einkaufen, 2 Arbeit), Style-Klasse des Symbols und optionaler Tooltip.

Rückgabe TreeNodeId: Ein Bild-Widget.

Im Basisspiel verwendet: 3-mal in 1 Datei

base/content/gui/gui/entity_window/sim_person/sim_person_eow.script.tl:83

entity_window_util.GetDestinationIcon{

GetMoveModeIcon(MoveMode) : TreeNodeId base/tealdef/gui/entity_window/entity_window_util.d.tl:249

Aufruf: entity_window_util.GetMoveModeIcon(…)

Hinweise

Erzeugt ein Symbol mit Tooltip für eine Fortbewegungsart (zu Fuß, Auto, Linien).

Im Spiel Zu Fuss · Auto · LinienIm Code: Walk · Car · Lines

Rückgabe TreeNodeId: Ein Bild-Widget. Bei anderen Fortbewegungsarten mit leerem Pfad.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/sim_person/sim_person_eow.script.tl:182

entity_window_util.GetMoveModeIcon(param.moveMode),

GetInhabitantsTitle(entityId : Engine.Entity, landmark? : boolean) : string base/tealdef/gui/entity_window/entity_window_util.d.tl:250

Aufruf: entity_window_util.GetInhabitantsTitle(…)

Hinweise

Liefert den Titel für die Personen eines Gebäudes anhand seines Flächennutzungstyps.

Im Spiel Einwohner · Kunden · BesucherIm Code: Residents · Customers · Visitors

Parameter	Typ	Beschreibung
`entityId`	`Engine.Entity`	Entität mit einer Komponente `PERSON_CAPACITY`.
`landmark?`	`boolean`	Verwendet die Bezeichnung für Wahrzeichen.

Rückgabe string: „Residents“ bei Wohngebäuden, „Customers“ (bei Wahrzeichen „Visitors“) bei Gewerbe, „Workers“ bei Industrie (dt. „Einwohner“, „Kunden“, „Besucher“, „Arbeiter“).

Im Basisspiel verwendet: 3-mal in 2 Dateien

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

local title = entity_window_util.GetInhabitantsTitle(params.state.personCapacityEntity, true)

base/content/gui/gui/entity_window/town_building/town_building.tl:408

title = entity_window_util.GetInhabitantsTitle(entityId),

makeConfigureOnClickFunction(constructionEntity : Engine.Entity) : function() base/tealdef/gui/entity_window/entity_window_util.d.tl:263

Aufruf: entity_window_util.makeConfigureOnClickFunction(…)

Hinweise

Liefert einen Klick-Handler, der im Baumenü den Modul-Baukasten einer Konstruktion öffnet.

Parameter	Typ	Beschreibung
`constructionEntity`	`Engine.Entity`	Zu konfigurierende Konstruktions-Entität.

Rückgabe function(): Funktion, die nichts tut, wenn die Entität nicht mehr existiert oder nicht dem Spieler gehört.

Details

Der Handler löst die Events setModuleBuilderEntity und constructionMenuSetTab aus.

Im Basisspiel verwendet: 6-mal in 6 Dateien

base/content/gui/gui/entity_window/empty_construction/empty_construction.tl:49

onClick = entity_window_util.makeConfigureOnClickFunction(entityId),

base/content/gui/gui/entity_window/industry/industry.tl:417

onClick = entity_window_util.makeConfigureOnClickFunction(state:old().editConstructionEntity),

base/content/gui/gui/entity_window/maintenance_station/maintenance_station.tl:102

onClick = entity_window_util.makeConfigureOnClickFunction(extensionParams.state.constructionEntity),

base/content/gui/gui/entity_window/perk/perk.tl:121

onClick = entity_window_util.makeConfigureOnClickFunction(entityId),

base/content/gui/gui/entity_window/station_group/station_group.tl:1064

onClick = entity_window_util.makeConfigureOnClickFunction(constructionState:old().constructionEntity),

base/content/gui/gui/entity_window/warehouse/warehouse.tl:81

onClick = entity_window_util.makeConfigureOnClickFunction(constructionEntity),

makeRecipeAndParam<T>(recipe : Recipe<T>, param : T) : RecipeAndParamErased base/tealdef/gui/entity_window/entity_window_util.d.tl:264

Aufruf: entity_window_util.makeRecipeAndParam(…)

Hinweise

Bündelt ein Recipe und seinen Parameter zu einem RecipeAndParamErased.

Rückgabe RecipeAndParamErased: Das Bündel, z. B. für CombinedStockGroupedCountsParam.recipeAndParamInputCollapsible.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/entity_window/industry/industry_eow.script.tl:773

recipeAndParamInputCollapsible = entity_window_util.makeRecipeAndParam(

makeStockState(entity : Engine.Entity) : {CargoUtil.StockConfig} base/tealdef/gui/entity_window/entity_window_util.d.tl:265

Aufruf: entity_window_util.makeStockState(…)

Hinweise

Berechnet die Bestandskonfigurationen einer Entität, sortiert nach Bestandstyp.

Parameter	Typ	Beschreibung
`entity`	`Engine.Entity`	Entität, aus der die Komponente `STOCK_LIST` gelesen wird.

Rückgabe {CargoUtil.StockConfig}: Bestandskonfigurationen, oder nil, wenn die Entität keine Bestandsliste hat.

createStockIcon(stockConfigs : {CargoUtil.StockConfig}, entity : Engine.Entity) : TreeNodeId base/tealdef/gui/entity_window/entity_window_util.d.tl:266

Aufruf: entity_window_util.createStockIcon(…)

Hinweise

Baut Gütersymbole mit Mengen für Bestandskonfigurationen (Lagerbestände je Gütertyp, Ausgangsbestände mit der gelagerten Menge).

Parameter	Typ	Beschreibung
`stockConfigs`	`{CargoUtil.StockConfig}`	Bestandskonfigurationen, z. B. aus `makeStockState`.
`entity`	`Engine.Entity`	Entität, der die Bestände gehören.

Rückgabe TreeNodeId: Eine senkrechte Box mit einer Symbolzeile je Bestandskonfiguration.

getVehicleName(vehicleEntity : Engine.Entity) : string base/tealdef/gui/entity_window/entity_window_util.d.tl:267

Aufruf: entity_window_util.getVehicleName(…)

Hinweise

Liefert den Namen eines Fahrzeugs.

Rückgabe string: Der Name der Entität, oder „Invalid“ (dt. „Ungültig“), wenn sie keinen hat.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/entity_window/maintenance_station/maintenance_station_eow.script.tl:198

local aName = entity_window_util.getVehicleName(a)

getEntityLog(entity : Engine.Entity, logNames : {string}, refLogNames : {string}, keepEntries : integer, hideLogsNoChange : {string}, currentState? : EntityWindowUtil.EntityLog.LoggedState) : EntityWindowUtil.EntityLog base/tealdef/gui/entity_window/entity_window_util.d.tl:268

Aufruf: entity_window_util.getEntityLog(…)

Hinweise

Baut aus dem Logbuch einer Entität einen Änderungsverlauf (neueste zuerst).

Parameter	Typ	Beschreibung
`entity`	`Engine.Entity`	Entität mit einer Komponente `LOG_BOOK`.
`logNames`	`{string}`	Einfache Logbucheinträge, die gelesen werden.
`refLogNames`	`{string}`	Logbucheinträge, die je Referenz-Entität aufgezeichnet werden und gelesen werden sollen.
`keepEntries`	`integer`	Höchstzahl der zurückgegebenen Änderungen.
`hideLogsNoChange`	`{string}`	Log-Namen, deren Einträge übersprungen werden, wenn sich der Wert nicht geändert hat.
`currentState?`	`EntityWindowUtil.EntityLog.LoggedState`	Optionaler aktueller Wert, der als neuester Zustand angehängt wird.

Rückgabe EntityWindowUtil.EntityLog: Der Änderungsverlauf.

Details

Geloggte Werte werden durch 100 geteilt und gerundet. Aufeinanderfolgende Zustände mit gleichem Ort und Log werden zusammengefasst und ihre Dauern addiert. Das Fenster der Sim-Person (Verlauf der Zufriedenheit) und das Fahrzeugfenster (Wartungsverlauf) verwenden die Funktion.

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/entity_window/sim_person/sim_person_eow.script.tl:374

return entity_window_util.getEntityLog(params.personEntity, {happinessWalkLogName, happinessCarLogName, happinessResidentialLogName, happinessCommercialLogName,

base/content/gui/gui/entity_window/vehicle/vehicle_eow.script.tl:692

return entity_window_util.getEntityLog(params.vehicleEntity, {unmaintainedLogName}, {maintainedLogName}, 4, {}, currState)

isConstructionModifiableEngine(entity : Engine.Entity) : boolean base/tealdef/gui/entity_window/entity_window_util.d.tl:270

Aufruf: entity_window_util.isConstructionModifiableEngine(…)

Hinweise

Liefert, ob sich eine Konstruktion nach dem Bau noch ändern lässt.

Parameter	Typ	Beschreibung
`entity`	`Engine.Entity`	Konstruktions-Entität.

Rückgabe boolean: True, wenn die Konstruktion Modul-Slots hat oder einer ihrer Konstruktionsparameter postConstructionModifiable ist.

Details

Liefert false, wenn die Entität keine Konstruktionskomponente hat.

Im Basisspiel verwendet: 5-mal in 4 Dateien

base/content/gui/gui/entity_window/industry/industry.tl:186

if constructionEntity >= 0 and entity_window_util.isConstructionModifiableEngine(constructionEntity) then

base/content/gui/gui/entity_window/maintenance_station/maintenance_station.tl:33

if not entity_window_util.isConstructionModifiableEngine(constructionEntity) then

base/content/gui/gui/entity_window/station_group/station_group.tl:1028

isModifiable = entity_window_util.isConstructionModifiableEngine(constructionEntity),

base/content/gui/gui/entity_window/warehouse/warehouse.tl:76

actionButtonBar = entity_window_util.isConstructionModifiableEngine(constructionEntity) and entity_window_util.ActionButtonBar(react.ref(initialFocusRef), {

EntityWindowUtil.StockCountsWidgetParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:6

record StockCountsWidgetParams

Hinweise

Parameter von EntityWindowUtil.EntityStockCountsWidget.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:499

entity_window_util.EntityStockCountsWidget = react.RegisterRecipe("EntityStockCountsWidget", function(params : EntityWindowUtil.StockCountsWidgetParams) : TreeN

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Entität mit einer Bestandsliste (Komponente `STOCK_LIST`), deren Bestände angezeigt werden.
`width`	`integer`
`iconWidth`	`integer`
`maxIcons`	`integer`	Höchstzahl der Gütersymbole pro Zeile, bevor die Symbole auf zwei Zeilen umbrechen. Standard ist 5.
`groupStocks`	`boolean`	Wird an `cargo_util.calculateStockConfigs` übergeben und fasst Bestände zu gemeinsamen Einträgen zusammen.
`addDiscardCargoButtons`	`boolean`	Fügt jedem Bestand einen Papierkorb-Knopf hinzu. Er schickt einen Befehl `makeStockListDiscardCargoCmd`, der alle gelagerten Güter verwirft.
`addButtonsToSetStockCargoType`	`boolean`	Macht aus den Gütersymbolen Knöpfe, die den Bestand auf diesen Gütertyp festlegen (bei Beständen, die das erlauben). Die Festlegung steht im Konstruktionsparameter `tagToCargoType` und wird durch einen Neubau der Konstruktion übernommen.
`sortByType`	`boolean`	Wird an `cargo_util.calculateStockConfigs` übergeben und sortiert die Bestandseinträge nach Gütertyp.

EntityWindowUtil.DiagramType¶

enum base/tealdef/gui/entity_window/entity_window_util.d.tl:17

enum DiagramType

Hinweise

Datenquelle eines Diagramms in EntityWindowUtil.EntityDiagramWidget.

Im Basisspiel verwendet: 7-mal in 6 Dateien

base/content/gui/gui/entity_window/industry/industry_eow.script.tl:665

chartType : EntityWindowUtil.DiagramType

base/content/gui/gui/entity_window/line/line_eow.script.tl:258

chartType : EntityWindowUtil.DiagramType

base/content/gui/gui/entity_window/maintenance_station/maintenance_station_eow.script.tl:39

chartType : EntityWindowUtil.DiagramType

base/content/gui/gui/entity_window/station_group/station_group.tl:548

chartType : EntityWindowUtil.DiagramType

base/content/gui/gui/entity_window/vehicle/vehicle_eow.script.tl:777

chartType : EntityWindowUtil.DiagramType

base/content/gui/gui/entity_window/warehouse/warehouse_eow.script.tl:20

chartType : EntityWindowUtil.DiagramType

Wert	Beschreibung
`"logbook"`	Werte aus dem Logbuch der Entität, gelesen mit `api.engine.util.logbook.getChart`. Die x-Achse ist mit Jahren beschriftet.
`"logbookDiff"`	Differenzen der Logbuchwerte der Entität, gelesen mit `api.engine.util.logbook.getChartDiff`.
`"account"`	Kontodiagramm (Finanzen) der Entität, gelesen mit `api.engine.util.finance.getAccountChart`.

EntityWindowUtil.DiagramParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:22

record DiagramParams

Hinweise

Parameter von EntityWindowUtil.EntityDiagramWidget.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:868

local function getDiagramWidgetState(params : EntityWindowUtil.DiagramParams, numYearsToDisplay : integer) : DiagramWidgetState

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Entität, deren Logbuch oder Konto im Diagramm erscheint.
`logNames`	`{string}`	Namen der Logbucheinträge im Diagramm (je einer pro Datenreihe). Gilt für die Diagrammtypen `logbook` und `logbookDiff`.
`labels`	`{string}`	Beschriftungen der Datenreihen, auch in der Legende. Der Index entspricht der Datenreihe.
`colors`	`{Vec4f}`	Farben der Datenreihen (`Vec4f` RGBA), auch für die Balken der Legende.
`types`	`{Builtin.SeriesParam.Type}`	Darstellungsart je Datenreihe (z. B. `"BAR"`), Standard ist `"BAR"`. Balken werden 10 breit gezeichnet, andere Arten 2.
`styleClass`	`string`	Zusätzliche Style-Klasse für das Diagramm-Widget.
`chartType`	`DiagramType`	Datenquelle des Diagramms, siehe `EntityWindowUtil.DiagramType`.
`yMin`	`number`	Untere y-Grenze, die an `logbook.getChart` geht (nur beim Diagrammtyp `logbook`).
`yMax`	`number`	Obere y-Grenze, die an `logbook.getChart` geht (nur beim Diagrammtyp `logbook`).
`showTimeScaleSlider`	`boolean`	Zeigt einen Schieberegler „Time Scale“ (dt. „Zeitrahmen“), mit dem du wählst, wie viele Jahre angezeigt werden. Standard ist true. Er bleibt verborgen, wenn weniger als 4 Jahre angezeigt werden können.
`showLegend`	`boolean`	Zeigt die Legende (Beschriftung und Farbe je Datenreihe). Standard ist true.
`initialNumYearsToDisplay`	`integer`	Anzahl der Jahre, die anfangs angezeigt werden. Standard ist 5.
`minNumYearsToDisplay`	`integer`	Mindestzahl an Jahren (als `minCount` der Diagrammkonfiguration und als Grenze des Schiebereglers). Standard ist 3.
`maxNumYearsToDisplay`	`integer`	Obergrenze des Zeitrahmen-Schiebereglers in Jahren. Standard ist 50.
`legendOrientation`	`Builtin.Type.Orientation`	Ausrichtung des äußeren Box-Layouts des Widgets.
`yStepScale`	`number`	Wird, falls angegeben, als `yStepScale` der Diagrammkonfiguration gesetzt.
`currentValueFns`	`{function() : number}`	Optionale Funktionen, eine je Datenreihe, die den aktuellen Wert liefern. Das Ergebnis ersetzt den letzten Wert dieser Reihe (`api.engine.util.chart.setLastValue`), damit das Diagramm Live-Werte zeigt.
`focusSlider`	`boolean`	Bei true kann der Zeitrahmen-Schieberegler den Fokus von Gamepad oder Tastatur erhalten (das Diagramm dann nicht).

Funktionen

yAxisLabelFormatter(number) : string base/tealdef/gui/entity_window/entity_window_util.d.tl:32

Hinweise

Formatiert die Beschriftung der y-Achse. Standard ist lang_util.formatNumber(val, 0).

Rückgabe string

EntityWindowUtil.ActionBarButton¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:44

record ActionBarButton

Hinweise

Ein Knopf einer EntityWindowUtil.ActionButtonBar.

Im Basisspiel verwendet: 5-mal in 3 Dateien

base/content/gui/gui/entity_window/entity_window_util.tl:1116

local makeActionButtonElement = function(buttonParam : EntityWindowUtil.ActionBarButton, isPrimary : boolean) : TreeNodeId

base/content/gui/gui/entity_window/maintenance_station/maintenance_station.tl:82

local primaryButtons : {EntityWindowUtil.ActionBarButton} = {}

base/content/gui/gui/entity_window/vehicle/vehicle.tl:392

local primaryButtons : {EntityWindowUtil.ActionBarButton} = {}

Felder

Name	Typ	Beschreibung
`isSpacer`	`boolean`	Fügt statt eines Knopfs einen waagerechten Abstandhalter ein.
`icon`	`string`	Bildpfad des Knopfsymbols.
`description`	`string`	Knopftext bei primären Knöpfen, Tooltip bei sekundären Knöpfen.
`tag`	`string`	Tag am Knopf-Widget (dient zum Wiederfinden, z. B. durch das Anleitungssystem).
`customItem`	`TreeNodeId`	Fertiges Widget, das statt eines erzeugten Knopfs verwendet wird.
`sound`	`Sound`	Klickklang, siehe `EntityWindowUtil.ActionBarButton.Sound`.
`toggleButton`	`boolean`	Erzeugt statt eines normalen Knopfs einen Umschaltknopf. Verwende dazu `value` und `onValueChange`.
`value`	`boolean`	Aktueller Zustand eines Umschaltknopfs.

Funktionen

onClick() base/tealdef/gui/entity_window/entity_window_util.d.tl:54

Hinweise

Wird aufgerufen, wenn ein normaler Knopf (kein Umschaltknopf) geklickt wird.

onValueChange(boolean) base/tealdef/gui/entity_window/entity_window_util.d.tl:60

Hinweise

Wird mit dem neuen Zustand aufgerufen, wenn ein Umschaltknopf wechselt.

EntityWindowUtil.ActionBarButton.Sound¶

enum base/tealdef/gui/entity_window/entity_window_util.d.tl:45

enum Sound

Hinweise

Klangart eines Knopfs der Aktionsleiste (abgebildet auf die Style-Klassen buy-sfx, send-to-depot-sfx, sell-sfx).

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1122

local sound2style <total> : {EntityWindowUtil.ActionBarButton.Sound:string} = {

Wert	Beschreibung
`"Buy"`	Spielt den Kaufklang (Style-Klasse `buy-sfx`).
`"SendToDepot"`	Spielt den Klang „ins Depot schicken“ (Style-Klasse `send-to-depot-sfx`).
`"Sell"`	Spielt den Verkaufsklang (Style-Klasse `sell-sfx`).

EntityWindowUtil.ActionButtonBarParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:64

record ActionButtonBarParams

Hinweise

Parameter von EntityWindowUtil.ActionButtonBar.

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/gui/gui/entity_window/entity_window_util.tl:1187

entity_window_util.ActionButtonBar = react.RegisterRecipe("ActionButtonBar", function(param : EntityWindowUtil.ActionButtonBarParams) : TreeNodeId

base/content/gui/gui/entity_window/maintenance_station/maintenance_station.tl:185

local actionButtonBarParam : entity_window_util.ActionButtonBarParams = {

base/content/gui/gui/entity_window/vehicle/vehicle.tl:540

local actionButtonBarParam : entity_window_util.ActionButtonBarParams = {

Felder

Name	Typ	Beschreibung
`primaryButtons`	`{ActionBarButton}`	Knöpfe, die zuerst kommen, mit Symbol und Text (Style `primary`).
`secondaryButtons`	`{ActionBarButton}`	Knöpfe nur mit Symbol hinter einem Abstandhalter. Die Beschreibung erscheint als Tooltip (Style `secondary`).
`nextUpFocusRef`	`ReactRefWrap`	Widget-Referenz, die den Fokus erhält, wenn von der Leiste aus nach oben navigiert wird (`IA_NAV_UP`).

EntityWindowUtil.EntityWindowButtonParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:70

record EntityWindowButtonParams

Hinweise

Parameter von EntityWindowUtil.EntityWindowButton.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1103

entity_window_util.EntityWindowButton = react.RegisterRecipe("EntityWindowButton", function(params : EntityWindowUtil.EntityWindowButtonParams) : TreeNodeId

Felder

Name	Typ	Beschreibung
`tooltip`	`string`	Tooltip des Knopfs.
`icon`	`string`	Bildpfad des Knopfsymbols.

Funktionen

onClick() base/tealdef/gui/entity_window/entity_window_util.d.tl:73

Hinweise

Wird beim Klick auf den Knopf aufgerufen.

EntityWindowUtil.WorkplacesProgressBarWidgetParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:76

record WorkplacesProgressBarWidgetParams

Hinweise

Parameter von EntityWindowUtil.WorkplacesProgressBarWidget und EntityWindowUtil.PersonCapacityWidget.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1235

entity_window_util.WorkplacesProgressBarWidget = react.RegisterRecipe("WorkplacesProgressBarWidget", function(params : EntityWindowUtil.WorkplacesProgressBarWid

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Entität mit einer Komponente `PERSON_CAPACITY`.
`progressBarThresholds`	`{number}`	Schwellenmarken auf dem Fortschrittsbalken (Anteile von 0 bis 1).

EntityWindowUtil.SimPersonDestinationButtonParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:81

record SimPersonDestinationButtonParams

Hinweise

Parameter von EntityWindowUtil.SimPersonDestinationButton.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1310

entity_window_util.SimPersonDestinationButton = react.RegisterRecipe("SimPersonDestinationButton", function(params : EntityWindowUtil.SimPersonDestinationButton

Felder

Name	Typ	Beschreibung
`simPersonEntityId`	`Engine.Entity`	Entität der Sim-Person, deren Ziel angezeigt wird.
`destinationIndex`	`integer`	Note: this is a LandUseType
`addIconIfMissing`	`boolean`	Zeigt das Zielsymbol (ohne Knopf), wenn die Person kein solches Ziel hat.

EntityWindowUtil.InhabitantsTableParam¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:87

record InhabitantsTableParam

Hinweise

Parameter von EntityWindowUtil.InhabitantsTable.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1511

entity_window_util.InhabitantsTable = react.RegisterRecipe("InhabitantsTable", function(param : EntityWindowUtil.InhabitantsTableParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`landmark`	`boolean`	Verwendet bei leerer Tabelle den Hinweistext für Wahrzeichen („... enable residents to visit it“).
`headquarters`	`boolean`	Verwendet bei leerer Tabelle den Hinweistext für das Hauptquartier („... allow residents to work here“).
`personCapacityEntityId`	`Engine.Entity`	Entität mit einer Komponente `PERSON_CAPACITY`, deren Sim-Personen aufgelistet werden.

EntityWindowUtil.WorkersTableParam¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:93

record WorkersTableParam

Hinweise

Parameter von EntityWindowUtil.WorkersTable.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1602

entity_window_util.WorkersTable = react.RegisterRecipe("WorkersTable", function(param : EntityWindowUtil.WorkersTableParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`personCapacityEntityId`	`Engine.Entity`	Entität, deren Besucher (aus `industry_productivity_util.getVisitors`) aufgelistet werden.

EntityWindowUtil.DestinationIconParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:97

record DestinationIconParams

Hinweise

Parameter von EntityWindowUtil.GetDestinationIcon.

Felder

Name	Typ	Beschreibung
`destinationIndex`	`integer`	Ziel, dessen Symbol erscheint (0 Wohnsitz, 1 Einkaufen, 2 Arbeit, passend zum Flächennutzungstyp).
`iconClass`	`string`	Style-Klasse des Symbols.
`tooltipOverride`	`string`	Tooltip anstelle des Standardtexts „Home“ / „Shop“ / „Work“ (dt. „Wohnsitz“ / „Einkaufen“ / „Arbeit“).

EntityWindowUtil.PassengerWidgetParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:103

record PassengerWidgetParams

Hinweise

Parameter von EntityWindowUtil.PassengersWidget.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1659

entity_window_util.PassengersWidget = react.RegisterRecipe("PassengersWidget", function(vehicleEntity : EntityWindowUtil.PassengerWidgetParams) : TreeNodeId

Felder

Name	Typ	Beschreibung
`vehicleEntity`	`Engine.Entity`	Fahrzeug, dessen Passagiere aufgelistet werden.

EntityWindowUtil.VehicleTableColumn¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:107

record VehicleTableColumn

Hinweise

Spaltendefinition einer EntityWindowUtil.VehicleTable.

Felder

Name	Typ	Beschreibung
`name`	`string`	Text der Spaltenüberschrift.
`recipe`	`Recipe<Builtin.TableCellParam>`	Recipe der Zelle. Der `rowKey` der Zelle ist die Fahrzeug-Entität (z. B. `EntityWindowUtil.VehicleCell`).
`headerStyleClass`	`string`	Style-Klasse der Spaltenüberschrift. `EntityWindowUtil.VehicleTable` gibt sie nicht an die Tabelle weiter.
`weight`	`number`	Breitengewicht der Spalte. `EntityWindowUtil.VehicleTable` gibt es nicht an die Tabelle weiter.

Funktionen

sortOrder(Engine.Entity, Engine.Entity) : boolean base/tealdef/gui/entity_window/entity_window_util.d.tl:110

Hinweise

Vergleich zweier Fahrzeug-Entitäten, wenn die Tabelle nach dieser Spalte sortiert wird.

Rückgabe boolean

EntityWindowUtil.VehicleTableParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:115

record VehicleTableParams

Hinweise

Parameter von EntityWindowUtil.VehicleTable.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/maintenance_station/maintenance_station_eow.script.tl:189

local vehicleTableParams : entity_window_util.VehicleTableParams = {

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Entität, die an `getVehicleEntities` geht, z. B. eine Linie oder ein Depot.
`columns`	`{VehicleTableColumn}`	Tabellenspalten.

Funktionen

getVehicleEntities(Engine.Entity) : {Engine.Entity} base/tealdef/gui/entity_window/entity_window_util.d.tl:117

Hinweise

Liefert die Fahrzeuge (Tabellenzeilen) zu entityId und wird in jedem Schritt abgefragt.

Rückgabe {Engine.Entity}

EntityWindowUtil.VehicleConditionParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:125

record VehicleConditionParams

Hinweise

Parameter von EntityWindowUtil.VehicleCondition.

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Fahrzeug (oder Linie), das an `vehicle_util.getAvgMaintenanceState` geht.
`addIcon`	`boolean`	Zeigt vor dem Balken ein Werkzeugsymbol.

EntityWindowUtil.MaintenanceStationPoolProgressBarParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:132

record MaintenanceStationPoolProgressBarParams

Hinweise

Parameter von EntityWindowUtil.MaintenanceStationPoolProgressBar.

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Wartungsgebäude (Entität mit einer Komponente `VEHICLE_DEPOT`).

EntityWindowUtil.SubconstructionBalanceParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:136

record SubconstructionBalanceParams

Hinweise

Parameter von EntityWindowUtil.SubconstructionBalance.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:2168

entity_window_util.SubconstructionBalance = react.RegisterRecipe("SubconstructionBalance", function(params : EntityWindowUtil.SubconstructionBalanceParams) : Tr

Felder

Name	Typ	Beschreibung
`entityId`	`Engine.Entity`	Unterkonstruktion. Angezeigt wird der Ertrag ihrer übergeordneten Konstruktion.
`stepTimer`	`boolean`	Fragt mit `useStepStateTimer` ab statt in jedem Schritt.
`maintenanceType`	`JournalEntry.Maintenance`	Typ des Wartungs-Journaleintrags, der an `api.engine.util.finance.calculateBalance` geht.

EntityWindowUtil.SendCommandButtonParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:142

record SendCommandButtonParams

Hinweise

Parameter von EntityWindowUtil.SendCommandButton.

Felder

Name	Typ	Beschreibung
`iconPath`	`string`	Bildpfad des Knopfsymbols.
`tooltip`	`string \| function() : string`	Tooltip-Text oder eine Funktion, die ihn liefert.
`isPrimary`	`boolean`	Verwendet den Knopf-Style `primary`.
`tag`	`string`	Tag am Knopf-Widget.

Funktionen

makeCommand() : Command<ICommandData> base/tealdef/gui/entity_window/entity_window_util.d.tl:145

Hinweise

Baut den Befehl, der beim Klick auf den Knopf abgeschickt wird.

Rückgabe Command<ICommandData>

isActive() : boolean base/tealdef/gui/entity_window/entity_window_util.d.tl:146

Hinweise

Liefert, ob der Knopf aktiv ist, und wird in jedem Schritt abgefragt. Ohne diese Funktion ist der Knopf immer aktiv.

Rückgabe boolean

EntityWindowUtil.RecipeAndParamErased¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:151

record RecipeAndParamErased

Hinweise

Ein Recipe zusammen mit seinem Parameter, dessen Typ gelöscht ist. Erzeugt mit EntityWindowUtil.makeRecipeAndParam.

Im Basisspiel verwendet: 2-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:25

entity_window_util.makeRecipeAndParam = function<T>(recipe : Recipe<T>, param : T) : EntityWindowUtil.RecipeAndParamErased

Felder

Name	Typ	Beschreibung
`recipe`	`Recipe<any>`	Das Recipe.
`param`	`any`	Parameter, mit dem das Recipe aufgerufen wird.

EntityWindowUtil.EntityLog¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:156

record EntityLog

Hinweise

Änderungsverlauf, den EntityWindowUtil.getEntityLog aus dem Logbuch einer Entität baut.

Im Basisspiel verwendet: 4-mal in 3 Dateien

base/content/gui/gui/entity_window/entity_window_util.tl:2519

hideLogsNoChange : {string}, currentState? : EntityWindowUtil.EntityLog.LoggedState) : EntityWindowUtil.EntityLog

base/content/gui/gui/entity_window/sim_person/sim_person_eow.script.tl:314

local state = engine_react_util.useStepState(function() : EntityWindowUtil.EntityLog

base/content/gui/gui/entity_window/vehicle/vehicle_eow.script.tl:684

local state = engine_react_util.useStepState(function() : EntityWindowUtil.EntityLog

Felder

Name	Typ	Beschreibung
`entries`	`{Entry}`	Änderungen, die neueste zuerst.

EntityWindowUtil.EntityLog.Entry¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:157

record Entry

Hinweise

Eine Änderung in einem EntityWindowUtil.EntityLog.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:2606

local entry : EntityWindowUtil.EntityLog.Entry = {

Felder

Name	Typ	Beschreibung
`durationSeconds`	`integer`	Dauer des vorherigen Zustands vor dieser Änderung in Sekunden (Spielzeit).
`change`	`integer`	Änderung des geloggten Werts (in Zehntelprozent).
`logName`	`string`	Name des Logbucheintrags der Änderung.
`place`	`Engine.Entity`	Referenz-Entität, für die die Änderung geloggt wurde. -1 bei Einträgen der einfachen Logs (ohne Referenz).

EntityWindowUtil.EntityLog.LoggedState¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:163

record LoggedState

Hinweise

Ein geloggter Wert. Wird intern verwendet und als optionaler aktueller Zustand an getEntityLog übergeben.

Im Basisspiel verwendet: 6-mal in 3 Dateien

base/content/gui/gui/entity_window/entity_window_util.tl:2519

hideLogsNoChange : {string}, currentState? : EntityWindowUtil.EntityLog.LoggedState) : EntityWindowUtil.EntityLog

base/content/gui/gui/entity_window/sim_person/sim_person_eow.script.tl:315

local getCurrentState = function() : EntityWindowUtil.EntityLog.LoggedState

base/content/gui/gui/entity_window/vehicle/vehicle_eow.script.tl:687

local currState : EntityWindowUtil.EntityLog.LoggedState = {

Felder

Name	Typ	Beschreibung
`time`	`integer`	Spielzeit des Werts in Millisekunden. Bei nil wird die aktuelle Spielzeit eingetragen.
`place`	`Engine.Entity`	Referenz-Entität des Werts, -1 bei einfachen Logs.
`logName`	`string`	Name des Logbucheintrags.
`state`	`integer`	10x percent

EntityWindowUtil.MaintenanceBarParam¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:172

record MaintenanceBarParam

Hinweise

Parameter von EntityWindowUtil.MaintenanceBar.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:143

entity_window_util.MaintenanceBar = react.RegisterRecipe("MaintenanceBar", function(param : EntityWindowUtil.MaintenanceBarParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`entity`	`Engine.Entity`	Entität, deren Kosten angezeigt werden. Eine Stationsgruppe (Unterhalt), ein Transportfahrzeug (Betriebskosten) oder eine Konstruktion bzw. Unterkonstruktion (Unterhalt der Konstruktion).
`maintenancePeriodText`	`string`	Text des Zeitraums hinter den Kosten, wie in `"{maintenanceCost}/{maintenancePeriod}"`.
`initialCalloutText`	`string`	Anfangstext der Info-Blase (Callout) um den Balken.
`gameCtx`	`GameContext`	Spielkontext, wird an das Info-Callout weitergegeben.
`showOnRightSide`	`boolean`	Zeigt die Info-Blase auf der rechten Seite.
`nextUpFocusRef`	`ReactRefWrap`	Widget-Referenz, die den Fokus erhält, wenn nach oben navigiert wird (`IA_NAV_UP`).

EntityWindowUtil.CombinedStockGroupedCountsParam¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:182

record CombinedStockGroupedCountsParam

Hinweise

Parameter von EntityWindowUtil.CombinedStockGroupedCounts.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:732

entity_window_util.CombinedStockGroupedCounts = react.RegisterRecipe("CombinedStockGroupedCounts", function(param : EntityWindowUtil.CombinedStockGroupedCountsP

Felder

Name	Typ	Beschreibung
`initialCalloutTextInputPermanent`	`string`	Text der Info-Blase (Callout) am immer sichtbaren Teil der Karte „Input Stocks“ (dt. „Eingangsbestände“).
`initialCalloutTextInputCollapsible`	`string`	Text der Info-Blase am einklappbaren Teil der Karte „Input Stocks“.
`recipeAndParamInputCollapsible`	`RecipeAndParamErased`	Inhalt des einklappbaren Teils der Karte „Input Stocks“.
`initialCalloutTextOutputPermanent`	`string`	Text der Info-Blase (Callout) am immer sichtbaren Teil der Karte „Output Stocks“ (dt. „Ausgangsbestände“).
`initialCalloutTextOutputCollapsible`	`string`	Text der Info-Blase am einklappbaren Teil der Karte „Output Stocks“.
`recipeAndParamOutputCollapsible`	`RecipeAndParamErased`	Inhalt des einklappbaren Teils der Karte „Output Stocks“.
`cardKey`	`string`	Schlüsselpräfix der beiden Karten. Angehängt wird `"-Input"` bzw. `"-Output"`.
`gameCtx`	`GameContext`	Spielkontext, wird an die Inhaltskarten weitergegeben.
`showOnRightSide`	`boolean`	Zeigt die Info-Blasen auf der rechten Seite.
`showSimplifiedOnly`	`boolean`	Zeigt je Karte nur die ausgeklappte Bestandstabelle, ohne Kompaktansicht und ohne einklappbaren Teil.
`entityId`	`Engine.Entity`	Entität mit einer Bestandsliste, z. B. eine Industrie.

Funktionen

setCollapsibleExpanded(string, boolean) base/tealdef/gui/entity_window/entity_window_util.d.tl:192

Hinweise

Wird mit dem Kartenschlüssel und dem neuen Zustand aufgerufen, wenn ein einklappbarer Teil auf- oder zugeklappt wird.

getCollapsibleExpanded(string) base/tealdef/gui/entity_window/entity_window_util.d.tl:193

Hinweise

Liefert den gespeicherten Aufklappzustand zu einem Kartenschlüssel.

EntityWindowUtil.IconQualityType¶

enum base/tealdef/gui/entity_window/entity_window_util.d.tl:201

enum IconQualityType

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Wert	Beschreibung
`"Happy"`
`"Aloof"`
`"Sad"`
`"Positive"`
`"Negative"`

EntityWindowUtil.RatingBarParam¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:208

record RatingBarParam

Hinweise

Parameter von EntityWindowUtil.RatingBar.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:33

entity_window_util.RatingBar = react.RegisterRecipe("RatingBar", function(param : EntityWindowUtil.RatingBarParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`icon`	`TreeNodeId`	Fertiges Symbol-Widget vor dem Balken (hat Vorrang vor `iconPath`).
`iconPath`	`string`	Bildpfad des Symbols, verwendet, wenn `icon` nicht gesetzt ist.
`tooltip`	`string`	Tooltip des Symbols, das aus `iconPath` gebaut wird.
`ratingText`	`string`	Text hinter dem Balken.
`barTooltip`	`string`	Tooltip des Balkens.
`value`	`number`	Bewertung von 0 bis 1.
`valueChange`	`number`	Trend. Zeichnet einen Pfeil (je nach Größe eine bis drei Stufen, Schwellen 0,01 und 0,1), der bei positiven Werten nach rechts und bei negativen nach links zeigt.
`numFractions`	`integer`	Anzahl der Segmente des Balkens, muss größer als 0 sein.
`snapValueToFractions`	`boolean`	Rundet den angezeigten Wert auf die Segmente.
`hideText`	`boolean`	Blendet den Bewertungstext aus.
`showIcon`	`boolean`	Zeigt das Symbol. Ohne `true` erscheint das Symbol nicht.

Funktionen

getRatingLabel(RatingLevel) : string base/tealdef/gui/entity_window/entity_window_util.d.tl:213

Hinweise

Baut den Text aus der Bewertungsstufe (town_util.getFactorRatingLevel(value)), wenn ratingText nicht gesetzt ist.

Rückgabe string

onClick() base/tealdef/gui/entity_window/entity_window_util.d.tl:219

Hinweise

Macht den Balken zu einem Knopf, der diese Funktion aufruft.

EntityWindowUtil.NoiseAndPollutionParams¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:224

record NoiseAndPollutionParams

Hinweise

Parameter von EntityWindowUtil.NoiseAndPollution.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:2491

entity_window_util.NoiseAndPollution = react.RegisterRecipe("NoiseAndPollution", function(params : EntityWindowUtil.NoiseAndPollutionParams) : TreeNodeId

Felder

Name	Typ	Beschreibung
`noise`	`integer`	Lärmwert, angezeigt als „Current Noise“.
`pollution`	`integer`	Verschmutzungswert, angezeigt als „Current Pollution“.

EntityWindowUtil.ProgressDisplayParam¶

record base/tealdef/gui/entity_window/entity_window_util.d.tl:229

record ProgressDisplayParam

Hinweise

Parameter von EntityWindowUtil.ProgressDisplay.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/entity_window/entity_window_util.tl:1810

entity_window_util.ProgressDisplay = react.RegisterRecipe("ProgressDisplay", function(param : EntityWindowUtil.ProgressDisplayParam) : TreeNodeId

Felder

Name	Typ	Beschreibung
`path`	`string`	Bildpfad eines Symbols vor dem Balken.
`text`	`string`	optional
`tooltip`	`string`	Tooltip von Symbol und Balken.
`value`	`number`	Füllung des Balkens von 0 bis 1.
`extraValue`	`number`	optional
`trend`	`number`	optional
`extraChild`	`TreeNodeId`	optional