Module content.gui.construction.construction_desc_react_util🔗

 
global record ConstructionDescReactUtil  
record CargoAndAmount    cargoType: integer
    amount: integer
end

  
record MinMax    min: number
    max: number
    range: number
end

  
record Effect    type: string
    value: number
    carrier: string
end

  
record Numbers    companyRank: MinMax
    xpIncrease: MinMax
    trafficRatingIncrease: MinMax
    reputationRecoveryBoost: MinMax
    noise: MinMax
    pollution: MinMax
    noiseModifier: MinMax
    pollutionModifier: MinMax
    maxSpeedModifier: MinMax
    speedLimit: MinMax
    numLanes: MinMax
    numAvailable: integer
    capacityPassenger: MinMax
    comfortFactor: MinMax
    effects: {Effect}
    cost: MinMax
    maintenanceCost: MinMax
    maintenanceCapacity: MinMax
    costPerKm: boolean
    cargoCosts: {ConstructionDescReactUtil.CargoAndAmount}
    depotCapacity: MinMax
    permitKey: ResName
    perkCategory: CompanyMetadata.ConstructionDesc.PerkCategory
    cooldownInSeconds: number
end

  
enum LayoutType    "BelowImageLeft"
    "BelowImageRight"
    "BottomLeft"
    "BottomRight"
    "TopLeft"
    "TopRight"
end

  
record FormatNumberDesc    icon: string
    text: string
    singleLine: boolean
    attributeBubbleStyle: string
    textFirst: boolean
    layoutType: LayoutType
end

  getAttributesFromConstructionResult: function(ConstructionResult): {string : {number, number, {string}}}
  collectNumbers: function(ConstructionDescMetadata, ConstructionDefinition, ConstructionReactUtil.ItemDisableCache, {string : {number, number, {string}}}): Numbers
  formatNumbers: function(Numbers): {{FormatNumberDesc}}
  
record ConstructionInfoNumberListParam    line: {FormatNumberDesc}
    vertical: boolean
    useTitleFont: boolean
end

  ConstructionInfoNumberList: Recipe<ConstructionInfoNumberListParam>
  
record DepotHudIconsConfigParams    depotType: ConstructionActionHudIconConstructionType
end

  
record StationHudIconsConfigParams    cargo: boolean
    rail: boolean
end

  getDepotHudIconsConfig: function(ConstructionDescReactUtil.DepotHudIconsConfigParams): ConstructionActionHudIcons
  getStationHudIconsConfig: function(ConstructionDescReactUtil.StationHudIconsConfigParams): ConstructionActionHudIcons
  getStreetBuilderHudIconsConfig: function(): ConstructionActionHudIcons
  getTrackBuilderHudIconsConfig: function(): ConstructionActionHudIcons
  getLandmarkConstructionHudIconsConfig: function(): ConstructionActionHudIcons
  getDefaultHudIconsConfig: function(): ConstructionActionHudIcons
  formatEffectPercentage: function(number): string
  vehicleEffectMoreIsBetter: function(string): boolean
  getVehicleEffectName: function(string, string): string
end

Category: globals🔗

ConstructionDescReactUtil🔗

 
global record ConstructionDescReactUtil  
record CargoAndAmount    cargoType: integer
    amount: integer
end

  
record MinMax    min: number
    max: number
    range: number
end

  
record Effect    type: string
    value: number
    carrier: string
end

  
record Numbers    companyRank: MinMax
    xpIncrease: MinMax
    trafficRatingIncrease: MinMax
    reputationRecoveryBoost: MinMax
    noise: MinMax
    pollution: MinMax
    noiseModifier: MinMax
    pollutionModifier: MinMax
    maxSpeedModifier: MinMax
    speedLimit: MinMax
    numLanes: MinMax
    numAvailable: integer
    capacityPassenger: MinMax
    comfortFactor: MinMax
    effects: {Effect}
    cost: MinMax
    maintenanceCost: MinMax
    maintenanceCapacity: MinMax
    costPerKm: boolean
    cargoCosts: {ConstructionDescReactUtil.CargoAndAmount}
    depotCapacity: MinMax
    permitKey: ResName
    perkCategory: CompanyMetadata.ConstructionDesc.PerkCategory
    cooldownInSeconds: number
end

  
enum LayoutType    "BelowImageLeft"
    "BelowImageRight"
    "BottomLeft"
    "BottomRight"
    "TopLeft"
    "TopRight"
end

  
record FormatNumberDesc    icon: string
    text: string
    singleLine: boolean
    attributeBubbleStyle: string
    textFirst: boolean
    layoutType: LayoutType
end

  getAttributesFromConstructionResult: function(ConstructionResult): {string : {number, number, {string}}}
  collectNumbers: function(ConstructionDescMetadata, ConstructionDefinition, ConstructionReactUtil.ItemDisableCache, {string : {number, number, {string}}}): Numbers
  formatNumbers: function(Numbers): {{FormatNumberDesc}}
  
