statistics_react_util¶

Quelle: base/tealdef/gui/statistics/statistics_react_util.d.tl

Hinweise

Gemeinsame Helfer der Statistik-Tabs (Filterleisten, Suchfeld, Güterspalten, Problemspalte), geladen mit ug_require "/gui/statistics/statistics_react_util.tl".

StatisticsReactUtil¶

record global base/tealdef/gui/statistics/statistics_react_util.d.tl:3

global record StatisticsReactUtil

Laden: local statistics_react_util = ug_require "::/gui/statistics/statistics_react_util.tl" as StatisticsReactUtil

Hinweise

Helfer für die Statistik-Tabs.

Felder

Name	Typ	Beschreibung
`ProblemsCell`	`Recipe<Builtin.TableCellParam>`	Tabellenzelle mit einem Warn-Icon (bei mehreren mit Anzahl) für die „Problem“-Benachrichtigungen der Entität in dieser Zeile. Ein Klick darauf führt die Klickaktion der Benachrichtigung aus.Im Spiel Es gibt mehrere ProblemeIm Code: There Are Several Problems 6-mal im Basisspiel verwendet

Funktionen

calculateCargoColumnData(cargoTypeInfos : {CargoUtil.CargoTypeInfo}) : CargoColumnData base/tealdef/gui/statistics/statistics_react_util.d.tl:17

Aufruf: statistics_react_util.calculateCargoColumnData(…)

Hinweise

Summiert Infos zu Güterarten zu Spaltendaten. Werte von -1 (unbekannt) werden übersprungen.

Rückgabe CargoColumnData

calculateCargoColumnDataForVehicle(vehicleEntity : Engine.Entity) : CargoColumnData base/tealdef/gui/statistics/statistics_react_util.d.tl:18

Aufruf: statistics_react_util.calculateCargoColumnDataForVehicle(…)

Hinweise

Berechnet die Spaltendaten eines Fahrzeugs aus den Güterarten, die es befördert oder befördern kann.

Parameter	Typ	Beschreibung
`vehicleEntity`	`Engine.Entity`	Entitäts-Id des Fahrzeugs.

Rückgabe CargoColumnData

Im Basisspiel verwendet: 8-mal in 1 Datei

base/content/gui/gui/statistics/statistic_vehicles.tl:110

return statistics_react_util.calculateCargoColumnDataForVehicle(entity)

calculateCargoColumnDataForLine(lineEntity : Engine.Entity) : CargoColumnData base/tealdef/gui/statistics/statistics_react_util.d.tl:19

Aufruf: statistics_react_util.calculateCargoColumnDataForLine(…)

Hinweise

Berechnet die Spaltendaten einer Linie aus den Güterarten ihrer Fahrzeuge.

Parameter	Typ	Beschreibung
`lineEntity`	`Engine.Entity`	Entitäts-Id der Linie.

Rückgabe CargoColumnData

Im Basisspiel verwendet: 10-mal in 2 Dateien

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:3943

return statistics_react_util.calculateCargoColumnDataForLine(params.lineEntity).demand

base/content/gui/gui/statistics/statistic_lines.tl:99

return statistics_react_util.calculateCargoColumnDataForLine(entity).supply

getStationGroupType(Engine.Entity) : StationGroupType base/tealdef/gui/statistics/statistics_react_util.d.tl:21

Aufruf: statistics_react_util.getStationGroupType(…)

Hinweise

Stellt fest, ob eine Stationsgruppe Passagierstationen, Güterstationen oder beides hat.

Parameter	Typ	Beschreibung
`#1`	`Engine.Entity`	Entitäts-Id der Stationsgruppe.

Rückgabe StationGroupType: Der Typ, oder nil, wenn die Gruppe keines von beiden hat.

Im Basisspiel verwendet: 3-mal in 1 Datei

base/content/gui/gui/statistics/statistic_stations.tl:97

return statistics_react_util.getStationGroupType(entity)

