Module content.game_mechanics.towns.towns🔗

global record CargoTypeSupplyDemand  cargoTypeId: CargoTypeId
  supply: integer
  demand: integer
end


global record CargoTypeSupplyDemands  residential: {CargoTypeSupplyDemand}
  commercial: {CargoTypeSupplyDemand}
  industrial: {CargoTypeSupplyDemand}
end


global record GrowthSummand  label: string
  value: integer
end


global record LandUseGrowth  summands: {GrowthSummand}
end


 
global record ProposalStats  
record TownProposalStats    
record Building      plotSize: integer
      level: integer
end

    
record TerrainMod      brushVolumeAdded: number
      brushVolumeRemoved: number
      terrainAlignmentVolumeAdded: number
      terrainAlignmentVolumeRemoved: number
end

    addedTrees: number
    removedTrees: number
    addedRocks: number
    removedRocks: number
    removedBuildings: {Building}
    fractionDistrictRemoved: number
    terrainMod: TerrainMod
    tunnelVolumeAdded: number
end

  townStats: {Engine.Entity : TownProposalStats}
end


global enum RatingLevel  "Excellent"
  "Good"
  "Mediocre"
  "Poor"
  "VeryGood"
  "VeryPoor"
end


global record StationSamples  loaded: integer
  lost: integer
end


 
global record TownAuthorityEventFactors  
enum EventType    "DemolishedTownBuilding"
    "FailedSubsidy"
    "Rocks"
    "SeveredConnection"
    "TerrainModification"
    "Trees"
    "Unknown"
end

  score: number
  marketingInitiatedTimestamp: integer
  marketingParams: TownMarketingMetadata.ConstructionDesc
  itemDelivery: number
  numItemsDelivered: integer
  averageItemsDelivered: number
  onTimeItemDelivery: number
  reasonToPenalty: {EventType : number}
end


global record TownAuthoritySeveredConnection  penalty: number
  refund: number
  severedTimestamp: integer
end


global record TownCapacities  residential: integer
  commercial: integer
  industrial: integer
end


global record TownCapacityUsages  residential: UtilTown.TownCapacityUsage
  commercial: UtilTown.TownCapacityUsage
  industrial: UtilTown.TownCapacityUsage
end


global record TownConstructionBoni  xpIncrease: number
  trafficRatingIncrease: number
  reputationRecoveryBoost: number
end


global record TownLegacyUtil  currentVersion: integer
  updateLegacyState: function(TownsState)
end


 
global record TownProposalActions  
enum Action    "BuildAirport"
    "BuildStation"
    "DestroyBuilding"
end

  townActions: {Engine.Entity : {Action}}
end


global record TownProposalImpact  trees: number
  rocks: number
  terrainModification: number
  demolishedTownBuilding: number
  landscaping: number
end

global type TownRatingsSensitivityConfig = {TownRatingsSensitivityConfigName : integer}

global enum TownRatingsSensitivityConfigName  "SensitivityCargoDelivery"
  "SensitivityNoise"
  "SensitivityPeopleHappiness"
  "SensitivityPollution"
  "SensitivityTrafficCongestion"
  "SensitivityUrbanCare"
end


 
global record TownState  townEntity: EntityUtil.EntityAndRevision
  sizeFactors: {number}
  authorityScore: number
  deliveryRating: RatingLevel
  constructionBoni: TownConstructionBoni
  eventFactors: TownAuthorityEventFactors
  lastApplyTime: integer
  
record CachedRating    value: number
    critical: boolean
    warning: boolean
end

  cachedRatings: {string : CachedRating}
  ratingSensitivity: {string : number}
end


global record TownsState  townStates: {TownState}
  version: integer
end

Category: globals🔗

CargoTypeSupplyDemand🔗

global record CargoTypeSupplyDemand  cargoTypeId: CargoTypeId
  supply: integer
  demand: integer
end

CargoTypeSupplyDemand.cargoTypeId🔗

CargoTypeSupplyDemand.cargoTypeId: CargoTypeId

CargoTypeSupplyDemand.supply🔗

CargoTypeSupplyDemand.supply: integer

CargoTypeSupplyDemand.demand🔗

CargoTypeSupplyDemand.demand: integer

CargoTypeSupplyDemands🔗

global record CargoTypeSupplyDemands  residential: {CargoTypeSupplyDemand}
  commercial: {CargoTypeSupplyDemand}
  industrial: {CargoTypeSupplyDemand}
end

CargoTypeSupplyDemands.residential🔗

CargoTypeSupplyDemands.residential: {CargoTypeSupplyDemand}

