Module content.gui.main.cargo_react_util🔗

 
global record CargoReactUtil  
record VehicleCargoInfoParams    vehicleEntity: Engine.Entity
    showEmpty: boolean
    showLoadingIndicator: boolean
    mode: GuiReactUtil.LabelMode
    cargoTypeFilter: function(CargoTypeId): boolean
    getEmptyItem: function(): TreeNodeId
end

  
record LineCargoInfoParams    lineEntity: Engine.Entity
    makeEmptyItem: TreeNodeId
    mode: GuiReactUtil.LabelMode
end

  
record WarehouseCargoInfoParams    warehouseEntity: Engine.Entity
    makeEmptyItem: TreeNodeId
    showTendency: boolean
    mode: GuiReactUtil.LabelMode
end

  makeVehicleCargoInfo: function(VehicleCargoInfoParams): TreeNodeId
  LineCargoInfo: Recipe<LineCargoInfoParams>
  WarehouseCargoInfo: Recipe<WarehouseCargoInfoParams>
  makeIcon: function(string, string, string, boolean): TreeNodeId
  makeCargoIcon: function(CargoTypeId, string, string, boolean, boolean, function(string) : string): TreeNodeId
  makeCargoClassIcon: function(CargoTypeId, string): TreeNodeId
  makeTooltipStockCompatibility: function(Engine.Component.TransportVehicle.LoadSpeedModifiers): string
  makeTooltipVehicleCompatibility: function(Engine.Component.TransportVehicle.LoadSpeedModifiers): string
  
record CargoIconLabelIndicatorParams    cargoType: CargoTypeId
    cargoTypes: {CargoTypeId}
    iconStyle: string
    label: string
    richLabel: GuiReactUtil.RichLabel
    labelFontColor: GuiReactUtil.LabelFontColor
    labelMode: GuiReactUtil.LabelMode
    labelTooltip: string
    indicatorIconPath: string
    iconOverride: string
    loadingIndicator: TreeNodeId
    shippingState: GuiReactUtil.ShippingState
end

  makeCargoIconLabelIndicator: function(CargoIconLabelIndicatorParams): TreeNodeId
  
record CargoListParams    gameCtx: GameContext
    cargoTypeLoadSpeed: {{CargoTypeId, number}}
    allCargo: boolean
end

  CargoList: Recipe<CargoListParams>
  
record LocationCargoListParams    
enum LocationCargoListLayout      "FLOW"
      "HORIZONTAL"
      "VERTICAL"
end

    locationParams: CargoUtil.CargoLocationParams
    cargoTypeFilter: function(CargoTypeId): boolean
    layout: LocationCargoListLayout
    sortOrder: CargoUtil.CargoListSortOrder
    groupIfAllEmpty: boolean
    getCargoItemLayout: function(CargoUtil.CargoTypeInfo, GuiReactUtil.ShippingState): TreeNodeId
    getFrownyIconLayout: function(UtilCargo.CargoQualityData, boolean, GuiReactUtil.ShippingState): TreeNodeId
    getEmptyItem: function(): TreeNodeId
    shippingState: GuiReactUtil.ShippingState
end

  LocationCargoList: Recipe<LocationCargoListParams>
  
record CargoInputOutputData    
record CargoData      count: integer
      max: integer
      cargoType: CargoTypeId
      allCargoType: boolean
end

    inputs: {CargoData}
    outputs: {CargoData}
end

  
record CargoInputOutputParams    data: CargoInputOutputData
    inputDistrict: LandUseType
    outputDistrict: LandUseType
    showPercentage: boolean
end

  CargoInputOutputIndicator: Recipe<CargoInputOutputParams>
  CargoIconLabelIndicator: Recipe<CargoIconLabelIndicatorParams>
  makeCargoInputOutputDataForStorage: function(Engine.Entity): CargoReactUtil.CargoInputOutputData
  makeCargoInputOutputDataForStocklist: function(Engine.Entity, boolean, boolean, boolean, boolean): CargoInputOutputData
  makeCargoInputOutputDataForConstructionData: function(Engine.Entity): CargoInputOutputData
  
record CargoSpecializationParams    cargoClasses: {string}
    horizontalLayout: boolean
end

  CargoClassSpecialization: Recipe<CargoSpecializationParams>