record ConstructionInfoNumberListParam    line: {FormatNumberDesc}
    vertical: boolean
    useTitleFont: boolean
end

  ConstructionInfoNumberList: Recipe<ConstructionInfoNumberListParam>
  
record DepotHudIconsConfigParams    depotType: ConstructionActionHudIconConstructionType
end

  
record StationHudIconsConfigParams    cargo: boolean
    rail: boolean
end

  getDepotHudIconsConfig: function(ConstructionDescReactUtil.DepotHudIconsConfigParams): ConstructionActionHudIcons
  getStationHudIconsConfig: function(ConstructionDescReactUtil.StationHudIconsConfigParams): ConstructionActionHudIcons
  getStreetBuilderHudIconsConfig: function(): ConstructionActionHudIcons
  getTrackBuilderHudIconsConfig: function(): ConstructionActionHudIcons
  getLandmarkConstructionHudIconsConfig: function(): ConstructionActionHudIcons
  getDefaultHudIconsConfig: function(): ConstructionActionHudIcons
  formatEffectPercentage: function(number): string
  vehicleEffectMoreIsBetter: function(string): boolean
  getVehicleEffectName: function(string, string): string
end

ConstructionDescReactUtil.CargoAndAmount🔗

record ConstructionDescReactUtil.CargoAndAmount  cargoType: integer
  amount: integer
end

ConstructionDescReactUtil.CargoAndAmount.cargoType🔗

ConstructionDescReactUtil.CargoAndAmount.cargoType: integer

ConstructionDescReactUtil.CargoAndAmount.amount🔗

ConstructionDescReactUtil.CargoAndAmount.amount: integer

ConstructionDescReactUtil.MinMax🔗

record ConstructionDescReactUtil.MinMax  min: number
  max: number
  range: number
end

ConstructionDescReactUtil.MinMax.min🔗

ConstructionDescReactUtil.MinMax.min: number

ConstructionDescReactUtil.MinMax.max🔗

ConstructionDescReactUtil.MinMax.max: number

ConstructionDescReactUtil.MinMax.range🔗

ConstructionDescReactUtil.MinMax.range: number

ConstructionDescReactUtil.Effect🔗

record ConstructionDescReactUtil.Effect  type: string
  value: number
  carrier: string
end

ConstructionDescReactUtil.Effect.type🔗

ConstructionDescReactUtil.Effect.type: string

ConstructionDescReactUtil.Effect.value🔗

ConstructionDescReactUtil.Effect.value: number

ConstructionDescReactUtil.Effect.carrier🔗

ConstructionDescReactUtil.Effect.carrier: string

ConstructionDescReactUtil.Numbers🔗

record ConstructionDescReactUtil.Numbers  companyRank: MinMax
  xpIncrease: MinMax
  trafficRatingIncrease: MinMax
  reputationRecoveryBoost: MinMax
  noise: MinMax
  pollution: MinMax
  noiseModifier: MinMax
  pollutionModifier: MinMax
  maxSpeedModifier: MinMax
  speedLimit: MinMax
  numLanes: MinMax
  numAvailable: integer
  capacityPassenger: MinMax
  comfortFactor: MinMax
  effects: {Effect}
  cost: MinMax
  maintenanceCost: MinMax
  maintenanceCapacity: MinMax
  costPerKm: boolean
  cargoCosts: {ConstructionDescReactUtil.CargoAndAmount}
  depotCapacity: MinMax
  permitKey: ResName
  perkCategory: CompanyMetadata.ConstructionDesc.PerkCategory
  cooldownInSeconds: number
end

ConstructionDescReactUtil.Numbers.companyRank🔗

ConstructionDescReactUtil.Numbers.companyRank: MinMax

ConstructionDescReactUtil.Numbers.xpIncrease🔗

ConstructionDescReactUtil.Numbers.xpIncrease: MinMax

ConstructionDescReactUtil.Numbers.trafficRatingIncrease🔗

ConstructionDescReactUtil.Numbers.trafficRatingIncrease: MinMax

ConstructionDescReactUtil.Numbers.reputationRecoveryBoost🔗

ConstructionDescReactUtil.Numbers.reputationRecoveryBoost: MinMax

ConstructionDescReactUtil.Numbers.noise🔗

ConstructionDescReactUtil.Numbers.noise: MinMax

ConstructionDescReactUtil.Numbers.pollution🔗

ConstructionDescReactUtil.Numbers.pollution: MinMax

ConstructionDescReactUtil.Numbers.noiseModifier🔗

ConstructionDescReactUtil.Numbers.noiseModifier: MinMax

ConstructionDescReactUtil.Numbers.pollutionModifier🔗