CargoTypeSupplyDemands.commercial🔗

CargoTypeSupplyDemands.commercial: {CargoTypeSupplyDemand}

CargoTypeSupplyDemands.industrial🔗

CargoTypeSupplyDemands.industrial: {CargoTypeSupplyDemand}

GrowthSummand🔗

global record GrowthSummand  label: string
  value: integer
end

GrowthSummand.label🔗

GrowthSummand.label: string

GrowthSummand.value🔗

GrowthSummand.value: integer

LandUseGrowth🔗

global record LandUseGrowth  summands: {GrowthSummand}
end

LandUseGrowth.summands🔗

LandUseGrowth.summands: {GrowthSummand}

ProposalStats🔗

 
global record ProposalStats  
record TownProposalStats    
record Building      plotSize: integer
      level: integer
end

    
record TerrainMod      brushVolumeAdded: number
      brushVolumeRemoved: number
      terrainAlignmentVolumeAdded: number
      terrainAlignmentVolumeRemoved: number
end

    addedTrees: number
    removedTrees: number
    addedRocks: number
    removedRocks: number
    removedBuildings: {Building}
    fractionDistrictRemoved: number
    terrainMod: TerrainMod
    tunnelVolumeAdded: number
end

  townStats: {Engine.Entity : TownProposalStats}
end

ProposalStats.TownProposalStats🔗

 
record ProposalStats.TownProposalStats  
record Building    plotSize: integer
    level: integer
end

  
record TerrainMod    brushVolumeAdded: number
    brushVolumeRemoved: number
    terrainAlignmentVolumeAdded: number
    terrainAlignmentVolumeRemoved: number
end

  addedTrees: number
  removedTrees: number
  addedRocks: number
  removedRocks: number
  removedBuildings: {Building}
  fractionDistrictRemoved: number
  terrainMod: TerrainMod
  tunnelVolumeAdded: number
end

ProposalStats.TownProposalStats.Building🔗

record ProposalStats.TownProposalStats.Building  plotSize: integer
  level: integer
end

ProposalStats.TownProposalStats.Building.plotSize🔗

ProposalStats.TownProposalStats.Building.plotSize: integer

ProposalStats.TownProposalStats.Building.level🔗

ProposalStats.TownProposalStats.Building.level: integer

ProposalStats.TownProposalStats.TerrainMod🔗

record ProposalStats.TownProposalStats.TerrainMod  brushVolumeAdded: number
  brushVolumeRemoved: number
  terrainAlignmentVolumeAdded: number
  terrainAlignmentVolumeRemoved: number
end

ProposalStats.TownProposalStats.TerrainMod.brushVolumeAdded🔗

ProposalStats.TownProposalStats.TerrainMod.brushVolumeAdded: number

ProposalStats.TownProposalStats.TerrainMod.brushVolumeRemoved🔗

ProposalStats.TownProposalStats.TerrainMod.brushVolumeRemoved: number

ProposalStats.TownProposalStats.TerrainMod.terrainAlignmentVolumeAdded🔗

ProposalStats.TownProposalStats.TerrainMod.terrainAlignmentVolumeAdded: number

ProposalStats.TownProposalStats.TerrainMod.terrainAlignmentVolumeRemoved🔗

ProposalStats.TownProposalStats.TerrainMod.terrainAlignmentVolumeRemoved: number

ProposalStats.TownProposalStats.addedTrees🔗

ProposalStats.TownProposalStats.addedTrees: number

ProposalStats.TownProposalStats.removedTrees🔗

ProposalStats.TownProposalStats.removedTrees: number

ProposalStats.TownProposalStats.addedRocks🔗

ProposalStats.TownProposalStats.addedRocks: number

ProposalStats.TownProposalStats.removedRocks🔗

ProposalStats.TownProposalStats.removedRocks: number

ProposalStats.TownProposalStats.removedBuildings🔗

ProposalStats.TownProposalStats.removedBuildings: {Building}

ProposalStats.TownProposalStats.fractionDistrictRemoved🔗

ProposalStats.TownProposalStats.fractionDistrictRemoved: number

ProposalStats.TownProposalStats.terrainMod🔗

ProposalStats.TownProposalStats.terrainMod: TerrainMod

ProposalStats.TownProposalStats.tunnelVolumeAdded🔗

ProposalStats.TownProposalStats.tunnelVolumeAdded: number

ProposalStats.townStats🔗

ProposalStats.townStats: {Engine.Entity : TownProposalStats}

RatingLevel🔗