createFocusBar(children : {TreeNodeId}, focusFilters? : function(), defocusFilter? : function(), iaCompRef? : ReactRefWrap, withoutHint? : boolean) : TreeNodeId base/tealdef/gui/statistics/statistics_react_util.d.tl:30

Aufruf: statistics_react_util.createFocusBar(…)

Hinweise

Packt Buttons in eine waagrechte Filterleiste, die sich mit der Eingabeaktion IA_OPTION2 fokussieren und mit IA_OPTION2 oder IA_BACK wieder verlassen lässt.

Parameter	Typ	Beschreibung
`children`	`{TreeNodeId}`	Buttons der Leiste.
`focusFilters?`	`function()`	Wird von `IA_OPTION2` aufgerufen, um die Leiste zu fokussieren.
`defocusFilter?`	`function()`	Wird von `IA_OPTION2` oder `IA_BACK` aufgerufen, solange die Leiste den Fokus hat.
`iaCompRef?`	`ReactRefWrap`	Referenz für die Eingabeaktions-Komponente der Leiste.
`withoutHint?`	`boolean`	Wenn gesetzt, erscheint kein Tastenhinweis.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/statistics/statistics.tl:586

statistics_react_util.createFocusBar({builtin.ToggleButton{

createCarrierCategoryFilter({StatisticsRecipeParams.Category}, StatisticsRecipeParams.OnlyVisible, oldState : (function() : FilterState), transformState : function(function(FilterState) : FilterState), focusFilters? : function(), defocusFilter? : function(), iaCompRef? : ReactRefWrap) : TreeNodeId base/tealdef/gui/statistics/statistics_react_util.d.tl:32

Aufruf: statistics_react_util.createCarrierCategoryFilter(…)

Hinweise

Erzeugt die Filterleiste eines Tabs mit einem Toggle-Button pro Kategorie und, wenn eine OnlyVisible-Art angegeben ist, dem Schalter „nur sichtbare zeigen“.

Im Spiel Nur sichtbare {object} anzeigenIm Code: Show Only Visible {object}

Parameter	Typ	Beschreibung
`#1`	`{StatisticsRecipeParams.Category}`	Kategorien des Tabs.
`#2`	`StatisticsRecipeParams.OnlyVisible`	Objektart für den Schalter „nur sichtbare zeigen“, oder `nil`.
`oldState`	`(function() : FilterState)`	Gibt den aktuellen Filterzustand zurück.
`transformState`	`function(function(FilterState) : FilterState)`	Wendet eine Änderung auf den Filterzustand an.
`focusFilters?`	`function()`	Siehe `createFocusBar`.
`defocusFilter?`	`function()`	Siehe `createFocusBar`.
`iaCompRef?`	`ReactRefWrap`	Siehe `createFocusBar`.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:1781

child = statistics_react_util.createCarrierCategoryFilter(

base/content/gui/gui/statistics/statistics.tl:571

filterBar = statistics_react_util.createCarrierCategoryFilter(currentTabFilterConfig.categories, currentTabFilterConfig.onlyVisible, oldState, transform, focusF

createSearchField(value : string, set : function(string), focusNode : ReactRefWrap) : TreeNodeId base/tealdef/gui/statistics/statistics_react_util.d.tl:34

Aufruf: statistics_react_util.createSearchField(…)

Hinweise

Erzeugt das Suchfeld eines Tabs.

Im Spiel Suche...Im Code: Search...

Parameter	Typ	Beschreibung
`value`	`string`	Aktueller Text.
`set`	`function(string)`	Wird beim Tippen mit dem Text aufgerufen.
`focusNode`	`ReactRefWrap`	Node, der den Fokus bekommt, wenn die Eingabe abgebrochen wird.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:5842

not params.commonParams.gamepadInputModeState:old() and statistics_react_util.createSearchField(

base/content/gui/gui/statistics/statistics.tl:551

searchField = statistics_react_util.createSearchField(currentTabFilterState.search, set, nil)

createFocusDummyForGamepad() : TreeNodeId base/tealdef/gui/statistics/statistics_react_util.d.tl:35

Aufruf: statistics_react_util.createFocusDummyForGamepad(…)

Hinweise

Erzeugt eine leere, fokussierbare Komponente als Inhalt von Tabellenzellen, damit der Gamepad-Fokus auch über leere Zellen wandern kann.

Rückgabe TreeNodeId

Im Basisspiel verwendet: 14-mal in 5 Dateien

base/content/gui/gui/statistics/statistic_depots.tl:39

} or statistics_react_util.createFocusDummyForGamepad(),

base/content/gui/gui/statistics/statistic_industries.tl:102

content = statistics_react_util.createFocusDummyForGamepad()

base/content/gui/gui/statistics/statistic_lines.tl:54

} or statistics_react_util.createFocusDummyForGamepad(),

base/content/gui/gui/statistics/statistic_stations.tl:54

(townState:old() ~= -1) and line_react_util.NameTextView{ entity = townState:old(), locationButton = true } or statistics_react_util.createFocusDummyForGamepad(

base/content/gui/gui/statistics/statistic_vehicles.tl:90

content = statistics_react_util.createFocusDummyForGamepad()

compareProblemsLess(notificationsState : {Engine.Entity : {integer}}, entity1 : Engine.Entity, entity2 : Engine.Entity) : boolean base/tealdef/gui/statistics/statistics_react_util.d.tl:42

Aufruf: statistics_react_util.compareProblemsLess(…)

Hinweise

Sortiervergleich für die Problemspalte. Eine Entität mit weniger „Problem“-Benachrichtigungen kommt zuerst.

Parameter	Typ	Beschreibung
`notificationsState`	`{Engine.Entity : {integer}}`	Ids der dauerhaften Benachrichtigungen pro Entität.
`entity1`	`Engine.Entity`	Erste Entität.
`entity2`	`Engine.Entity`	Zweite Entität.

Rückgabe boolean

get value usable to for sorting (so that number of notifiaction is most significant)

getProblemsCompareValue(notificationsState : {Engine.Entity : {integer}}, entity : Engine.Entity) : {integer, {integer}} base/tealdef/gui/statistics/statistics_react_util.d.tl:45

Aufruf: statistics_react_util.getProblemsCompareValue(…)

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Rückgabe {integer, {integer}}

Im Basisspiel verwendet: 6-mal in 6 Dateien

base/content/gui/gui/statistics/statistic_industries.tl:401

return statistics_react_util.getProblemsCompareValue(tableState:old().notificationsState or {}, warehouseEntity)

base/content/gui/gui/statistics/statistic_lines.tl:400

return statistics_react_util.getProblemsCompareValue(tableState:old().notificationsState or {}, lineEntity)

base/content/gui/gui/statistics/statistic_stations.tl:278

return statistics_react_util.getProblemsCompareValue(tableState:old().notificationsState or {}, stationGroupEntity)

base/content/gui/gui/statistics/statistic_towns.tl:493

return statistics_react_util.getProblemsCompareValue(tableState:old().notificationsState or {}, lineEntity)

base/content/gui/gui/statistics/statistic_vehicles.tl:355

return statistics_react_util.getProblemsCompareValue(tableState:old().notificationsState or {}, vehicleEntity)

base/content/gui/gui/statistics/statistic_warehouses.tl:317

return statistics_react_util.getProblemsCompareValue(tableState:old().notificationsState or {}, warehouseEntity)

getCarrierFilterFromCategories(allCategories : {StatisticsRecipeParams.Category}, activeCategories : {integer : boolean}) : {Carrier} base/tealdef/gui/statistics/statistics_react_util.d.tl:49

Aufruf: statistics_react_util.getCarrierFilterFromCategories(…)

Hinweise

Sammelt die Verkehrsträger der aktiven Kategorien.

Parameter	Typ	Beschreibung
`allCategories`	`{StatisticsRecipeParams.Category}`	Kategorien des Tabs.
`activeCategories`	`{integer : boolean}`	Aktive Kategorien, nach Index.

Rückgabe {Carrier}: Die Verkehrsträger, oder nil, wenn keine Kategorie aktiv ist oder eine aktive Kategorie keinen Verkehrsträger hat.

Im Basisspiel verwendet: 8-mal in 6 Dateien

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:2540

local allowedCarriers = statistics_react_util.getCarrierFilterFromCategories(filterCategories, filterShowCategories)

base/content/gui/gui/statistics/statistic_depots.tl:238

local allowedCarriers  = statistics_react_util.getCarrierFilterFromCategories(categories, params.filterShowCategories)

base/content/gui/gui/statistics/statistic_lines.tl:317

local allowedCarriers = statistics_react_util.getCarrierFilterFromCategories(categories, params.filterShowCategories)

base/content/gui/gui/statistics/statistic_stations.tl:342

local allowedCarriers  = statistics_react_util.getCarrierFilterFromCategories(categories, params.filterShowCategories)

base/content/gui/gui/statistics/statistic_vehicles.tl:424

local allowedCarriers  = statistics_react_util.getCarrierFilterFromCategories(categories, params.filterShowCategories)

base/content/gui/gui/statistics/statistics.tl:304

carriers = statistics_react_util.getCarrierFilterFromCategories(filterConfig.categories, filterState.category)

areCarriersContainedInTransportModes(transportModes : {TransportMode : boolean}, carriers : {Carrier}) : boolean base/tealdef/gui/statistics/statistics_react_util.d.tl:51

Aufruf: statistics_react_util.areCarriersContainedInTransportModes(…)

Hinweise

Prüft, ob eine der aktiven Transportarten zu einem der angegebenen Verkehrsträger gehört.

Parameter	Typ	Beschreibung
`transportModes`	`{TransportMode : boolean}`	Transportarten, die darauf zeigen, ob sie aktiv sind.
`carriers`	`{Carrier}`	Gesuchte Verkehrsträger.

Rückgabe boolean

Im Basisspiel verwendet: 7-mal in 3 Dateien

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:1678

if not allowedCarriers or statistics_react_util.areCarriersContainedInTransportModes(depot.transportModes, allowedCarriers) then

base/content/gui/gui/statistics/statistic_depots.tl:241

if not statistics_react_util.areCarriersContainedInTransportModes(vehicleDepot.transportModes, allowedCarriers) then

base/content/gui/gui/statistics/statistics.tl:379

return statistics_react_util.areCarriersContainedInTransportModes(vehicleDepot.transportModes, carriers)

StatisticsReactUtil.StationGroupType¶

enum base/tealdef/gui/statistics/statistics_react_util.d.tl:4

enum StationGroupType

Hinweise

Art einer Stationsgruppe, nach den Stationen, die sie enthält.

Im Basisspiel verwendet: 5-mal in 2 Dateien

base/content/gui/gui/statistics/statistic_stations.tl:80

local getStationGroupTypeLabel = function(groupType : StatisticsReactUtil.StationGroupType) : string

base/content/gui/gui/statistics/statistics_react_util.tl:13

statistics_react_util.getStationGroupType = function(entity : Engine.Entity) : StatisticsReactUtil.StationGroupType

Wert	Beschreibung
`"Passenger"`	Nur Passagierstationen.Im Spiel PassagiereIm Code: Passenger
`"Cargo"`	Nur Güterstationen.Im Spiel GüterIm Code: Cargo
`"Mixed"`	Passagier- und Güterstationen.Im Spiel GemischtIm Code: Mixed

StatisticsReactUtil.CargoColumnData¶

record base/tealdef/gui/statistics/statistics_react_util.d.tl:10

record CargoColumnData

Hinweise

Summierte Ladewerte für die Spalten „Load“, „Capacity“, „Utilization“ und „Satisfaction“.

Im Basisspiel verwendet: 15-mal in 4 Dateien

base/content/gui/gui/statistics/statistic_towns.tl:147

local calculateCargoColumnData = function(cargoData : {CargoInfo}) : StatisticsReactUtil.CargoColumnData

base/content/gui/gui/statistics/statistic_vehicles.tl:109

local calculateCargoColumnDataForVehicleState = function() : StatisticsReactUtil.CargoColumnData

base/content/gui/gui/statistics/statistic_warehouses.tl:118

local calculateCargoColumnDataFromEntity = function(entity: Engine.Entity) : StatisticsReactUtil.CargoColumnData

base/content/gui/gui/statistics/statistics_react_util.tl:194

statistics_react_util.calculateCargoColumnData = function(cargoTypeInfos : {cargo_util.CargoTypeInfo}) : StatisticsReactUtil.CargoColumnData

Felder

Name	Typ	Beschreibung
`supply`	`integer`	Summe der Gütermengen (Ladung).
`demand`	`integer`	Summe der Kapazitäten.
`coverage`	`number`	`supply / demand` (Auslastung). `0`, wenn `supply` 0 ist.
`averageQuality`	`number`	Mittelwert der bekannten Durchschnittsqualitäten der Güterarten.

StatisticsReactUtil.FilterState¶

record base/tealdef/gui/statistics/statistics_react_util.d.tl:23

record FilterState

Hinweise

Filtereinstellungen eines Statistik-Tabs.

Im Basisspiel verwendet: 33-mal in 3 Dateien

base/content/gui/gui/line_vehicle_mgmt/manager_window.tl:1567

filterState : ReactStateT<StatisticsReactUtil.FilterState>

base/content/gui/gui/statistics/statistics.tl:31

storeFilterStates : function({StatisticsRecipeParams.TabKey : StatisticsReactUtil.FilterState})

base/content/gui/gui/statistics/statistics_react_util.tl:124

oldState : (function() : StatisticsReactUtil.FilterState),

Felder

Name	Typ	Beschreibung
`category`	`{integer : boolean}`	Aktive Kategorie-Buttons, nach Kategorieindex.
`onlyVisible`	`boolean`	Ob der Schalter „nur sichtbare zeigen“ an ist.
`search`	`string`	Suchtext.
`initialSortColumn`	`{integer, boolean}`	Sortierspalte als `{columnIndex, ascending}`.

StatisticsReactUtil.UserParam¶

record base/tealdef/gui/statistics/statistics_react_util.d.tl:37

record UserParam

Hinweise

Benutzerparameter, den die Statistiktabellen an ihre Zellen weitergeben.

Im Basisspiel verwendet: 8-mal in 8 Dateien

base/content/gui/gui/statistics/statistic_depots.tl:209

local userParam : StatisticsReactUtil.UserParam = {

base/content/gui/gui/statistics/statistic_industries.tl:429

local userParam : StatisticsReactUtil.UserParam = {

base/content/gui/gui/statistics/statistic_lines.tl:422

local userParam : StatisticsReactUtil.UserParam = {

base/content/gui/gui/statistics/statistic_stations.tl:312

local userParam : StatisticsReactUtil.UserParam = {

base/content/gui/gui/statistics/statistic_towns.tl:527

local userParam : StatisticsReactUtil.UserParam = {

base/content/gui/gui/statistics/statistic_vehicles.tl:394

local userParam : StatisticsReactUtil.UserParam = {

… und 2 weitere Dateien.

Felder

Name	Typ	Beschreibung
`notificationState`	`{Engine.Entity : {integer}}`	Ids der dauerhaften Benachrichtigungen pro Entität.

Funktionen

deleteLineFeedback(message : string, mode : string, dialogData : FeedbackListUtil.FeedbackDialogParam, id : number) base/tealdef/gui/statistics/statistics_react_util.d.tl:38

Die Spieldateien enthalten hierzu noch keine Beschreibung.