ConstructionDescReactUtil.Numbers.pollutionModifier: MinMax

ConstructionDescReactUtil.Numbers.maxSpeedModifier🔗

ConstructionDescReactUtil.Numbers.maxSpeedModifier: MinMax

ConstructionDescReactUtil.Numbers.speedLimit🔗

ConstructionDescReactUtil.Numbers.speedLimit: MinMax

ConstructionDescReactUtil.Numbers.numLanes🔗

ConstructionDescReactUtil.Numbers.numLanes: MinMax

ConstructionDescReactUtil.Numbers.numAvailable🔗

ConstructionDescReactUtil.Numbers.numAvailable: integer

ConstructionDescReactUtil.Numbers.capacityPassenger🔗

ConstructionDescReactUtil.Numbers.capacityPassenger: MinMax

ConstructionDescReactUtil.Numbers.comfortFactor🔗

ConstructionDescReactUtil.Numbers.comfortFactor: MinMax

ConstructionDescReactUtil.Numbers.effects🔗

ConstructionDescReactUtil.Numbers.effects: {Effect}

ConstructionDescReactUtil.Numbers.cost🔗

ConstructionDescReactUtil.Numbers.cost: MinMax

ConstructionDescReactUtil.Numbers.maintenanceCost🔗

ConstructionDescReactUtil.Numbers.maintenanceCost: MinMax

ConstructionDescReactUtil.Numbers.maintenanceCapacity🔗

ConstructionDescReactUtil.Numbers.maintenanceCapacity: MinMax

ConstructionDescReactUtil.Numbers.costPerKm🔗

ConstructionDescReactUtil.Numbers.costPerKm: boolean

ConstructionDescReactUtil.Numbers.cargoCosts🔗

ConstructionDescReactUtil.Numbers.cargoCosts: {ConstructionDescReactUtil.CargoAndAmount}

ConstructionDescReactUtil.Numbers.depotCapacity🔗

ConstructionDescReactUtil.Numbers.depotCapacity: MinMax

ConstructionDescReactUtil.Numbers.permitKey🔗

ConstructionDescReactUtil.Numbers.permitKey: ResName

ConstructionDescReactUtil.Numbers.perkCategory🔗

ConstructionDescReactUtil.Numbers.perkCategory: CompanyMetadata.ConstructionDesc.PerkCategory

ConstructionDescReactUtil.Numbers.cooldownInSeconds🔗

ConstructionDescReactUtil.Numbers.cooldownInSeconds: number

ConstructionDescReactUtil.LayoutType🔗

enum ConstructionDescReactUtil.LayoutType  "BelowImageLeft"
  "BelowImageRight"
  "BottomLeft"
  "BottomRight"
  "TopLeft"
  "TopRight"
end

ConstructionDescReactUtil.LayoutType."BelowImageLeft"🔗

ConstructionDescReactUtil.LayoutType."BelowImageRight"🔗

ConstructionDescReactUtil.LayoutType."BottomLeft"🔗

ConstructionDescReactUtil.LayoutType."BottomRight"🔗

ConstructionDescReactUtil.LayoutType."TopLeft"🔗

ConstructionDescReactUtil.LayoutType."TopRight"🔗

ConstructionDescReactUtil.FormatNumberDesc🔗

record ConstructionDescReactUtil.FormatNumberDesc  icon: string
  text: string
  singleLine: boolean
  attributeBubbleStyle: string
  textFirst: boolean
  layoutType: LayoutType
end

ConstructionDescReactUtil.FormatNumberDesc.icon🔗

ConstructionDescReactUtil.FormatNumberDesc.icon: string

ConstructionDescReactUtil.FormatNumberDesc.text🔗

ConstructionDescReactUtil.FormatNumberDesc.text: string

ConstructionDescReactUtil.FormatNumberDesc.singleLine🔗

ConstructionDescReactUtil.FormatNumberDesc.singleLine: boolean

ConstructionDescReactUtil.FormatNumberDesc.attributeBubbleStyle🔗

ConstructionDescReactUtil.FormatNumberDesc.attributeBubbleStyle: string

ConstructionDescReactUtil.FormatNumberDesc.textFirst🔗

ConstructionDescReactUtil.FormatNumberDesc.textFirst: boolean

ConstructionDescReactUtil.FormatNumberDesc.layoutType🔗

ConstructionDescReactUtil.FormatNumberDesc.layoutType: LayoutType

ConstructionDescReactUtil.getAttributesFromConstructionResult🔗

function ConstructionDescReactUtil.getAttributesFromConstructionResult(ConstructionResult): {string : {number, number, {string}}}
Parameters
  • ConstructionResult
Returns
  1. {string : {number, number, {string}}}

ConstructionDescReactUtil.collectNumbers🔗