global enum RatingLevel  "Excellent"
  "Good"
  "Mediocre"
  "Poor"
  "VeryGood"
  "VeryPoor"
end

RatingLevel."Excellent"🔗

RatingLevel."Good"🔗

RatingLevel."Mediocre"🔗

RatingLevel."Poor"🔗

RatingLevel."VeryGood"🔗

RatingLevel."VeryPoor"🔗

StationSamples🔗

global record StationSamples  loaded: integer
  lost: integer
end

StationSamples.loaded🔗

StationSamples.loaded: integer

StationSamples.lost🔗

StationSamples.lost: integer

TownAuthorityEventFactors🔗

 
global record TownAuthorityEventFactors  
enum EventType    "DemolishedTownBuilding"
    "FailedSubsidy"
    "Rocks"
    "SeveredConnection"
    "TerrainModification"
    "Trees"
    "Unknown"
end

  score: number
  marketingInitiatedTimestamp: integer
  marketingParams: TownMarketingMetadata.ConstructionDesc
  itemDelivery: number
  numItemsDelivered: integer
  averageItemsDelivered: number
  onTimeItemDelivery: number
  reasonToPenalty: {EventType : number}
end

TownAuthorityEventFactors.EventType🔗

enum TownAuthorityEventFactors.EventType  "DemolishedTownBuilding"
  "FailedSubsidy"
  "Rocks"
  "SeveredConnection"
  "TerrainModification"
  "Trees"
  "Unknown"
end

TownAuthorityEventFactors.EventType."DemolishedTownBuilding"🔗

TownAuthorityEventFactors.EventType."FailedSubsidy"🔗

TownAuthorityEventFactors.EventType."Rocks"🔗

TownAuthorityEventFactors.EventType."SeveredConnection"🔗

TownAuthorityEventFactors.EventType."TerrainModification"🔗

TownAuthorityEventFactors.EventType."Trees"🔗

TownAuthorityEventFactors.EventType."Unknown"🔗

TownAuthorityEventFactors.score🔗

TownAuthorityEventFactors.score: number

TownAuthorityEventFactors.marketingInitiatedTimestamp🔗

TownAuthorityEventFactors.marketingInitiatedTimestamp: integer

TownAuthorityEventFactors.marketingParams🔗

TownAuthorityEventFactors.marketingParams: TownMarketingMetadata.ConstructionDesc

TownAuthorityEventFactors.itemDelivery🔗

TownAuthorityEventFactors.itemDelivery: number

TownAuthorityEventFactors.numItemsDelivered🔗

TownAuthorityEventFactors.numItemsDelivered: integer

TownAuthorityEventFactors.averageItemsDelivered🔗

TownAuthorityEventFactors.averageItemsDelivered: number

TownAuthorityEventFactors.onTimeItemDelivery🔗

TownAuthorityEventFactors.onTimeItemDelivery: number

TownAuthorityEventFactors.reasonToPenalty🔗

TownAuthorityEventFactors.reasonToPenalty: {EventType : number}

TownAuthoritySeveredConnection🔗

global record TownAuthoritySeveredConnection  penalty: number
  refund: number
  severedTimestamp: integer
end

TownAuthoritySeveredConnection.penalty🔗

TownAuthoritySeveredConnection.penalty: number

TownAuthoritySeveredConnection.refund🔗

TownAuthoritySeveredConnection.refund: number

TownAuthoritySeveredConnection.severedTimestamp🔗

TownAuthoritySeveredConnection.severedTimestamp: integer

TownCapacities🔗

global record TownCapacities  residential: integer
  commercial: integer
  industrial: integer
end

TownCapacities.residential🔗

TownCapacities.residential: integer

TownCapacities.commercial🔗

TownCapacities.commercial: integer

TownCapacities.industrial🔗

TownCapacities.industrial: integer

TownCapacityUsages🔗

global record TownCapacityUsages  residential: UtilTown.TownCapacityUsage
  commercial: UtilTown.TownCapacityUsage
  industrial: UtilTown.TownCapacityUsage
end

TownCapacityUsages.residential🔗

TownCapacityUsages.residential: UtilTown.TownCapacityUsage

TownCapacityUsages.commercial🔗

TownCapacityUsages.commercial: UtilTown.TownCapacityUsage

TownCapacityUsages.industrial🔗

TownCapacityUsages.industrial: UtilTown.TownCapacityUsage

TownConstructionBoni🔗

global record TownConstructionBoni  xpIncrease: number
  trafficRatingIncrease: number
  reputationRecoveryBoost: number
end

TownConstructionBoni.xpIncrease🔗

TownConstructionBoni.xpIncrease: number