end

Category: globals🔗

CargoReactUtil🔗

 
global record CargoReactUtil  
record VehicleCargoInfoParams    vehicleEntity: Engine.Entity
    showEmpty: boolean
    showLoadingIndicator: boolean
    mode: GuiReactUtil.LabelMode
    cargoTypeFilter: function(CargoTypeId): boolean
    getEmptyItem: function(): TreeNodeId
end

  
record LineCargoInfoParams    lineEntity: Engine.Entity
    makeEmptyItem: TreeNodeId
    mode: GuiReactUtil.LabelMode
end

  
record WarehouseCargoInfoParams    warehouseEntity: Engine.Entity
    makeEmptyItem: TreeNodeId
    showTendency: boolean
    mode: GuiReactUtil.LabelMode
end

  makeVehicleCargoInfo: function(VehicleCargoInfoParams): TreeNodeId
  LineCargoInfo: Recipe<LineCargoInfoParams>
  WarehouseCargoInfo: Recipe<WarehouseCargoInfoParams>
  makeIcon: function(string, string, string, boolean): TreeNodeId
  makeCargoIcon: function(CargoTypeId, string, string, boolean, boolean, function(string) : string): TreeNodeId
  makeCargoClassIcon: function(CargoTypeId, string): TreeNodeId
  makeTooltipStockCompatibility: function(Engine.Component.TransportVehicle.LoadSpeedModifiers): string
  makeTooltipVehicleCompatibility: function(Engine.Component.TransportVehicle.LoadSpeedModifiers): string
  
record CargoIconLabelIndicatorParams    cargoType: CargoTypeId
    cargoTypes: {CargoTypeId}
    iconStyle: string
    label: string
    richLabel: GuiReactUtil.RichLabel
    labelFontColor: GuiReactUtil.LabelFontColor
    labelMode: GuiReactUtil.LabelMode
    labelTooltip: string
    indicatorIconPath: string
    iconOverride: string
    loadingIndicator: TreeNodeId
    shippingState: GuiReactUtil.ShippingState
end

  makeCargoIconLabelIndicator: function(CargoIconLabelIndicatorParams): TreeNodeId
  
record CargoListParams    gameCtx: GameContext
    cargoTypeLoadSpeed: {{CargoTypeId, number}}
    allCargo: boolean
end

  CargoList: Recipe<CargoListParams>
  
record LocationCargoListParams    
enum LocationCargoListLayout      "FLOW"
      "HORIZONTAL"
      "VERTICAL"
end

    locationParams: CargoUtil.CargoLocationParams
    cargoTypeFilter: function(CargoTypeId): boolean
    layout: LocationCargoListLayout
    sortOrder: CargoUtil.CargoListSortOrder
    groupIfAllEmpty: boolean
    getCargoItemLayout: function(CargoUtil.CargoTypeInfo, GuiReactUtil.ShippingState): TreeNodeId
    getFrownyIconLayout: function(UtilCargo.CargoQualityData, boolean, GuiReactUtil.ShippingState): TreeNodeId
    getEmptyItem: function(): TreeNodeId
    shippingState: GuiReactUtil.ShippingState
end

  LocationCargoList: Recipe<LocationCargoListParams>
  
record CargoInputOutputData    
record CargoData      count: integer
      max: integer
      cargoType: CargoTypeId
      allCargoType: boolean
end

    inputs: {CargoData}
    outputs: {CargoData}
end

  
record CargoInputOutputParams    data: CargoInputOutputData
    inputDistrict: LandUseType
    outputDistrict: LandUseType
    showPercentage: boolean
end

  CargoInputOutputIndicator: Recipe<CargoInputOutputParams>
  CargoIconLabelIndicator: Recipe<CargoIconLabelIndicatorParams>
  makeCargoInputOutputDataForStorage: function(Engine.Entity): CargoReactUtil.CargoInputOutputData
  makeCargoInputOutputDataForStocklist: function(Engine.Entity, boolean, boolean, boolean, boolean): CargoInputOutputData
  makeCargoInputOutputDataForConstructionData: function(Engine.Entity): CargoInputOutputData
  
record CargoSpecializationParams    cargoClasses: {string}
    horizontalLayout: boolean
end

  CargoClassSpecialization: Recipe<CargoSpecializationParams>