function ConstructionDescReactUtil.collectNumbers(ConstructionDescMetadata, ConstructionDefinition, ConstructionReactUtil.ItemDisableCache, {string : {number, number, {string}}}): Numbers
Parameters
  • ConstructionDescMetadata
  • ConstructionDefinition
  • ConstructionReactUtil.ItemDisableCache
  • {string : {number, number, {string}}}
Returns
  1. Numbers

ConstructionDescReactUtil.formatNumbers🔗

function ConstructionDescReactUtil.formatNumbers(Numbers): {{FormatNumberDesc}}
Parameters
  • Numbers
Returns
  1. {{FormatNumberDesc}}

ConstructionDescReactUtil.ConstructionInfoNumberListParam🔗

record ConstructionDescReactUtil.ConstructionInfoNumberListParam  line: {FormatNumberDesc}
  vertical: boolean
  useTitleFont: boolean
end

ConstructionDescReactUtil.ConstructionInfoNumberListParam.line🔗

ConstructionDescReactUtil.ConstructionInfoNumberListParam.line: {FormatNumberDesc}

ConstructionDescReactUtil.ConstructionInfoNumberListParam.vertical🔗

ConstructionDescReactUtil.ConstructionInfoNumberListParam.vertical: boolean

ConstructionDescReactUtil.ConstructionInfoNumberListParam.useTitleFont🔗

ConstructionDescReactUtil.ConstructionInfoNumberListParam.useTitleFont: boolean

ConstructionDescReactUtil.ConstructionInfoNumberList🔗

ConstructionDescReactUtil.ConstructionInfoNumberList: Recipe<ConstructionInfoNumberListParam>

ConstructionDescReactUtil.DepotHudIconsConfigParams🔗

record ConstructionDescReactUtil.DepotHudIconsConfigParams  depotType: ConstructionActionHudIconConstructionType
end

ConstructionDescReactUtil.DepotHudIconsConfigParams.depotType🔗

ConstructionDescReactUtil.DepotHudIconsConfigParams.depotType: ConstructionActionHudIconConstructionType

ConstructionDescReactUtil.StationHudIconsConfigParams🔗

record ConstructionDescReactUtil.StationHudIconsConfigParams  cargo: boolean
  rail: boolean
end

ConstructionDescReactUtil.StationHudIconsConfigParams.cargo🔗

ConstructionDescReactUtil.StationHudIconsConfigParams.cargo: boolean

ConstructionDescReactUtil.StationHudIconsConfigParams.rail🔗

ConstructionDescReactUtil.StationHudIconsConfigParams.rail: boolean

ConstructionDescReactUtil.getDepotHudIconsConfig🔗

function ConstructionDescReactUtil.getDepotHudIconsConfig(ConstructionDescReactUtil.DepotHudIconsConfigParams): ConstructionActionHudIcons
Parameters
  • ConstructionDescReactUtil.DepotHudIconsConfigParams
Returns
  1. ConstructionActionHudIcons

ConstructionDescReactUtil.getStationHudIconsConfig🔗

function ConstructionDescReactUtil.getStationHudIconsConfig(ConstructionDescReactUtil.StationHudIconsConfigParams): ConstructionActionHudIcons
Parameters
  • ConstructionDescReactUtil.StationHudIconsConfigParams
Returns
  1. ConstructionActionHudIcons

ConstructionDescReactUtil.getStreetBuilderHudIconsConfig🔗

function ConstructionDescReactUtil.getStreetBuilderHudIconsConfig(): ConstructionActionHudIcons
Returns
  1. ConstructionActionHudIcons

ConstructionDescReactUtil.getTrackBuilderHudIconsConfig🔗

function ConstructionDescReactUtil.getTrackBuilderHudIconsConfig(): ConstructionActionHudIcons
Returns
  1. ConstructionActionHudIcons

ConstructionDescReactUtil.getLandmarkConstructionHudIconsConfig🔗

function ConstructionDescReactUtil.getLandmarkConstructionHudIconsConfig(): ConstructionActionHudIcons
Returns
  1. ConstructionActionHudIcons

ConstructionDescReactUtil.getDefaultHudIconsConfig🔗

function ConstructionDescReactUtil.getDefaultHudIconsConfig(): ConstructionActionHudIcons
Returns
  1. ConstructionActionHudIcons

ConstructionDescReactUtil.formatEffectPercentage🔗

function ConstructionDescReactUtil.formatEffectPercentage(number): string
Parameters
  • number
Returns
  1. string

ConstructionDescReactUtil.vehicleEffectMoreIsBetter🔗

function ConstructionDescReactUtil.vehicleEffectMoreIsBetter(string): boolean
Parameters
  • string
Returns
  1. boolean

ConstructionDescReactUtil.getVehicleEffectName🔗

function ConstructionDescReactUtil.getVehicleEffectName(string, string): string
Parameters
  • string
  • string
Returns
  1. string