cargo_util

Quelle: base/tealdef/gui/main/cargo_util.d.tl

Hinweise

Funktionen, die Güterdaten für die Oberfläche sammeln: Bestände von Industrien, Lagern und Stadtgebäuden, geladene Güter in Fahrzeugen und auf Linien, Icons, Namen und Farben von Güterarten sowie Zahlen zu Güterströmen. Alle Funktionen lesen den Engine-Zustand und ändern ihn nicht. Du lädst es mit ug_require "/gui/main/cargo_util.tl".

CargoUtil

record global base/tealdef/gui/main/cargo_util.d.tl:3

global record CargoUtil

Laden: local cargo_util = ug_require "::/gui/main/cargo_util.tl" as CargoUtil

Hinweise

Nur lesende Helfer für Güterarten, Bestände und Fahrzeugladungen in der Oberfläche.

Details

Güterart-IDs (CargoTypeId) beginnen bei 0. Engine-Arrays, die nach Güterart indiziert sind, etwa TransportVehicle.config.capacities, sind Lua-Arrays ab 1. Eintrag i gehört also zur Güterart i - 1.

Funktionen

getCargoTypesCount(producedOnly : boolean) : integer base/tealdef/gui/main/cargo_util.d.tl:4

Aufruf: cargo_util.getCargoTypesCount(…)

producedOnly: only current types in game if true, all available from rep if false

Rückgabe integer

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/game_mechanics/game_mechanics/finance/account.tl:35

return cargo_util.getCargoTypesCount(true)

base/content/game_mechanics/game_mechanics/finance/finances_cargo_lifetime.tl:265

local maxNumCargoTypes = cargo_util.getCargoTypesCount(false)

getMaxCaroTypeId() : integer base/tealdef/gui/main/cargo_util.d.tl:5

Aufruf: cargo_util.getMaxCaroTypeId(…)

Hinweise

Gibt die höchste Güterart-ID in api.res.cargoTypeRep.getAll(true) zurück.

Rückgabe integer

Details

In den Spieldateien ist der Name Caro geschrieben.

Im Basisspiel verwendet: 3-mal in 2 Dateien

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

return cargo_util.getMaxCaroTypeId() + 1

base/content/gui/gui/entity_window/town/town.tl:325

return cargo_util.getMaxCaroTypeId() + 1

getPassengerCargoTypeId() : CargoTypeId base/tealdef/gui/main/cargo_util.d.tl:6

Aufruf: cargo_util.getPassengerCargoTypeId(…)

Hinweise

Gibt die Güterart-ID der Passagiere zurück (api.res.cargoTypeRep.getPassengerCargoTypeId()).

Rückgabe CargoTypeId

Im Basisspiel verwendet: 41-mal in 23 Dateien

base/content/game_mechanics/game_mechanics/finance/finances_cargo_lifetime.tl:243

cargo[cargo_util.getPassengerCargoTypeId()] = nil -- passengers are not welcome here

base/content/game_mechanics/game_mechanics/subventions/deliver_passengers/deliver_passengers.script.tl:74

local passengerCargoTypeId = cargo_util.getPassengerCargoTypeId()

base/content/game_mechanics/game_mechanics/subventions/subvention_util.tl:570

local passengerCargoTypeId: CargoTypeId = cargo_util.getPassengerCargoTypeId()

base/content/gui/gui/debug_panel/make_entity_debug_panel.tl:454

local passengerCargoTypeId : CargoTypeId = cargo_util.getPassengerCargoTypeId()

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

local passengerCargoTypeId = cargo_util.getPassengerCargoTypeId()

base/content/gui/gui/entity_window/town/town_eow.script.tl:595

if cargoTypeId ~= cargo_util.getPassengerCargoTypeId() then

… und 17 weitere Dateien.

calculateStockConfigs(entity : Engine.Entity, max? : integer, calculateQuality? : boolean, sortByType? : boolean, showEmpty? : boolean, groupStocks? : boolean, producedOnly? : boolean) : {CargoUtil.StockConfig}, integer, boolean base/tealdef/gui/main/cargo_util.d.tl:21

Aufruf: cargo_util.calculateStockConfigs(…)

Hinweise

Gruppiert die Bestände einer Bestandslisten-Entität und berechnet pro Gruppe gelagerte Menge, Kapazität, Tendenz und optional die Qualität.

Parameter	Typ	Beschreibung
entity	Engine.Entity	Bestandslisten-Entität (z. B. Industry.stockList oder Warehouse.stockList).
max?	integer	Höchstzahl der Güter-Icons, die der Aufrufer pro Zeile zeigen will; wird angepasst und als zweites Ergebnis zurückgegeben.
calculateQuality?	boolean	Bei true werden quality und numSpoiled gefüllt.
sortByType?	boolean	Bei true werden die Gruppen nach Bestandsart und dann nach Güterarten sortiert.
showEmpty?	boolean	Bei false werden leere Bestände weggelassen (Standard true).
groupStocks?	boolean	Bei false gibt es einen Eintrag pro Bestand, statt die Bestände nach Art und Güterarten zu gruppieren (Standard true).
producedOnly?	boolean	Bei true werden nur Güterarten aufgeführt, die im aktuellen Spiel produziert werden.

Rückgabe {CargoUtil.StockConfig}, integer, boolean: 1. Liste von StockConfig. 2. Die angepasste Höchstzahl der Icons. 3. true, wenn mindestens eine Gruppe kein Ausgangsbestand ist.

Details

Gibt eine leere Liste zurück, wenn die Entität nicht existiert.

Im Basisspiel verwendet: 7-mal in 5 Dateien

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