end

CargoReactUtil.VehicleCargoInfoParams🔗

record CargoReactUtil.VehicleCargoInfoParams  vehicleEntity: Engine.Entity
  showEmpty: boolean
  showLoadingIndicator: boolean
  mode: GuiReactUtil.LabelMode
  cargoTypeFilter: function(CargoTypeId): boolean
  getEmptyItem: function(): TreeNodeId
end

CargoReactUtil.VehicleCargoInfoParams.vehicleEntity🔗

CargoReactUtil.VehicleCargoInfoParams.vehicleEntity: Engine.Entity

CargoReactUtil.VehicleCargoInfoParams.showEmpty🔗

CargoReactUtil.VehicleCargoInfoParams.showEmpty: boolean

CargoReactUtil.VehicleCargoInfoParams.showLoadingIndicator🔗

CargoReactUtil.VehicleCargoInfoParams.showLoadingIndicator: boolean

CargoReactUtil.VehicleCargoInfoParams.mode🔗

CargoReactUtil.VehicleCargoInfoParams.mode: GuiReactUtil.LabelMode

CargoReactUtil.VehicleCargoInfoParams.cargoTypeFilter🔗

function CargoReactUtil.VehicleCargoInfoParams.cargoTypeFilter(CargoTypeId): boolean
Parameters
  • CargoTypeId
Returns
  1. boolean

CargoReactUtil.VehicleCargoInfoParams.getEmptyItem🔗

function CargoReactUtil.VehicleCargoInfoParams.getEmptyItem(): TreeNodeId
Returns
  1. TreeNodeId

CargoReactUtil.LineCargoInfoParams🔗

record CargoReactUtil.LineCargoInfoParams  lineEntity: Engine.Entity
  makeEmptyItem: TreeNodeId
  mode: GuiReactUtil.LabelMode
end

CargoReactUtil.LineCargoInfoParams.lineEntity🔗

CargoReactUtil.LineCargoInfoParams.lineEntity: Engine.Entity

CargoReactUtil.LineCargoInfoParams.makeEmptyItem🔗

CargoReactUtil.LineCargoInfoParams.makeEmptyItem: TreeNodeId

CargoReactUtil.LineCargoInfoParams.mode🔗

CargoReactUtil.LineCargoInfoParams.mode: GuiReactUtil.LabelMode

CargoReactUtil.WarehouseCargoInfoParams🔗

record CargoReactUtil.WarehouseCargoInfoParams  warehouseEntity: Engine.Entity
  makeEmptyItem: TreeNodeId
  showTendency: boolean
  mode: GuiReactUtil.LabelMode
end

CargoReactUtil.WarehouseCargoInfoParams.warehouseEntity🔗

CargoReactUtil.WarehouseCargoInfoParams.warehouseEntity: Engine.Entity

CargoReactUtil.WarehouseCargoInfoParams.makeEmptyItem🔗

CargoReactUtil.WarehouseCargoInfoParams.makeEmptyItem: TreeNodeId

CargoReactUtil.WarehouseCargoInfoParams.showTendency🔗

CargoReactUtil.WarehouseCargoInfoParams.showTendency: boolean

CargoReactUtil.WarehouseCargoInfoParams.mode🔗

CargoReactUtil.WarehouseCargoInfoParams.mode: GuiReactUtil.LabelMode

CargoReactUtil.makeVehicleCargoInfo🔗

function CargoReactUtil.makeVehicleCargoInfo(VehicleCargoInfoParams): TreeNodeId
Parameters
  • VehicleCargoInfoParams
Returns
  1. TreeNodeId

CargoReactUtil.LineCargoInfo🔗

CargoReactUtil.LineCargoInfo: Recipe<LineCargoInfoParams>

CargoReactUtil.WarehouseCargoInfo🔗

CargoReactUtil.WarehouseCargoInfo: Recipe<WarehouseCargoInfoParams>

CargoReactUtil.makeIcon🔗

function CargoReactUtil.makeIcon(string, string, string, boolean): TreeNodeId
Parameters
  • string
  • string
  • string
  • boolean
Returns
  1. TreeNodeId

CargoReactUtil.makeCargoIcon🔗