TownConstructionBoni.trafficRatingIncrease🔗

TownConstructionBoni.trafficRatingIncrease: number

TownConstructionBoni.reputationRecoveryBoost🔗

TownConstructionBoni.reputationRecoveryBoost: number

TownLegacyUtil🔗

global record TownLegacyUtil  currentVersion: integer
  updateLegacyState: function(TownsState)
end

TownLegacyUtil.currentVersion🔗

TownLegacyUtil.currentVersion: integer

TownLegacyUtil.updateLegacyState🔗

function TownLegacyUtil.updateLegacyState(TownsState)
Parameters
  • TownsState

TownProposalActions🔗

 
global record TownProposalActions  
enum Action    "BuildAirport"
    "BuildStation"
    "DestroyBuilding"
end

  townActions: {Engine.Entity : {Action}}
end

TownProposalActions.Action🔗

enum TownProposalActions.Action  "BuildAirport"
  "BuildStation"
  "DestroyBuilding"
end

TownProposalActions.Action."BuildAirport"🔗

TownProposalActions.Action."BuildStation"🔗

TownProposalActions.Action."DestroyBuilding"🔗

TownProposalActions.townActions🔗

TownProposalActions.townActions: {Engine.Entity : {Action}}

TownProposalImpact🔗

global record TownProposalImpact  trees: number
  rocks: number
  terrainModification: number
  demolishedTownBuilding: number
  landscaping: number
end

TownProposalImpact.trees🔗

TownProposalImpact.trees: number

TownProposalImpact.rocks🔗

TownProposalImpact.rocks: number

TownProposalImpact.terrainModification🔗

TownProposalImpact.terrainModification: number

TownProposalImpact.demolishedTownBuilding🔗

TownProposalImpact.demolishedTownBuilding: number

TownProposalImpact.landscaping🔗

TownProposalImpact.landscaping: number

TownRatingsSensitivityConfig🔗

global type TownRatingsSensitivityConfig = {TownRatingsSensitivityConfigName : integer}

TownRatingsSensitivityConfigName🔗

global enum TownRatingsSensitivityConfigName  "SensitivityCargoDelivery"
  "SensitivityNoise"
  "SensitivityPeopleHappiness"
  "SensitivityPollution"
  "SensitivityTrafficCongestion"
  "SensitivityUrbanCare"
end

TownRatingsSensitivityConfigName."SensitivityCargoDelivery"🔗

TownRatingsSensitivityConfigName."SensitivityNoise"🔗

TownRatingsSensitivityConfigName."SensitivityPeopleHappiness"🔗

TownRatingsSensitivityConfigName."SensitivityPollution"🔗

TownRatingsSensitivityConfigName."SensitivityTrafficCongestion"🔗

TownRatingsSensitivityConfigName."SensitivityUrbanCare"🔗

TownState🔗

 
global record TownState  townEntity: EntityUtil.EntityAndRevision
  sizeFactors: {number}
  authorityScore: number
  deliveryRating: RatingLevel
  constructionBoni: TownConstructionBoni
  eventFactors: TownAuthorityEventFactors
  lastApplyTime: integer
  
record CachedRating    value: number
    critical: boolean
    warning: boolean
end

  cachedRatings: {string : CachedRating}
  ratingSensitivity: {string : number}
end

TownState.townEntity🔗

TownState.townEntity: EntityUtil.EntityAndRevision

TownState.sizeFactors🔗

TownState.sizeFactors: {number}

TownState.authorityScore🔗

TownState.authorityScore: number

TownState.deliveryRating🔗

TownState.deliveryRating: RatingLevel

TownState.constructionBoni🔗

TownState.constructionBoni: TownConstructionBoni

TownState.eventFactors🔗

TownState.eventFactors: TownAuthorityEventFactors

TownState.lastApplyTime🔗

TownState.lastApplyTime: integer

TownState.CachedRating🔗

record TownState.CachedRating  value: number
  critical: boolean
  warning: boolean
end

TownState.CachedRating.value🔗

TownState.CachedRating.value: number

TownState.CachedRating.critical🔗

TownState.CachedRating.critical: boolean

TownState.CachedRating.warning🔗

TownState.CachedRating.warning: boolean

TownState.cachedRatings🔗

TownState.cachedRatings: {string : CachedRating}

TownState.ratingSensitivity🔗

TownState.ratingSensitivity: {string : number}

TownsState🔗

global record TownsState  townStates: {TownState}
  version: integer
end

TownsState.townStates🔗

TownsState.townStates: {TownState}

TownsState.version🔗

TownsState.version: integer