configs, maxIcons, invert = cargo_util.calculateStockConfigs(

base/content/gui/gui/main/cargo_react_util.tl:629

local stockCargos = cargo_util.calculateStockConfigs(entity, 10, true, true, nil, true, true)

base/content/gui/gui/main/hud_icon_toolbox.tl:207

stockConfigs, dummyA, dummyB = cargo_util.calculateStockConfigs(params.entity, nil, true, true, true)

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

stockConfigs, dummyA, dummyB = cargo_util.calculateStockConfigs(entity)

base/content/mission/mission/tasks/transport_cargo/empty_stocks.tl:75

local stockConfigs, __, __ = cargo_util.calculateStockConfigs(stockListEntity, maxIconsInput, calculateQuality, sortByType)

sortConfigsByStockType({CargoUtil.StockConfig}, boolean) : {CargoUtil.StockConfig} base/tealdef/gui/main/cargo_util.d.tl:23

Aufruf: cargo_util.sortConfigsByStockType(…)

input-, output-, storage stock

Rückgabe {CargoUtil.StockConfig}

Im Basisspiel verwendet: 2-mal in 1 Datei

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

stockConfigs = cargo_util.sortConfigsByStockType(stockConfigs, false)

calculateStockCargoCount(Engine.Entity, ?boolean, ?{StockId}, ?boolean) : {StockCargoCount} base/tealdef/gui/main/cargo_util.d.tl:37

Aufruf: cargo_util.calculateStockCargoCount(…)

stock ids: [optional] must be stocks of given industry/warehouse entity, if given count is calculated only for those, otherwise for all stocks of given industry/warehouse

Rückgabe {StockCargoCount}

Im Basisspiel verwendet: 3-mal in 3 Dateien

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

local stockCargoCount = cargo_util.calculateStockCargoCount(entity, false, stockConfig.ids)

base/content/gui/gui/main/hud_icon_toolbox.tl:62

local stockCargoCount = cargo_util.calculateStockCargoCount(param.entity, false, stockConfig.ids)

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

local stockCargos : {CargoUtil.StockCargoCount} = cargo_util.calculateStockCargoCount(key, false)

calculateSortedVehicleCargoInfo(Engine.Entity, calculateQuality? : boolean) : {VehicleCargo} base/tealdef/gui/main/cargo_util.d.tl:47

Aufruf: cargo_util.calculateSortedVehicleCargoInfo(…)

Hinweise

Listet die Güterkapazitäten eines Fahrzeugs auf, sortiert nach Kapazität (höchste zuerst) und dann nach Güterart.

Parameter	Typ	Beschreibung
#1	Engine.Entity	Fahrzeug-Entität mit einer TRANSPORT_VEHICLE-Komponente.
calculateQuality?	boolean	Bei true werden hasGoodCargo und hasBadCargo gefüllt.

Rückgabe {VehicleCargo}

Im Basisspiel verwendet: 1-mal in 1 Datei

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

local cargoInfo : {CargoUtil.VehicleCargo} = cargo_util.calculateSortedVehicleCargoInfo(key)

get value usable to for sorting (so that cargoType is most significant)

calculateSortedVehicleCargoInfoCompareValue(Engine.Entity) : {{CargoTypeId, integer, integer}} base/tealdef/gui/main/cargo_util.d.tl:50

Aufruf: cargo_util.calculateSortedVehicleCargoInfoCompareValue(…)

Die Spieldateien enthalten hierzu noch keine Beschreibung.

Rückgabe {{CargoTypeId, integer, integer}}

Im Basisspiel verwendet: 1-mal in 1 Datei

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

{ name = _("Cargo"), recipe = VehicleCargoTypesCell, getCompareValue = cargo_util.calculateSortedVehicleCargoInfoCompareValue, weight = 2.4, },

calculateSortedLineCargoInfo(lineEntity : Engine.Entity, calculateQuality? : boolean) : {CargoUtil.VehicleCargo} base/tealdef/gui/main/cargo_util.d.tl:52

Aufruf: cargo_util.calculateSortedLineCargoInfo(…)

Hinweise

Wie calculateSortedVehicleCargoInfo, summiert über alle Fahrzeuge einer Linie.

Parameter	Typ	Beschreibung
lineEntity	Engine.Entity	Linien-Entität.
calculateQuality?	boolean	Bei true werden hasGoodCargo und hasBadCargo gefüllt.

Rückgabe {CargoUtil.VehicleCargo}

Im Basisspiel verwendet: 2-mal in 2 Dateien

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

local cargoInfo : {CargoUtil.VehicleCargo} = cargo_util.calculateSortedLineCargoInfo(key)

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

local cargoInfo : {CargoUtil.VehicleCargo} = cargo_util.calculateSortedLineCargoInfo(key)

calculateSortedLineCargoInfoCompareValue(lineEntity : Engine.Entity) : {{CargoTypeId, integer, integer}} base/tealdef/gui/main/cargo_util.d.tl:53

Aufruf: cargo_util.calculateSortedLineCargoInfoCompareValue(…)

Hinweise

Gibt für jede Güterart der Fahrzeuge einer Linie {cargoType, fill, capacity} zurück, in derselben Reihenfolge wie calculateSortedLineCargoInfo. Das Ergebnis wird zum Sortieren verwendet.

Rückgabe {{CargoTypeId, integer, integer}}

Im Basisspiel verwendet: 1-mal in 1 Datei

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

{ name = _("Cargo"), recipe = LineCargoTypesCell, getCompareValue = cargo_util.calculateSortedLineCargoInfoCompareValue, weight = 2 },

hasLineVehicleWithCapacity(lineEntity : Engine.Entity, cargoTypeId : CargoTypeId) : boolean base/tealdef/gui/main/cargo_util.d.tl:54

Aufruf: cargo_util.hasLineVehicleWithCapacity(…)

Hinweise

Sagt anhand von TransportVehicle.config.allCaps, ob irgendein Fahrzeug einer Linie die Güterart transportieren kann.

Rückgabe boolean

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/game_mechanics/game_mechanics/subventions/deliver_passengers/deliver_passengers.script.tl:75

if cargo_util.hasLineVehicleWithCapacity(lineEntity, passengerCargoTypeId) then

calculateVehicleCargoFill({Engine.Entity}, integer) : integer base/tealdef/gui/main/cargo_util.d.tl:56

Aufruf: cargo_util.calculateVehicleCargoFill(…)

Hinweise

Gibt die Anzahl der geladenen Güter einer Güterart zurück, summiert über die angegebenen Fahrzeuge.

Parameter	Typ	Beschreibung
#1	{Engine.Entity}	Fahrzeug-Entitäten.
#2	integer	Güterart-ID.

Rückgabe integer

getSortedProducedCargoTypes(locationParams : CargoLocationParams, sortOrder : CargoListSortOrder, passengersFirst? : boolean, cargoTypeFilter? : (function(CargoTypeId) : boolean), allLineCapacities? : boolean) : {CargoTypeId} base/tealdef/gui/main/cargo_util.d.tl:104

Aufruf: cargo_util.getSortedProducedCargoTypes(…)

Hinweise

Listet die Güterarten an einem Ort auf, beschränkt auf Güterarten, die im aktuellen Spiel produziert werden, sortiert in der angegebenen Reihenfolge.

Parameter	Typ	Beschreibung
locationParams	CargoLocationParams	Zu zählende Orte.
sortOrder	CargoListSortOrder	Sortierreihenfolge.
passengersFirst?	boolean	Bei true kommen die Passagiere nach vorn.
cargoTypeFilter?	(function(CargoTypeId) : boolean)	Funktion, die für zu behaltende Güterarten true liefert.
allLineCapacities?	boolean	Geht bei Linien als Ort an api.engine.util.line.getLineCapacityUsages.

Rückgabe {CargoTypeId}

Details

In der Implementierung des Spiels wirkt cargoTypeFilter nur im Abkürzungsfall (nur vehicleEntity gesetzt, showEmpty aus, Sortierreihenfolge CAPACITY). In allen anderen Fällen kommt die Liste ungefiltert zurück.

Im Basisspiel verwendet: 7-mal in 6 Dateien

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

local cargoTypes =  cargo_util.getSortedProducedCargoTypes(locationParams, sortOrder, true, nil)

base/content/gui/gui/line_vehicle_mgmt/line_react_util.tl:689

sortedCargoTypes = cargo_util.getSortedProducedCargoTypes(locationParams, "CAPACITY", nil, nil, true)

base/content/gui/gui/main/cargo_react_util.tl:401

local cargoTypes = cargo_util.getSortedProducedCargoTypes(overriddenParams, params.sortOrder, true, params.cargoTypeFilter)

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

return cargo_util.getSortedProducedCargoTypes(locationParams, "CAPACITY", nil, nil, true)

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

return cargo_util.getSortedProducedCargoTypes(locationParams, "CAPACITY")

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

local cargoTypes = cargo_util.getSortedProducedCargoTypes(locationParams, "CAPACITY")

getConfiguredStopCargoTypes(stopParams : CargoStopParams, passengersFirst? : boolean) : {CargoTypeId} base/tealdef/gui/main/cargo_util.d.tl:111

Aufruf: cargo_util.getConfiguredStopCargoTypes(…)

Hinweise

Listet die Güterarten auf, die an einem Linienhalt geladen werden sollen (stopConfig.load).

Parameter	Typ	Beschreibung
stopParams	CargoStopParams	Linie und Halt.
passengersFirst?	boolean	Bei true kommen die Passagiere nach vorn.

Rückgabe {CargoTypeId}: Güterart-IDs oder eine leere Liste, wenn der Halt nicht existiert.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/line_vehicle_mgmt/line_react_util.tl:681

sortedCargoTypes = cargo_util.getConfiguredStopCargoTypes(stopParams, true)

getNumberOfCargoInStock(stockListOwnerEntity : Engine.Entity) : integer base/tealdef/gui/main/cargo_util.d.tl:115

Aufruf: cargo_util.getNumberOfCargoInStock(…)

Hinweise

Gibt die Gesamtzahl der Güter in der Bestandsliste einer Industrie, eines Lagers oder eines Stadtgebäudes zurück.

Rückgabe integer: Anzahl der Güter, 0, wenn die Entität keine Bestandsliste hat.

Im Basisspiel verwendet: 1-mal in 1 Datei

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

local storedCargoCount = cargo_util.getNumberOfCargoInStock(params.entity)

getCargoTypeInfo(CargoTypeId, CargoLocationParams) : CargoTypeInfo base/tealdef/gui/main/cargo_util.d.tl:116

Aufruf: cargo_util.getCargoTypeInfo(…)

Hinweise

Sammelt Menge, Kapazität, Qualität und bei Fahrzeugen den Ladezustand einer Güterart an den angegebenen Orten.

Parameter	Typ	Beschreibung
#1	CargoTypeId	Güterart-ID.
#2	CargoLocationParams	Zu zählende Orte; die Werte aller gesetzten Orte werden addiert.

Rückgabe CargoTypeInfo

Im Basisspiel verwendet: 4-mal in 3 Dateien

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

local info : CargoUtil.CargoTypeInfo = cargo_util.getCargoTypeInfo(cargoType, locationParams)

base/content/gui/gui/main/cargo_react_util.tl:405

local info = cargo_util.getCargoTypeInfo(cargoType, overriddenParams)

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

cargoTypeInfos[#cargoTypeInfos + 1] = cargo_util.getCargoTypeInfo(cargoTypeId, locationParams)

getSpecializationClasses(stockListEntity : Engine.Entity) : {string} base/tealdef/gui/main/cargo_util.d.tl:117

Aufruf: cargo_util.getSpecializationClasses(…)

Hinweise

Gibt die Namen der Güterklassen zurück, auf die eine Bestandsliste spezialisiert ist.

Rückgabe {string}

Details

Sammelt die eingeschlossenen Güterklassen der Lagerbestände, die nur nach eingeschlossenen Güterklassen filtern (keine ausgeschlossenen Klassen, keine eingeschlossenen Güterarten).

getCargoClassesOfType(CargoTypeId) : {CargoClassId} base/tealdef/gui/main/cargo_util.d.tl:119

Aufruf: cargo_util.getCargoClassesOfType(…)

Hinweise

Gibt die IDs der Güterklassen einer Güterart zurück. Unbekannte Klassen-Tags werden übersprungen.

Rückgabe {CargoClassId}

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/cargo_react_util.tl:38

local cargoClassIds = cargo_util.getCargoClassesOfType(cargoTypeId)

getWarehouseCountIndicatorTexture(integer) : string base/tealdef/gui/main/cargo_util.d.tl:121

Aufruf: cargo_util.getWarehouseCountIndicatorTexture(…)

Hinweise

Gibt das Pfeil-Icon für einen Tendenzwert des Bestands zurück.

Parameter	Typ	Beschreibung
#1	integer	Tendenz von -3 bis 3; Werte außerhalb werden begrenzt.

Rückgabe string: Bildpfad, z. B. ::/gui/entity_window/icons/stock_increasing2.tga; bei 0 stock_stagnating.tga.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/cargo_react_util.tl:197

local indicatorIconPath = params.tendency ~= nil and cargo_util.getWarehouseCountIndicatorTexture(params.tendency) or nil

getCargoColorById(CargoTypeId) : Vec4f base/tealdef/gui/main/cargo_util.d.tl:122

Aufruf: cargo_util.getCargoColorById(…)

Hinweise

Gibt die Farbe einer Güterart mit Alpha 1 zurück.

Rückgabe Vec4f

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/game_mechanics/game_mechanics/finance/finances_assets.tl:338

local col = cargo_util.getCargoColorById(cargoTypeId)

getCargoColorByType(string) : Vec4f base/tealdef/gui/main/cargo_util.d.tl:123

Aufruf: cargo_util.getCargoColorByType(…)

Hinweise

Gibt die Farbe einer Güterart zurück, die über ihren Namen im Repository der Güterarten angegeben ist.

Rückgabe Vec4f

Details

Bei nil kommt die dunkelste neutrale Farbe aus default_colors.gres zurück.

getCargoIconById(CargoTypeId) : string base/tealdef/gui/main/cargo_util.d.tl:124

Aufruf: cargo_util.getCargoIconById(…)

Hinweise

Gibt den Icon-Pfad einer Güterart zurück.

Rückgabe string

Im Basisspiel verwendet: 19-mal in 14 Dateien

base/content/game_mechanics/game_mechanics/finance/finances_assets.tl:349

unfilteredState.icons[unfilteredIndex] = cargo_util.getCargoIconById(cargoTypeId)

base/content/game_mechanics/game_mechanics/finance/finances_cargo_lifetime.tl:274

icon = cargo_util.getCargoIconById(id),

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

path = cargo_util.getCargoIconById(cargoTypeId),

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

local iconPath = cargo_util.getCargoIconById(id.cargoType)

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

icon = cargo_util.getCargoIconById(cargoAndAmount.cargoType),

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

icon = exploration.icon or cargo_util.getCargoIconById(cargoTypeId),

… und 8 weitere Dateien.

getCargoIconByType(string) : string base/tealdef/gui/main/cargo_util.d.tl:125

Aufruf: cargo_util.getCargoIconByType(…)

Hinweise

Gibt den Icon-Pfad einer Güterart zurück, die über ihren Namen im Repository der Güterarten angegeben ist; bei nil "".

Rückgabe string

getCargoClassIconById(CargoClassId) : string base/tealdef/gui/main/cargo_util.d.tl:126

Aufruf: cargo_util.getCargoClassIconById(…)

Hinweise

Gibt den Icon-Pfad einer Güterklasse zurück.

Rückgabe string

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/cargo_react_util.tl:41

children[#children + 1] = cargo_react_util.makeIcon(class and class or "", cargo_util.getCargoClassIconById(cargoClassId), cargoClass.name)

getMixedCargoIcon() : string base/tealdef/gui/main/cargo_util.d.tl:127

Aufruf: cargo_util.getMixedCargoIcon(…)

Hinweise

Gibt das Icon für gemischte oder beliebige Güter zurück (::/cargos/icons/cargo_mixed.tga).

Rückgabe string

Im Basisspiel verwendet: 6-mal in 5 Dateien

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

path = cargo_util.getMixedCargoIcon(),

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

path = cargo_util.getMixedCargoIcon(),

base/content/gui/gui/line_vehicle_mgmt/vehicle_store_util.tl:1145

path = cargo_util.getMixedCargoIcon(),

base/content/gui/gui/main/cargo_react_util.tl:512

path = cargo_util.getMixedCargoIcon(),

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

path = cargo_util.getMixedCargoIcon()}

getPassengerCargoIcon() : string base/tealdef/gui/main/cargo_util.d.tl:128

Aufruf: cargo_util.getPassengerCargoIcon(…)

Hinweise

Gibt das Passagier-Icon zurück (::/cargos/passengers/passengers.tga).

Rückgabe string

Im Basisspiel verwendet: 3-mal in 3 Dateien

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

path = cargo_util.getPassengerCargoIcon(),

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

path = cargo_util.getPassengerCargoIcon(),

base/content/gui/gui/main/hud_icon_toolbox.tl:130

iconPath = cargo_util.getPassengerCargoIcon(),

getCargoNameById(CargoTypeId) : string base/tealdef/gui/main/cargo_util.d.tl:129

Aufruf: cargo_util.getCargoNameById(…)

Hinweise

Gibt den Anzeigenamen einer Güterart zurück.

Rückgabe string

Im Basisspiel verwendet: 17-mal in 13 Dateien

base/content/game_mechanics/game_mechanics/company/company_notification_prospection.script.tl:36

local cargoName = cargoTypeId >= 0 and cargo_util.getCargoNameById(cargoTypeId) or _("Random Resource")

base/content/game_mechanics/game_mechanics/finance/finances_assets.tl:337

local label = cargo_util.getCargoNameById(cargoTypeId)

base/content/gui/gui/debug_panel/make_entity_debug_panel.tl:448

local cargoName = cargo_util.getCargoNameById(cargoTypeId)

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

iconTooltip = cargo_util.getCargoNameById(state:old().inputOutputData.cargoType),

base/content/gui/gui/entity_window/industry_react_util.tl:325

iconTooltip = cargo_util.getCargoNameById(state:old().inputOutputData.cargoType),

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

tooltip = cargo_util.getCargoNameById(id),

… und 7 weitere Dateien.

getCargoNameByType(string) : string base/tealdef/gui/main/cargo_util.d.tl:130

Aufruf: cargo_util.getCargoNameByType(…)

Hinweise

Gibt den Anzeigenamen einer Güterart zurück, die über ihren Namen im Repository der Güterarten angegeben ist; bei nil "".

Rückgabe string

getStockListEntityFromOwner(stockListOwnerEntity : Engine.Entity) : Engine.Entity base/tealdef/gui/main/cargo_util.d.tl:132

Aufruf: cargo_util.getStockListEntityFromOwner(…)

Hinweise

Gibt die Bestandslisten-Entität eines Stadtgebäudes, einer Industrie oder eines Lagers zurück.

Rückgabe Engine.Entity: Die stockList der Komponente TOWN_BUILDING, INDUSTRY oder WAREHOUSE des Besitzers oder nil.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/cargo_react_util.tl:365

local stockListEntity = cargo_util.getStockListEntityFromOwner(params.stockListOwnerEntity)

getInputOutputStocksForStation(stationEntity : Engine.Entity, skipStorage? : boolean) : {CargoTypeId : boolean}, integer, {CargoTypeId : boolean}, integer base/tealdef/gui/main/cargo_util.d.tl:134

Aufruf: cargo_util.getInputOutputStocksForStation(…)

Hinweise

Sammelt die Eingangs- und Ausgangsgüterarten aller Bestandslisten im Einzugsgebiet einer Station.

Parameter	Typ	Beschreibung
stationEntity	Engine.Entity	Stations-Entität.
skipStorage?	boolean	Siehe getInputOutputStocksForStockList.

Rückgabe {CargoTypeId : boolean}, integer, {CargoTypeId : boolean}, integer: 1. Menge der Eingangsgüterarten. 2. Anzahl der Eingangseinträge (einer pro Bestand und Güterart, summiert über alle Bestandslisten). 3. Menge der Ausgangsgüterarten. 4. Anzahl der Ausgangseinträge.

Im Basisspiel verwendet: 5-mal in 2 Dateien

base/content/gui/gui/line_vehicle_mgmt/cargofilter_window.tl:346

local inputCargoTypes, inputCount, outputCargoTypes, _outputCount = cargo_util.getInputOutputStocksForStation(stationGroup.stations[stop.station + 1])

base/content/gui/gui/line_vehicle_mgmt/line_util.tl:553

local inputCargoTypes, __, outputCargoTypes, __ = cargo_util.getInputOutputStocksForStation(station, true)

getInputOutputStocksForStockList(stationEntity : Engine.Entity, skipStorage? : boolean) : {CargoTypeId : boolean}, integer, {CargoTypeId : boolean}, integer base/tealdef/gui/main/cargo_util.d.tl:136

Aufruf: cargo_util.getInputOutputStocksForStockList(…)

Hinweise

Sammelt die Eingangs- und Ausgangsgüterarten einer Bestandsliste.

Parameter	Typ	Beschreibung
stationEntity	Engine.Entity	Bestandslisten-Entität (der Parametername führt in die Irre).
skipStorage?	boolean	Bei true zählen nur Eingangs- und Ausgangsbestände. Sonst zählen Lagerbestände als Eingang und als Ausgang.

Rückgabe {CargoTypeId : boolean}, integer, {CargoTypeId : boolean}, integer: 1. Menge der Eingangsgüterarten. 2. Anzahl der Eingangseinträge (einer pro Bestand und Güterart). 3. Menge der Ausgangsgüterarten. 4. Anzahl der Ausgangseinträge.

getCargoTypesForStockList(stationEntity : Engine.Entity) : {CargoTypeId : CargoUtil.StockProperties} base/tealdef/gui/main/cargo_util.d.tl:144

Aufruf: cargo_util.getCargoTypesForStockList(…)

Hinweise

Gibt pro Güterart einer Bestandsliste zurück, ob sie Eingang, Ausgang oder Booster ist.

Parameter	Typ	Beschreibung
stationEntity	Engine.Entity	Bestandslisten-Entität (der Parametername führt in die Irre).

Rückgabe {CargoTypeId : CargoUtil.StockProperties}

Im Basisspiel verwendet: 5-mal in 5 Dateien

base/content/game_mechanics/game_mechanics/emission/pollution_cleanup_facility_hud.script.tl:60

result.cargoTypes = cargo_util.getCargoTypesForStockList(subCon)

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

local industryCargoItems = cargo_util.getCargoTypesForStockList(industry.stockList)

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

cargoTypes =  cargo_util.getCargoTypesForStockList(entityId),

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

result.cargoTypes = cargo_util.getCargoTypesForStockList(subconEntity)

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

cargoTypes = cargo_util.getCargoTypesForStockList(entityId)

getVehicleUnsetCapacities(vehicleEntity : Engine.Entity) : CargoUtil.VehicleUnsetCapacities base/tealdef/gui/main/cargo_util.d.tl:146

Aufruf: cargo_util.getVehicleUnsetCapacities(…)

Hinweise

Gibt die Kapazitäten eines Fahrzeugs zurück, deren Güterart noch nicht feststeht, getrennt in Kapazitäten für eine Art und für mehrere Arten.

Rückgabe CargoUtil.VehicleUnsetCapacities

Details

Berücksichtigt werden nur Güterarten, die im aktuellen Spiel produziert werden. LocationCargoList zeigt damit leere Fahrzeuge in Infofenstern.

Im Basisspiel verwendet: 3-mal in 3 Dateien

base/content/gui/gui/main/cargo_react_util.tl:395

local unsetCapacities = cargo_util.getVehicleUnsetCapacities(params.locationParams.vehicleEntity)

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

local unsetCapacities = cargo_util.getVehicleUnsetCapacities(entity)

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

local unsetCapacities = cargo_util.getVehicleUnsetCapacities(vehicleEntity)

getCargoFlowCount(entityFrom : Engine.Entity, entityTo : Engine.Entity, cargoType : CargoTypeId, toIsTown : boolean) : integer base/tealdef/gui/main/cargo_util.d.tl:154

Aufruf: cargo_util.getCargoFlowCount(…)

Hinweise

Gibt zurück, wie viele Güter einer Güterart pro Jahr von einer Entität zu einer anderen befördert wurden.

Parameter	Typ	Beschreibung
entityFrom	Engine.Entity	Quell-Entität.
entityTo	Engine.Entity	Ziel-Entität.
cargoType	CargoTypeId	Güterart-ID.
toIsTown	boolean	Bei true wird das Protokoll an entityTo statt an entityFrom gelesen.

Rückgabe integer: Güter pro Jahr aus api.engine.util.stock.getCargoLogPerYearForTarget(..., "itemsTransported", cargoType).

Im Basisspiel verwendet: 6-mal in 2 Dateien

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

local count = cargo_util.getCargoFlowCount(entity, entityId, cargoType, town)

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

curr.entity2SupplyCount[otherEntity] = cargo_util.getCargoFlowCount(

CargoUtil.StockConfig

record base/tealdef/gui/main/cargo_util.d.tl:8

record StockConfig

Hinweise

Eine Gruppe von Beständen einer Bestandsliste, wie calculateStockConfigs sie liefert.

Im Basisspiel verwendet: 36-mal in 4 Dateien

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

local makeStockContentBarText = function(config : CargoUtil.StockConfig) : string

base/content/gui/gui/main/cargo_util.tl:30

sortByType : boolean, showEmpty : boolean, groupStocks : boolean, producedOnly : boolean) : {CargoUtil.StockConfig}, integer, boolean

base/content/gui/gui/main/hud_icon_toolbox.tl:51

stockConfigs : {CargoUtil.StockConfig}

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

local compareStockConfigs = function(a : CargoUtil.StockConfig, b : CargoUtil.StockConfig) : integer

Felder

Name	Typ	Beschreibung
ids	{StockId}	Bestands-IDs (ab 0) in dieser Gruppe.
stored	integer	Anzahl der Güter, die in der Gruppe lagern.
capacity	integer	Summe der Kapazitäten der Bestände in der Gruppe.
cargoTypesSorted	{CargoTypeId}	Güterarten, die die Gruppe annimmt.
allCargoTypes	boolean	true, wenn die Gruppe alle Güterarten bis auf eine annimmt (#cargoTypesSorted == getCargoTypesCount(false) - 1).
tendency	integer	Änderung des Bestands pro Jahr.
stockType	StockListType	Art der Bestände in der Gruppe (Eingang, Ausgang oder Lager).
quality	integer	Durchschnittliche Güterqualität in Prozent (0-100). Nur gesetzt, wenn calculateQuality angefordert wurde und die Gruppe Güter enthält.
numSpoiled	integer	Anzahl der verdorbenen Güter (schlechte Qualität). Wird nur gezählt, wenn calculateQuality angefordert wurde.
canPinCargoType	boolean	true, wenn die Gruppe ein Lagerbestand mit Güterart-Filtern ist, für den sich eine einzelne Güterart festlegen lässt.
pinnedCargoType	boolean	true, wenn die Bestände eine festgelegte Güterart haben (stock.cargoType >= 0). nil, wenn nicht ermittelt.

CargoUtil.StockCargoCount

record base/tealdef/gui/main/cargo_util.d.tl:25

record StockCargoCount

Hinweise

Menge einer Güterart in einer Bestandsliste, wie calculateStockCargoCount sie liefert.

Im Basisspiel verwendet: 8-mal in 2 Dateien

base/content/gui/gui/main/cargo_util.tl:207

cargo_util.calculateStockCargoCount = function(entity : Engine.Entity, sortByCargoType? : boolean, stockIds? : {StockId}, calculateQuality? : boolean) : {CargoU

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

local stockCargos : {CargoUtil.StockCargoCount} = cargo_util.calculateStockCargoCount(key, false)

Felder

Name	Typ	Beschreibung
cargoType	CargoTypeId	Güterart-ID.
count	integer	Anzahl der Güter dieser Art in den gezählten Beständen.
spoiledCount	integer	Anzahl der verdorbenen Güter. Nur gesetzt, wenn die Qualität angefordert wurde.
tendency	integer	Trend des Bestands von -3 (stark fallend) bis 3 (stark steigend).
quality	number	Durchschnittliche Qualität dieser Güterart in der ganzen Bestandsliste. Nur gesetzt, wenn die Qualität angefordert wurde.

CargoUtil.VehicleCargo

record base/tealdef/gui/main/cargo_util.d.tl:39

record VehicleCargo

Hinweise

Kapazität und Ladung einer Güterart, summiert über ein oder mehrere Fahrzeuge.

Im Basisspiel verwendet: 10-mal in 4 Dateien

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

local cargoInfo : {CargoUtil.VehicleCargo} = cargo_util.calculateSortedLineCargoInfo(key)

base/content/gui/gui/main/cargo_util.tl:283

local calculateSortedVehicleCargoInfo = function(vehicleEntities : {Engine.Entity}, calculateQuality? : boolean, calculateFill? : boolean) : {CargoUtil.VehicleC

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

local cargoInfo : {CargoUtil.VehicleCargo} = cargo_util.calculateSortedLineCargoInfo(key)

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

local cargoInfo : {CargoUtil.VehicleCargo} = cargo_util.calculateSortedVehicleCargoInfo(key)

Felder

Name	Typ	Beschreibung
cargoType	CargoTypeId	Güterart-ID.
capacity	integer	Gesamtkapazität für diese Güterart über alle Fahrzeuge.
vehicleEntities	{Engine.Entity}	Fahrzeuge, die Kapazität für diese Güterart haben.
fill	integer	Anzahl der geladenen Güter. Nur bei den Funktionen für Vergleichswerte gefüllt.
hasGoodCargo	boolean	true, wenn ein Fahrzeug Güter dieser Art transportiert, die nicht verdorben sind. Nur mit calculateQuality gesetzt.
hasBadCargo	boolean	true, wenn ein Fahrzeug verdorbene Güter dieser Art transportiert (bei Passagieren nie gesetzt). Nur mit calculateQuality gesetzt.

CargoUtil.CargoListSortOrder

enum base/tealdef/gui/main/cargo_util.d.tl:58

enum CargoListSortOrder

Hinweise

Sortierreihenfolge von getSortedProducedCargoTypes. Bei Gleichstand entscheidet die Güterart-ID.

Im Basisspiel verwendet: 2-mal in 2 Dateien

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

local sortOrder : CargoUtil.CargoListSortOrder = "CAPACITY"

base/content/gui/gui/main/cargo_util.tl:843

sortOrder : CargoUtil.CargoListSortOrder,

Wert	Beschreibung
"CAPACITY"	Nach Kapazität sortieren, aufsteigend.
"COUNT"	Nach Anzahl der Güter sortieren, aufsteigend.
"ID"	Nach Güterart-ID sortieren.

CargoUtil.CargoLocationParams

record base/tealdef/gui/main/cargo_util.d.tl:64

record CargoLocationParams

Hinweise

Wo getSortedProducedCargoTypes und getCargoTypeInfo Güter sammeln. Setz eines oder mehrere der Entitätsfelder; die Ergebnisse aller gesetzten Orte werden addiert.

Im Basisspiel verwendet: 11-mal in 6 Dateien

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

local locationParams : CargoUtil.CargoLocationParams = {

base/content/gui/gui/line_vehicle_mgmt/line_react_util.tl:684

local locationParams : CargoUtil.CargoLocationParams = {

base/content/gui/gui/main/cargo_util.tl:584

local getCargoTypeInfoForCargoStockList = function(result : CargoUtil.CargoTypeInfo, cargoTypeId : CargoTypeId, locationParams : CargoUtil.CargoLocationParams)

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

local locationParams : CargoUtil.CargoLocationParams = {

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

local locationParams : CargoUtil.CargoLocationParams = {

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

local locationParams : CargoUtil.CargoLocationParams = {

Felder

Name	Typ	Beschreibung
vehicleEntity	Engine.Entity	Fahrzeug, dessen Ladung und Kapazität gezählt werden.
stockListOwnerEntity	Engine.Entity	Industrie, Lager oder Stadtgebäude, dessen Bestandsliste gezählt wird (siehe getStockListEntityFromOwner).
lineEntity	Engine.Entity	Linie, deren Kapazitätsauslastung gezählt wird.
stopIndex1	integer
getTendency	boolean	Bei true berechnet getCargoTypeInfo die Tendenz des Bestands (nur für stockListOwnerEntity).
showEmpty	boolean	Bei true werden auch Güterarten ohne Güter aufgeführt.
extraCapacity	{CargoTypeId : integer}	Kapazität pro Güterart, die zu den gezählten Orten hinzukommt.

CargoUtil.CargoStopParams

record base/tealdef/gui/main/cargo_util.d.tl:78

record CargoStopParams

Hinweise

Linienhalt für getConfiguredStopCargoTypes.

Im Basisspiel verwendet: 2-mal in 2 Dateien

base/content/gui/gui/line_vehicle_mgmt/line_react_util.tl:675

local stopParams : CargoUtil.CargoStopParams = {

base/content/gui/gui/main/cargo_util.tl:820

stopParams : CargoUtil.CargoStopParams,

Felder

Name	Typ	Beschreibung
lineEntity	Engine.Entity	Linien-Entität.
stopIndex1	integer	Index des Halts in Line.stops, ab 1.
getTendency	boolean
showEmpty	boolean

CargoUtil.CargoTypeInfo

record base/tealdef/gui/main/cargo_util.d.tl:86

record CargoTypeInfo

Hinweise

Menge, Kapazität und Qualität einer Güterart an einem Ort, wie getCargoTypeInfo sie liefert.

Im Basisspiel verwendet: 16-mal in 4 Dateien

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

local info : CargoUtil.CargoTypeInfo = cargo_util.getCargoTypeInfo(cargoType, locationParams)

base/content/gui/gui/main/cargo_react_util.tl:104

local makeCargoTypeIcons = function(params : CargoUtil.CargoTypeInfo, mode : GuiReactUtil.LabelMode, shippingState : GuiReactUtil.ShippingState, showLoadingIndi

base/content/gui/gui/main/cargo_util.tl:584

local getCargoTypeInfoForCargoStockList = function(result : CargoUtil.CargoTypeInfo, cargoTypeId : CargoTypeId, locationParams : CargoUtil.CargoLocationParams)

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
cargoType	CargoTypeId	Güterart-ID. -1 bei einem Eintrag, der für mehrere Güterarten steht (siehe cargoTypes).
cargoTypes	{CargoTypeId}	Güterarten, die sich eine Kapazität teilen. Nur getVehicleUnsetCapacities setzt das Feld.
capacity	integer	Kapazität für diese Güterart.
count	integer	Anzahl der Güter.
tendency	integer	Trend des Bestands von -3 bis 3 (siehe StockCargoCount.tendency). Nur mit getTendency gesetzt.
spoiledCount	integer	Anzahl der verdorbenen Güter (oder der unzufriedenen Passagiere).
averageQuality	number	Durchschnittliche Qualität (0-1) der Güter, bei Passagieren ihre Zufriedenheit.
loadSpeedModifiers	Engine.Component.TransportVehicle.LoadSpeedModifiers	Modifikatoren der Ladegeschwindigkeit des Fahrzeugs für diese Güterart. Nur gesetzt, solange das Fahrzeug an einem Terminal steht.
loadState	Engine.Component.TransportVehicle.LoadState	Ladezustand des Fahrzeugs. Nur gesetzt, solange das Fahrzeug an einem Terminal steht.
gameSpeed	number	Aktueller Beschleunigungsfaktor des Spiels (GameSpeed.speedup). Bei Fahrzeugen gesetzt; bestimmt die Geschwindigkeit der Ladeanimation.

CargoUtil.VehicleUnsetCapacities

record base/tealdef/gui/main/cargo_util.d.tl:99

record VehicleUnsetCapacities

Hinweise

Kapazitäten eines Fahrzeugs, die noch an keine Güterart gebunden sind, wie getVehicleUnsetCapacities sie liefert.

Im Basisspiel verwendet: 1-mal in 1 Datei

base/content/gui/gui/main/cargo_util.tl:941

cargo_util.getVehicleUnsetCapacities = function(vehicleEntity : Engine.Entity) : CargoUtil.VehicleUnsetCapacities

Felder

Name	Typ	Beschreibung
multiTypes	{CargoUtil.CargoTypeInfo}	Kapazitäten, die eine von mehreren Güterarten aufnehmen können, je ein CargoTypeInfo mit cargoType = -1 und den möglichen Arten in cargoTypes.
singleCapacities	{CargoTypeId : integer}	Kapazitäten, die nur eine Güterart aufnehmen können, nach Güterart-ID.

CargoUtil.StockProperties

record base/tealdef/gui/main/cargo_util.d.tl:139

record StockProperties

Hinweise

Wie eine Bestandsliste eine Güterart verwendet, wie getCargoTypesForStockList es liefert.

Im Basisspiel verwendet: 21-mal in 10 Dateien

base/content/game_mechanics/game_mechanics/emission/pollution_cleanup_facility_hud.script.tl:49

cargoTypes : {CargoTypeId : CargoUtil.StockProperties}

base/content/game_mechanics/game_mechanics/subventions/deliver_cargo/deliver_cargo.script.tl:273

getRelevantEntities = function(state : Subvention<DeliverCargoState>) : {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties}

base/content/game_mechanics/game_mechanics/subventions/deliver_cargo_town/deliver_cargo_town.script.tl:371

getRelevantEntities = function(state : Subvention<DeliverCargoTownState>) : {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties}

base/content/game_mechanics/game_mechanics/subventions/deliver_passengers/deliver_passengers.script.tl:347

getRelevantEntities = function(state : Subvention<DeliverPassengersState>) : {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties}

base/content/game_mechanics/game_mechanics/subventions/deliver_workers/deliver_workers.script.tl:229

getRelevantEntities = function(state : Subvention<DeliverWorkersState>) : {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties}

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

local function isProducerMatchingConsumer(producer : {CargoTypeId : CargoUtil.StockProperties}, consumer : {CargoTypeId : CargoUtil.StockProperties}, bidirectio

… und 4 weitere Dateien.

Felder

Name	Typ	Beschreibung
booster	boolean	true, wenn die Güterart ein Eingang einer Booster-Regel ist.
input	boolean	true, wenn die Güterart ein Eingang ist (Lagerbestände zählen als Eingang).
output	boolean	true, wenn die Güterart ein Ausgang ist (Lagerbestände zählen als Ausgang).

CargoUtil.CargoFlowData

record base/tealdef/gui/main/cargo_util.d.tl:148

record CargoFlowData

Hinweise

Ein Lieferant oder Abnehmer eines Güterstroms, wie ihn die Infofenster von Industrien und Städten aufbauen.

Im Basisspiel verwendet: 5-mal in 2 Dateien

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

local supplierData : {CargoUtil.CargoFlowData} = {}

base/content/gui/gui/entity_window/town/town.tl:865

suppliers : {CargoUtil.CargoFlowData}

Felder

Name	Typ	Beschreibung
position	Vec3f	Position der Entität des Lieferanten oder Abnehmers.
cargoType	CargoTypeId	Güterart des Stroms.
cargoCount	integer	Beförderte Güter pro Jahr (aus getCargoFlowCount).