function CargoReactUtil.makeCargoIcon(CargoTypeId, string, string, boolean, boolean, function(string) : string): TreeNodeId
Parameters
  • CargoTypeId
  • string
  • string
  • boolean
  • boolean
  • function(string): string
Returns
  1. TreeNodeId

CargoReactUtil.makeCargoClassIcon🔗

function CargoReactUtil.makeCargoClassIcon(CargoTypeId, string): TreeNodeId
Parameters
  • CargoTypeId
  • string
Returns
  1. TreeNodeId

CargoReactUtil.makeTooltipStockCompatibility🔗

function CargoReactUtil.makeTooltipStockCompatibility(Engine.Component.TransportVehicle.LoadSpeedModifiers): string
Parameters
  • Engine.Component.TransportVehicle.LoadSpeedModifiers
Returns
  1. string

CargoReactUtil.makeTooltipVehicleCompatibility🔗

function CargoReactUtil.makeTooltipVehicleCompatibility(Engine.Component.TransportVehicle.LoadSpeedModifiers): string
Parameters
  • Engine.Component.TransportVehicle.LoadSpeedModifiers
Returns
  1. string

CargoReactUtil.CargoIconLabelIndicatorParams🔗

record CargoReactUtil.CargoIconLabelIndicatorParams  cargoType: CargoTypeId
  cargoTypes: {CargoTypeId}
  iconStyle: string
  label: string
  richLabel: GuiReactUtil.RichLabel
  labelFontColor: GuiReactUtil.LabelFontColor
  labelMode: GuiReactUtil.LabelMode
  labelTooltip: string
  indicatorIconPath: string
  iconOverride: string
  loadingIndicator: TreeNodeId
  shippingState: GuiReactUtil.ShippingState
end

CargoReactUtil.CargoIconLabelIndicatorParams.cargoType🔗

CargoReactUtil.CargoIconLabelIndicatorParams.cargoType: CargoTypeId

CargoReactUtil.CargoIconLabelIndicatorParams.cargoTypes🔗

CargoReactUtil.CargoIconLabelIndicatorParams.cargoTypes: {CargoTypeId}

CargoReactUtil.CargoIconLabelIndicatorParams.iconStyle🔗

CargoReactUtil.CargoIconLabelIndicatorParams.iconStyle: string

CargoReactUtil.CargoIconLabelIndicatorParams.label🔗

CargoReactUtil.CargoIconLabelIndicatorParams.label: string

CargoReactUtil.CargoIconLabelIndicatorParams.richLabel🔗

CargoReactUtil.CargoIconLabelIndicatorParams.richLabel: GuiReactUtil.RichLabel

CargoReactUtil.CargoIconLabelIndicatorParams.labelFontColor🔗

CargoReactUtil.CargoIconLabelIndicatorParams.labelFontColor: GuiReactUtil.LabelFontColor

CargoReactUtil.CargoIconLabelIndicatorParams.labelMode🔗

CargoReactUtil.CargoIconLabelIndicatorParams.labelMode: GuiReactUtil.LabelMode

CargoReactUtil.CargoIconLabelIndicatorParams.labelTooltip🔗

CargoReactUtil.CargoIconLabelIndicatorParams.labelTooltip: string

CargoReactUtil.CargoIconLabelIndicatorParams.indicatorIconPath🔗

CargoReactUtil.CargoIconLabelIndicatorParams.indicatorIconPath: string

CargoReactUtil.CargoIconLabelIndicatorParams.iconOverride🔗

CargoReactUtil.CargoIconLabelIndicatorParams.iconOverride: string

CargoReactUtil.CargoIconLabelIndicatorParams.loadingIndicator🔗

CargoReactUtil.CargoIconLabelIndicatorParams.loadingIndicator: TreeNodeId

CargoReactUtil.CargoIconLabelIndicatorParams.shippingState🔗

CargoReactUtil.CargoIconLabelIndicatorParams.shippingState: GuiReactUtil.ShippingState

CargoReactUtil.makeCargoIconLabelIndicator🔗

function CargoReactUtil.makeCargoIconLabelIndicator(CargoIconLabelIndicatorParams): TreeNodeId
Parameters
  • CargoIconLabelIndicatorParams
Returns
  1. TreeNodeId

CargoReactUtil.CargoListParams🔗

record CargoReactUtil.CargoListParams  gameCtx: GameContext
  cargoTypeLoadSpeed: {{CargoTypeId, number}}
  allCargo: boolean
end

CargoReactUtil.CargoListParams.gameCtx🔗

CargoReactUtil.CargoListParams.gameCtx: GameContext

CargoReactUtil.CargoListParams.cargoTypeLoadSpeed🔗

CargoReactUtil.CargoListParams.cargoTypeLoadSpeed: {{CargoTypeId, number}}

CargoReactUtil.CargoListParams.allCargo🔗

CargoReactUtil.CargoListParams.allCargo: boolean

CargoReactUtil.CargoList🔗

CargoReactUtil.CargoList: Recipe<CargoListParams>

CargoReactUtil.LocationCargoListParams🔗

 
record CargoReactUtil.LocationCargoListParams  
enum LocationCargoListLayout    "FLOW"
    "HORIZONTAL"
    "VERTICAL"
end

  locationParams: CargoUtil.CargoLocationParams
  cargoTypeFilter: function(CargoTypeId): boolean
  layout: LocationCargoListLayout
  sortOrder: CargoUtil.CargoListSortOrder
  groupIfAllEmpty: boolean
  getCargoItemLayout: function(CargoUtil.CargoTypeInfo, GuiReactUtil.ShippingState): TreeNodeId
  getFrownyIconLayout: function(UtilCargo.CargoQualityData, boolean, GuiReactUtil.ShippingState): TreeNodeId
  getEmptyItem: function(): TreeNodeId
  shippingState: GuiReactUtil.ShippingState
end

CargoReactUtil.LocationCargoListParams.LocationCargoListLayout🔗

enum CargoReactUtil.LocationCargoListParams.LocationCargoListLayout  "FLOW"
  "HORIZONTAL"
  "VERTICAL"
end

CargoReactUtil.LocationCargoListParams.LocationCargoListLayout."FLOW"🔗

CargoReactUtil.LocationCargoListParams.LocationCargoListLayout."HORIZONTAL"🔗

CargoReactUtil.LocationCargoListParams.LocationCargoListLayout."VERTICAL"🔗

CargoReactUtil.LocationCargoListParams.locationParams🔗

CargoReactUtil.LocationCargoListParams.locationParams: CargoUtil.CargoLocationParams

CargoReactUtil.LocationCargoListParams.cargoTypeFilter🔗

function CargoReactUtil.LocationCargoListParams.cargoTypeFilter(CargoTypeId): boolean
Parameters
  • CargoTypeId
Returns
  1. boolean

CargoReactUtil.LocationCargoListParams.layout🔗

CargoReactUtil.LocationCargoListParams.layout: LocationCargoListLayout

CargoReactUtil.LocationCargoListParams.sortOrder🔗

CargoReactUtil.LocationCargoListParams.sortOrder: CargoUtil.CargoListSortOrder

CargoReactUtil.LocationCargoListParams.groupIfAllEmpty🔗

CargoReactUtil.LocationCargoListParams.groupIfAllEmpty: boolean

CargoReactUtil.LocationCargoListParams.getCargoItemLayout🔗

function CargoReactUtil.LocationCargoListParams.getCargoItemLayout(CargoUtil.CargoTypeInfo, GuiReactUtil.ShippingState): TreeNodeId
Parameters
  • CargoUtil.CargoTypeInfo
  • GuiReactUtil.ShippingState
Returns
  1. TreeNodeId

CargoReactUtil.LocationCargoListParams.getFrownyIconLayout🔗

function CargoReactUtil.LocationCargoListParams.getFrownyIconLayout(UtilCargo.CargoQualityData, boolean, GuiReactUtil.ShippingState): TreeNodeId
Parameters
  • UtilCargo.CargoQualityData
  • boolean
  • GuiReactUtil.ShippingState
Returns
  1. TreeNodeId

CargoReactUtil.LocationCargoListParams.getEmptyItem🔗

function CargoReactUtil.LocationCargoListParams.getEmptyItem(): TreeNodeId
Returns
  1. TreeNodeId

CargoReactUtil.LocationCargoListParams.shippingState🔗

CargoReactUtil.LocationCargoListParams.shippingState: GuiReactUtil.ShippingState

CargoReactUtil.LocationCargoList🔗

CargoReactUtil.LocationCargoList: Recipe<LocationCargoListParams>

CargoReactUtil.CargoInputOutputData🔗

 
record CargoReactUtil.CargoInputOutputData  
record CargoData    count: integer
    max: integer
    cargoType: CargoTypeId
    allCargoType: boolean
end

  inputs: {CargoData}
  outputs: {CargoData}
end

CargoReactUtil.CargoInputOutputData.CargoData🔗

record CargoReactUtil.CargoInputOutputData.CargoData  count: integer
  max: integer
  cargoType: CargoTypeId
  allCargoType: boolean
end

CargoReactUtil.CargoInputOutputData.CargoData.count🔗

CargoReactUtil.CargoInputOutputData.CargoData.count: integer

CargoReactUtil.CargoInputOutputData.CargoData.max🔗

CargoReactUtil.CargoInputOutputData.CargoData.max: integer

CargoReactUtil.CargoInputOutputData.CargoData.cargoType🔗

CargoReactUtil.CargoInputOutputData.CargoData.cargoType: CargoTypeId

CargoReactUtil.CargoInputOutputData.CargoData.allCargoType🔗

CargoReactUtil.CargoInputOutputData.CargoData.allCargoType: boolean

CargoReactUtil.CargoInputOutputData.inputs🔗

CargoReactUtil.CargoInputOutputData.inputs: {CargoData}

CargoReactUtil.CargoInputOutputData.outputs🔗

CargoReactUtil.CargoInputOutputData.outputs: {CargoData}

CargoReactUtil.CargoInputOutputParams🔗

record CargoReactUtil.CargoInputOutputParams  data: CargoInputOutputData
  inputDistrict: LandUseType
  outputDistrict: LandUseType
  showPercentage: boolean
end

CargoReactUtil.CargoInputOutputParams.data🔗

CargoReactUtil.CargoInputOutputParams.data: CargoInputOutputData

CargoReactUtil.CargoInputOutputParams.inputDistrict🔗

CargoReactUtil.CargoInputOutputParams.inputDistrict: LandUseType

CargoReactUtil.CargoInputOutputParams.outputDistrict🔗

CargoReactUtil.CargoInputOutputParams.outputDistrict: LandUseType

CargoReactUtil.CargoInputOutputParams.showPercentage🔗

CargoReactUtil.CargoInputOutputParams.showPercentage: boolean

CargoReactUtil.CargoInputOutputIndicator🔗

CargoReactUtil.CargoInputOutputIndicator: Recipe<CargoInputOutputParams>

CargoReactUtil.CargoIconLabelIndicator🔗

CargoReactUtil.CargoIconLabelIndicator: Recipe<CargoIconLabelIndicatorParams>

CargoReactUtil.makeCargoInputOutputDataForStorage🔗

function CargoReactUtil.makeCargoInputOutputDataForStorage(Engine.Entity): CargoReactUtil.CargoInputOutputData
Parameters
  • Engine.Entity
Returns
  1. CargoReactUtil.CargoInputOutputData

CargoReactUtil.makeCargoInputOutputDataForStocklist🔗

function CargoReactUtil.makeCargoInputOutputDataForStocklist(Engine.Entity, boolean, boolean, boolean, boolean): CargoInputOutputData
Parameters
  • Engine.Entity
  • boolean
  • boolean
  • boolean
  • boolean
Returns
  1. CargoInputOutputData

CargoReactUtil.makeCargoInputOutputDataForConstructionData🔗

function CargoReactUtil.makeCargoInputOutputDataForConstructionData(Engine.Entity): CargoInputOutputData
Parameters
  • Engine.Entity
Returns
  1. CargoInputOutputData

CargoReactUtil.CargoSpecializationParams🔗

record CargoReactUtil.CargoSpecializationParams  cargoClasses: {string}
  horizontalLayout: boolean
end

CargoReactUtil.CargoSpecializationParams.cargoClasses🔗

CargoReactUtil.CargoSpecializationParams.cargoClasses: {string}

CargoReactUtil.CargoSpecializationParams.horizontalLayout🔗

CargoReactUtil.CargoSpecializationParams.horizontalLayout: boolean

CargoReactUtil.CargoClassSpecialization🔗

CargoReactUtil.CargoClassSpecialization: Recipe<CargoSpecializationParams>