Module content.game_mechanics.towns.town_util🔗

global enum TownRatingKey  "cargo_delivery"
  "noise"
  "people_happiness"
  "pollution"
  "traffic_congestion"
  "urban_care"
end


 
global record TownUtil  
record Rating    name: string
    icon: string
    iconLarge: string
    range: {integer, integer}
    added: boolean
    hidden: boolean
    getRating: function(Engine.Entity, TownState): number
    getRatingFnName: ResName
    getRatingFnExtraParam: any
    key: string
    debugGetInfo: function(Engine.Entity, TownState): string
    onClickEvent: {string, <any type>}
end

  GetRatings: function(): {Rating}
  GetRating: function(string): Rating
  GetRatingsToLog: function(): {Rating}
  SeveredConnectionPenalty: number
  NumLinesForHappinessStats: integer
  
record RatingDeliveries    ratingLevelNumber: integer
    noDeliveries: boolean
end

  
enum EmitterCategory    "company_vehicles"
    "depots"
    "industries"
    "maintenance_buildings"
    "other"
    "residents_vehicles"
    "stations"
    "tracks"
    "warehouses"
end

  LineUsageRatingMultiplier: number
  getMultiplierToRankClass: function(number): string
  getRatingSensitivityOptionName: function(TownRatingKey): string
  getRatingLabel: function(RatingLevel): string
  getRatingNameFromKey: function(TownRatingKey): string
  getRatingUrbanCare: function(Engine.Entity, TownState): number
  getRatingNoise: function(Engine.Entity, TownState): number
  getRatingPollution: function(Engine.Entity, TownState): number
  getRatingTraffic: function(Engine.Entity, TownState): number
  getRatingTrafficAllTowns: function({TownState}): {Engine.Entity : number}
  getRatingHappiness: function(Engine.Entity, TownState): number
  getRatingCargoDelivery: function(Engine.Entity, TownState): number
  getRatingDeliveriesLegacy: function(Engine.Entity): number
  getRatingDeliveries: function(Engine.Entity): TownUtil.RatingDeliveries
  getGrowthLevelMult: function(Engine.Entity, TownState): RatingLevel
  getRatingBonuses: function(Engine.Entity, TownState): number
  getRatingDeliveriesCargo: function(Engine.Entity): number
  getRatingDeliveriesCargoLandUse: function(Engine.Entity, LandUseType): number
  getRatingDeliveriesPassenger: function(Engine.Entity): number
  getCargoSupplyDemandsLandUse: function(Engine.Entity, LandUseType): {CargoTypeSupplyDemand}
  getCargoSupplyDemandsLandUseWithResidentialLineUsage: function(Engine.Entity, LandUseType): {CargoTypeSupplyDemand}
  getCargoSupplyDemands: function(Engine.Entity): CargoTypeSupplyDemands
  getLandUseCapacities: function(Engine.Entity): TownCapacities
  getTownCapacityUsages: function(Engine.Entity): TownCapacityUsages
  getReachability: function(Engine.Entity): UtilTown.TownReachability
  getTownEmissionDB: function(Engine.Entity): UtilTown.TownEmission
  getTownEmissionRandomOffsetDB: function(Engine.Entity): UtilTown.TownEmission
  roundRatingPrecision: function(number): integer
  getReachabilityRating: function(integer, number): integer
  getTownCapacityUsageRating: function(UtilTown.TownCapacityUsage, number): integer
  getCargoTypeSupplyDemandRating: function(CargoTypeSupplyDemand, number): integer
  findStateIndex: function(TownsState, EntityUtil.EntityAndRevision): integer
  getTownState: function(TownsState, Engine.Entity): TownState
  setTownState: function(TownsState, Engine.Entity, TownState): TownState
  externalGetTownState: function(Engine.Entity): TownState
  externalGetTownsState: function(): TownsState
  getTrafficSpeedRating: function(Engine.Entity, number): {number, {integer}}
  getItemsAtDestinationPerYear: function(Engine.Entity, CargoTypeId): integer
  getRatingFromCache: function(TownUtil.Rating, Engine.Entity, TownState): TownState.CachedRating
  calcAuthorityScore: function(Engine.Entity, TownState): number
  logAuthorityRatings: function(Engine.Entity, TownState): number
  calculateProposalImpact: function(ProposalStats.TownProposalStats): TownProposalImpact
  applyEventDecay: function(TownAuthorityEventFactors, integer, integer, number): TownAuthorityEventFactors
  applyEventStats: function(TownAuthorityEventFactors, ProposalStats.TownProposalStats): TownAuthorityEventFactors
  applyMarketingCamaign: function(TownAuthorityEventFactors, TownMarketingMetadata.ConstructionDesc): TownAuthorityEventFactors
  applyItemDelivered: function(TownAuthorityEventFactors, boolean, Engine.Entity): TownAuthorityEventFactors
  getXpFactor: function(Engine.Entity): number
  getSeveredMainConnections: function(Engine.Entity): {Engine.Entity}
  getTownEmissionEmitters: function(Engine.Entity, boolean, {Engine.Entity : number}): {EmitterCategory : number}
  getNoiseLandUseTypes: function(): {LandUseType}
  getRatingHappinessFromStats: function(UtilTown.TownHappinessStats, TownState): number
  getFactorLevelNumber: function(number): integer
  getRatingLevel: function(integer): RatingLevel
  getFactorRatingLevel: function(number): RatingLevel
  isValidRating: function(Rating, RatingLevel): boolean
  getRatingSensitivity: function(TownState, TownRatingKey): number
  getTownsToPositions: function(): {Engine.Entity : Vec3f}
  makeGetClosestTownAndDistanceFunction: function(): function(Vec3f) : {Engine.Entity, number}
  makeGetAffectedTownsFunction: function(): function(Vec3f, number) : {Engine.Entity}
  getProposalStats: function(Type.Proposal, Type.ProposalData, boolean): ProposalStats
  getProposalActions: function(Proposal, ProposalData): TownProposalActions
  getActionAllowed: function(TownState, TownProposalActions.Action): boolean
  getTownName: function(Engine.Entity): string
  getTownSize: function(Engine.Entity): integer
  getSubventionsEnabled: function(Engine.Entity): boolean
  changeTownAuthorityPenalty: function(TownAuthorityEventFactors, TownAuthorityEventFactors.EventType, number, number): number
  addTownAuthorityPenalties: function(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number})
  recoverReputation: function(TownAuthorityEventFactors, number, {TownAuthorityEventFactors.EventType : number})
  getReputation: function(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number}): number
  getReputationBreakdown: function(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number}): {TownAuthorityEventFactors.EventType : number}
  level2name: function(integer): string
  getTownForSimEntity: function(Engine.Entity, boolean): Engine.Entity
  isMarketingActive: function(integer, TownAuthorityEventFactors): boolean
  forEachMatchingStocklist: function(Engine.Component.StockList, function(Engine.Entity, CargoTypeId)): {CargoTypeId : boolean}
end

Category: globals🔗

TownRatingKey🔗

global enum TownRatingKey  "cargo_delivery"
  "noise"
  "people_happiness"
  "pollution"
  "traffic_congestion"
  "urban_care"
end

TownRatingKey."cargo_delivery"🔗

TownRatingKey."noise"🔗

TownRatingKey."people_happiness"🔗

TownRatingKey."pollution"🔗

TownRatingKey."traffic_congestion"🔗

TownRatingKey."urban_care"🔗

TownUtil🔗

 
global record TownUtil  
record Rating    name: string
    icon: string
    iconLarge: string
    range: {integer, integer}
    added: boolean
    hidden: boolean
    getRating: function(Engine.Entity, TownState): number
    getRatingFnName: ResName
    getRatingFnExtraParam: any
    key: string
    debugGetInfo: function(Engine.Entity, TownState): string
    onClickEvent: {string, <any type>}
end

  GetRatings: function(): {Rating}
  GetRating: function(string): Rating
  GetRatingsToLog: function(): {Rating}
  SeveredConnectionPenalty: number
  NumLinesForHappinessStats: integer
  
record RatingDeliveries    ratingLevelNumber: integer
    noDeliveries: boolean
end

  
enum EmitterCategory    "company_vehicles"
    "depots"
    "industries"
    "maintenance_buildings"
    "other"
    "residents_vehicles"
    "stations"
    "tracks"
    "warehouses"
end

  LineUsageRatingMultiplier: number
  getMultiplierToRankClass: function(number): string
  getRatingSensitivityOptionName: function(TownRatingKey): string
  getRatingLabel: function(RatingLevel): string
  getRatingNameFromKey: function(TownRatingKey): string
  getRatingUrbanCare: function(Engine.Entity, TownState): number
  getRatingNoise: function(Engine.Entity, TownState): number
  getRatingPollution: function(Engine.Entity, TownState): number
  getRatingTraffic: function(Engine.Entity, TownState): number
  getRatingTrafficAllTowns: function({TownState}): {Engine.Entity : number}
  getRatingHappiness: function(Engine.Entity, TownState): number
  getRatingCargoDelivery: function(Engine.Entity, TownState): number
  getRatingDeliveriesLegacy: function(Engine.Entity): number
  getRatingDeliveries: function(Engine.Entity): TownUtil.RatingDeliveries
  getGrowthLevelMult: function(Engine.Entity, TownState): RatingLevel
  getRatingBonuses: function(Engine.Entity, TownState): number
  getRatingDeliveriesCargo: function(Engine.Entity): number
  getRatingDeliveriesCargoLandUse: function(Engine.Entity, LandUseType): number
  getRatingDeliveriesPassenger: function(Engine.Entity): number
  getCargoSupplyDemandsLandUse: function(Engine.Entity, LandUseType): {CargoTypeSupplyDemand}
  getCargoSupplyDemandsLandUseWithResidentialLineUsage: function(Engine.Entity, LandUseType): {CargoTypeSupplyDemand}
  getCargoSupplyDemands: function(Engine.Entity): CargoTypeSupplyDemands
  getLandUseCapacities: function(Engine.Entity): TownCapacities
  getTownCapacityUsages: function(Engine.Entity): TownCapacityUsages
  getReachability: function(Engine.Entity): UtilTown.TownReachability
  getTownEmissionDB: function(Engine.Entity): UtilTown.TownEmission
  getTownEmissionRandomOffsetDB: function(Engine.Entity): UtilTown.TownEmission
  roundRatingPrecision: function(number): integer
  getReachabilityRating: function(integer, number): integer
  getTownCapacityUsageRating: function(UtilTown.TownCapacityUsage, number): integer
  getCargoTypeSupplyDemandRating: function(CargoTypeSupplyDemand, number): integer
  findStateIndex: function(TownsState, EntityUtil.EntityAndRevision): integer
  getTownState: function(TownsState, Engine.Entity): TownState
  setTownState: function(TownsState, Engine.Entity, TownState): TownState
  externalGetTownState: function(Engine.Entity): TownState
  externalGetTownsState: function(): TownsState
  getTrafficSpeedRating: function(Engine.Entity, number): {number, {integer}}
  getItemsAtDestinationPerYear: function(Engine.Entity, CargoTypeId): integer
  getRatingFromCache: function(TownUtil.Rating, Engine.Entity, TownState): TownState.CachedRating
  calcAuthorityScore: function(Engine.Entity, TownState): number
  logAuthorityRatings: function(Engine.Entity, TownState): number
  calculateProposalImpact: function(ProposalStats.TownProposalStats): TownProposalImpact
  applyEventDecay: function(TownAuthorityEventFactors, integer, integer, number): TownAuthorityEventFactors
  applyEventStats: function(TownAuthorityEventFactors, ProposalStats.TownProposalStats): TownAuthorityEventFactors
  applyMarketingCamaign: function(TownAuthorityEventFactors, TownMarketingMetadata.ConstructionDesc): TownAuthorityEventFactors
  applyItemDelivered: function(TownAuthorityEventFactors, boolean, Engine.Entity): TownAuthorityEventFactors
  getXpFactor: function(Engine.Entity): number
  getSeveredMainConnections: function(Engine.Entity): {Engine.Entity}
  getTownEmissionEmitters: function(Engine.Entity, boolean, {Engine.Entity : number}): {EmitterCategory : number}
  getNoiseLandUseTypes: function(): {LandUseType}
  getRatingHappinessFromStats: function(UtilTown.TownHappinessStats, TownState): number
  getFactorLevelNumber: function(number): integer
  getRatingLevel: function(integer): RatingLevel
  getFactorRatingLevel: function(number): RatingLevel
  isValidRating: function(Rating, RatingLevel): boolean
  getRatingSensitivity: function(TownState, TownRatingKey): number
  getTownsToPositions: function(): {Engine.Entity : Vec3f}
  makeGetClosestTownAndDistanceFunction: function(): function(Vec3f) : {Engine.Entity, number}
  makeGetAffectedTownsFunction: function(): function(Vec3f, number) : {Engine.Entity}
  getProposalStats: function(Type.Proposal, Type.ProposalData, boolean): ProposalStats
  getProposalActions: function(Proposal, ProposalData): TownProposalActions
  getActionAllowed: function(TownState, TownProposalActions.Action): boolean
  getTownName: function(Engine.Entity): string
  getTownSize: function(Engine.Entity): integer
  getSubventionsEnabled: function(Engine.Entity): boolean
  changeTownAuthorityPenalty: function(TownAuthorityEventFactors, TownAuthorityEventFactors.EventType, number, number): number
  addTownAuthorityPenalties: function(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number})
  recoverReputation: function(TownAuthorityEventFactors, number, {TownAuthorityEventFactors.EventType : number})
  getReputation: function(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number}): number
  getReputationBreakdown: function(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number}): {TownAuthorityEventFactors.EventType : number}
  level2name: function(integer): string
  getTownForSimEntity: function(Engine.Entity, boolean): Engine.Entity
  isMarketingActive: function(integer, TownAuthorityEventFactors): boolean
  forEachMatchingStocklist: function(Engine.Component.StockList, function(Engine.Entity, CargoTypeId)): {CargoTypeId : boolean}
end

TownUtil.Rating🔗

record TownUtil.Rating  name: string
  icon: string
  iconLarge: string
  range: {integer, integer}
  added: boolean
  hidden: boolean
  getRating: function(Engine.Entity, TownState): number
  getRatingFnName: ResName
  getRatingFnExtraParam: any
  key: string
  debugGetInfo: function(Engine.Entity, TownState): string
  onClickEvent: {string, <any type>}
end

TownUtil.Rating.name🔗

TownUtil.Rating.name: string

TownUtil.Rating.icon🔗

TownUtil.Rating.icon: string

TownUtil.Rating.iconLarge🔗

TownUtil.Rating.iconLarge: string

TownUtil.Rating.range🔗

TownUtil.Rating.range: {integer, integer}

TownUtil.Rating.added🔗

TownUtil.Rating.added: boolean

TownUtil.Rating.hidden🔗

TownUtil.Rating.hidden: boolean

TownUtil.Rating.getRating🔗

function TownUtil.Rating.getRating(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.Rating.getRatingFnName🔗

TownUtil.Rating.getRatingFnName: ResName

TownUtil.Rating.getRatingFnExtraParam🔗

TownUtil.Rating.getRatingFnExtraParam: any

TownUtil.Rating.key🔗

TownUtil.Rating.key: string

TownUtil.Rating.debugGetInfo🔗

function TownUtil.Rating.debugGetInfo(Engine.Entity, TownState): string
Parameters
  • Engine.Entity
  • TownState
Returns
  1. string

TownUtil.Rating.onClickEvent🔗

TownUtil.Rating.onClickEvent: {string, <any type>}

TownUtil.GetRatings🔗

function TownUtil.GetRatings(): {Rating}
Returns
  1. {Rating}

TownUtil.GetRating🔗

function TownUtil.GetRating(string): Rating
Parameters
  • string
Returns
  1. Rating

TownUtil.GetRatingsToLog🔗

function TownUtil.GetRatingsToLog(): {Rating}
Returns
  1. {Rating}

TownUtil.SeveredConnectionPenalty🔗

TownUtil.SeveredConnectionPenalty: number

TownUtil.NumLinesForHappinessStats🔗

TownUtil.NumLinesForHappinessStats: integer

TownUtil.RatingDeliveries🔗

record TownUtil.RatingDeliveries  ratingLevelNumber: integer
  noDeliveries: boolean
end

TownUtil.RatingDeliveries.ratingLevelNumber🔗

TownUtil.RatingDeliveries.ratingLevelNumber: integer

TownUtil.RatingDeliveries.noDeliveries🔗

TownUtil.RatingDeliveries.noDeliveries: boolean

TownUtil.EmitterCategory🔗

enum TownUtil.EmitterCategory  "company_vehicles"
  "depots"
  "industries"
  "maintenance_buildings"
  "other"
  "residents_vehicles"
  "stations"
  "tracks"
  "warehouses"
end

TownUtil.EmitterCategory."company_vehicles"🔗

TownUtil.EmitterCategory."depots"🔗

TownUtil.EmitterCategory."industries"🔗

TownUtil.EmitterCategory."maintenance_buildings"🔗

TownUtil.EmitterCategory."other"🔗

TownUtil.EmitterCategory."residents_vehicles"🔗

TownUtil.EmitterCategory."stations"🔗

TownUtil.EmitterCategory."tracks"🔗

TownUtil.EmitterCategory."warehouses"🔗

TownUtil.LineUsageRatingMultiplier🔗

TownUtil.LineUsageRatingMultiplier: number

TownUtil.getMultiplierToRankClass🔗

function TownUtil.getMultiplierToRankClass(number): string
Parameters
  • number
Returns
  1. string

TownUtil.getRatingSensitivityOptionName🔗

function TownUtil.getRatingSensitivityOptionName(TownRatingKey): string
Parameters
  • TownRatingKey
Returns
  1. string

TownUtil.getRatingLabel🔗

function TownUtil.getRatingLabel(RatingLevel): string
Parameters
  • RatingLevel
Returns
  1. string

TownUtil.getRatingNameFromKey🔗

function TownUtil.getRatingNameFromKey(TownRatingKey): string
Parameters
  • TownRatingKey
Returns
  1. string

TownUtil.getRatingUrbanCare🔗

function TownUtil.getRatingUrbanCare(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingNoise🔗

function TownUtil.getRatingNoise(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingPollution🔗

function TownUtil.getRatingPollution(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingTraffic🔗

function TownUtil.getRatingTraffic(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingTrafficAllTowns🔗

function TownUtil.getRatingTrafficAllTowns({TownState}): {Engine.Entity : number}
Parameters
  • {TownState}
Returns
  1. {Engine.Entity : number}

TownUtil.getRatingHappiness🔗

function TownUtil.getRatingHappiness(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingCargoDelivery🔗

function TownUtil.getRatingCargoDelivery(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingDeliveriesLegacy🔗

function TownUtil.getRatingDeliveriesLegacy(Engine.Entity): number
Parameters
  • Engine.Entity
Returns
  1. number

TownUtil.getRatingDeliveries🔗

function TownUtil.getRatingDeliveries(Engine.Entity): TownUtil.RatingDeliveries
Parameters
  • Engine.Entity
Returns
  1. TownUtil.RatingDeliveries

TownUtil.getGrowthLevelMult🔗

function TownUtil.getGrowthLevelMult(Engine.Entity, TownState): RatingLevel
Parameters
  • Engine.Entity
  • TownState
Returns
  1. RatingLevel

TownUtil.getRatingBonuses🔗

function TownUtil.getRatingBonuses(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.getRatingDeliveriesCargo🔗

function TownUtil.getRatingDeliveriesCargo(Engine.Entity): number
Parameters
  • Engine.Entity
Returns
  1. number

TownUtil.getRatingDeliveriesCargoLandUse🔗

function TownUtil.getRatingDeliveriesCargoLandUse(Engine.Entity, LandUseType): number
Parameters
  • Engine.Entity
  • LandUseType
Returns
  1. number

TownUtil.getRatingDeliveriesPassenger🔗

function TownUtil.getRatingDeliveriesPassenger(Engine.Entity): number
Parameters
  • Engine.Entity
Returns
  1. number

TownUtil.getCargoSupplyDemandsLandUse🔗

function TownUtil.getCargoSupplyDemandsLandUse(Engine.Entity, LandUseType): {CargoTypeSupplyDemand}
Parameters
  • Engine.Entity
  • LandUseType
Returns
  1. {CargoTypeSupplyDemand}

TownUtil.getCargoSupplyDemandsLandUseWithResidentialLineUsage🔗

function TownUtil.getCargoSupplyDemandsLandUseWithResidentialLineUsage(Engine.Entity, LandUseType): {CargoTypeSupplyDemand}
Parameters
  • Engine.Entity
  • LandUseType
Returns
  1. {CargoTypeSupplyDemand}

TownUtil.getCargoSupplyDemands🔗

function TownUtil.getCargoSupplyDemands(Engine.Entity): CargoTypeSupplyDemands
Parameters
  • Engine.Entity
Returns
  1. CargoTypeSupplyDemands

TownUtil.getLandUseCapacities🔗

function TownUtil.getLandUseCapacities(Engine.Entity): TownCapacities
Parameters
  • Engine.Entity
Returns
  1. TownCapacities

TownUtil.getTownCapacityUsages🔗

function TownUtil.getTownCapacityUsages(Engine.Entity): TownCapacityUsages
Parameters
  • Engine.Entity
Returns
  1. TownCapacityUsages

TownUtil.getReachability🔗

function TownUtil.getReachability(Engine.Entity): UtilTown.TownReachability
Parameters
  • Engine.Entity
Returns
  1. UtilTown.TownReachability

TownUtil.getTownEmissionDB🔗

function TownUtil.getTownEmissionDB(Engine.Entity): UtilTown.TownEmission
Parameters
  • Engine.Entity
Returns
  1. UtilTown.TownEmission

TownUtil.getTownEmissionRandomOffsetDB🔗

function TownUtil.getTownEmissionRandomOffsetDB(Engine.Entity): UtilTown.TownEmission
Parameters
  • Engine.Entity
Returns
  1. UtilTown.TownEmission

TownUtil.roundRatingPrecision🔗

function TownUtil.roundRatingPrecision(number): integer
Parameters
  • number
Returns
  1. integer

TownUtil.getReachabilityRating🔗

function TownUtil.getReachabilityRating(integer, number): integer
Parameters
  • integer
  • number
Returns
  1. integer

TownUtil.getTownCapacityUsageRating🔗

function TownUtil.getTownCapacityUsageRating(UtilTown.TownCapacityUsage, number): integer
Parameters
  • UtilTown.TownCapacityUsage
  • number
Returns
  1. integer

TownUtil.getCargoTypeSupplyDemandRating🔗

function TownUtil.getCargoTypeSupplyDemandRating(CargoTypeSupplyDemand, number): integer
Parameters
  • CargoTypeSupplyDemand
  • number
Returns
  1. integer

TownUtil.findStateIndex🔗

function TownUtil.findStateIndex(TownsState, EntityUtil.EntityAndRevision): integer
Parameters
  • TownsState
  • EntityUtil.EntityAndRevision
Returns
  1. integer

TownUtil.getTownState🔗

function TownUtil.getTownState(TownsState, Engine.Entity): TownState
Parameters
  • TownsState
  • Engine.Entity
Returns
  1. TownState

TownUtil.setTownState🔗

function TownUtil.setTownState(TownsState, Engine.Entity, TownState): TownState
Parameters
  • TownsState
  • Engine.Entity
  • TownState
Returns
  1. TownState

TownUtil.externalGetTownState🔗

function TownUtil.externalGetTownState(Engine.Entity): TownState
Parameters
  • Engine.Entity
Returns
  1. TownState

TownUtil.externalGetTownsState🔗

function TownUtil.externalGetTownsState(): TownsState
Returns
  1. TownsState

TownUtil.getTrafficSpeedRating🔗

function TownUtil.getTrafficSpeedRating(Engine.Entity, number): {number, {integer}}
Parameters
  • Engine.Entity
  • number
Returns
  1. {number, {integer}}

TownUtil.getItemsAtDestinationPerYear🔗

function TownUtil.getItemsAtDestinationPerYear(Engine.Entity, CargoTypeId): integer
Parameters
  • Engine.Entity
  • CargoTypeId
Returns
  1. integer

TownUtil.getRatingFromCache🔗

function TownUtil.getRatingFromCache(TownUtil.Rating, Engine.Entity, TownState): TownState.CachedRating
Parameters
  • TownUtil.Rating
  • Engine.Entity
  • TownState
Returns
  1. TownState.CachedRating

TownUtil.calcAuthorityScore🔗

function TownUtil.calcAuthorityScore(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.logAuthorityRatings🔗

function TownUtil.logAuthorityRatings(Engine.Entity, TownState): number
Parameters
  • Engine.Entity
  • TownState
Returns
  1. number

TownUtil.calculateProposalImpact🔗

function TownUtil.calculateProposalImpact(ProposalStats.TownProposalStats): TownProposalImpact
Parameters
  • ProposalStats.TownProposalStats
Returns
  1. TownProposalImpact

TownUtil.applyEventDecay🔗

function TownUtil.applyEventDecay(TownAuthorityEventFactors, integer, integer, number): TownAuthorityEventFactors
Parameters
  • TownAuthorityEventFactors
  • integer
  • integer
  • number
Returns
  1. TownAuthorityEventFactors

TownUtil.applyEventStats🔗

function TownUtil.applyEventStats(TownAuthorityEventFactors, ProposalStats.TownProposalStats): TownAuthorityEventFactors
Parameters
  • TownAuthorityEventFactors
  • ProposalStats.TownProposalStats
Returns
  1. TownAuthorityEventFactors

TownUtil.applyMarketingCamaign🔗

function TownUtil.applyMarketingCamaign(TownAuthorityEventFactors, TownMarketingMetadata.ConstructionDesc): TownAuthorityEventFactors
Parameters
  • TownAuthorityEventFactors
  • TownMarketingMetadata.ConstructionDesc
Returns
  1. TownAuthorityEventFactors

TownUtil.applyItemDelivered🔗

function TownUtil.applyItemDelivered(TownAuthorityEventFactors, boolean, Engine.Entity): TownAuthorityEventFactors
Parameters
  • TownAuthorityEventFactors
  • boolean
  • Engine.Entity
Returns
  1. TownAuthorityEventFactors

TownUtil.getXpFactor🔗

function TownUtil.getXpFactor(Engine.Entity): number
Parameters
  • Engine.Entity
Returns
  1. number

TownUtil.getSeveredMainConnections🔗

function TownUtil.getSeveredMainConnections(Engine.Entity): {Engine.Entity}
Parameters
  • Engine.Entity
Returns
  1. {Engine.Entity}

TownUtil.getTownEmissionEmitters🔗

function TownUtil.getTownEmissionEmitters(Engine.Entity, boolean, {Engine.Entity : number}): {EmitterCategory : number}
Parameters
  • Engine.Entity
  • boolean
  • {Engine.Entity : number}
Returns
  1. {EmitterCategory : number}

TownUtil.getNoiseLandUseTypes🔗

function TownUtil.getNoiseLandUseTypes(): {LandUseType}
Returns
  1. {LandUseType}

TownUtil.getRatingHappinessFromStats🔗

function TownUtil.getRatingHappinessFromStats(UtilTown.TownHappinessStats, TownState): number
Parameters
  • UtilTown.TownHappinessStats
  • TownState
Returns
  1. number

TownUtil.getFactorLevelNumber🔗

function TownUtil.getFactorLevelNumber(number): integer
Parameters
  • number
Returns
  1. integer

TownUtil.getRatingLevel🔗

function TownUtil.getRatingLevel(integer): RatingLevel
Parameters
  • integer
Returns
  1. RatingLevel

TownUtil.getFactorRatingLevel🔗

function TownUtil.getFactorRatingLevel(number): RatingLevel
Parameters
  • number
Returns
  1. RatingLevel

TownUtil.isValidRating🔗

function TownUtil.isValidRating(Rating, RatingLevel): boolean
Parameters
  • Rating
  • RatingLevel
Returns
  1. boolean

TownUtil.getRatingSensitivity🔗

function TownUtil.getRatingSensitivity(TownState, TownRatingKey): number
Parameters
  • TownState
  • TownRatingKey
Returns
  1. number

TownUtil.getTownsToPositions🔗

function TownUtil.getTownsToPositions(): {Engine.Entity : Vec3f}
Returns
  1. {Engine.Entity : Vec3f}

TownUtil.makeGetClosestTownAndDistanceFunction🔗

function TownUtil.makeGetClosestTownAndDistanceFunction(): function(Vec3f) : {Engine.Entity, number}
Returns
  1. function(Vec3f): {Engine.Entity, number}

TownUtil.makeGetAffectedTownsFunction🔗

function TownUtil.makeGetAffectedTownsFunction(): function(Vec3f, number) : {Engine.Entity}
Returns
  1. function(Vec3f, number): {Engine.Entity}

TownUtil.getProposalStats🔗

function TownUtil.getProposalStats(Type.Proposal, Type.ProposalData, boolean): ProposalStats
Parameters
  • Type.Proposal
  • Type.ProposalData
  • boolean
Returns
  1. ProposalStats

TownUtil.getProposalActions🔗

function TownUtil.getProposalActions(Proposal, ProposalData): TownProposalActions
Parameters
  • Proposal
  • ProposalData
Returns
  1. TownProposalActions

TownUtil.getActionAllowed🔗

function TownUtil.getActionAllowed(TownState, TownProposalActions.Action): boolean
Parameters
  • TownState
  • TownProposalActions.Action
Returns
  1. boolean

TownUtil.getTownName🔗

function TownUtil.getTownName(Engine.Entity): string
Parameters
  • Engine.Entity
Returns
  1. string

TownUtil.getTownSize🔗

function TownUtil.getTownSize(Engine.Entity): integer
Parameters
  • Engine.Entity
Returns
  1. integer

TownUtil.getSubventionsEnabled🔗

function TownUtil.getSubventionsEnabled(Engine.Entity): boolean
Parameters
  • Engine.Entity
Returns
  1. boolean

TownUtil.changeTownAuthorityPenalty🔗

function TownUtil.changeTownAuthorityPenalty(TownAuthorityEventFactors, TownAuthorityEventFactors.EventType, number, number): number
Parameters
  • TownAuthorityEventFactors
  • TownAuthorityEventFactors.EventType
  • number
  • number
Returns
  1. number

TownUtil.addTownAuthorityPenalties🔗

function TownUtil.addTownAuthorityPenalties(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number})
Parameters
  • TownAuthorityEventFactors
  • {TownAuthorityEventFactors.EventType : number}

TownUtil.recoverReputation🔗

function TownUtil.recoverReputation(TownAuthorityEventFactors, number, {TownAuthorityEventFactors.EventType : number})
Parameters
  • TownAuthorityEventFactors
  • number
  • {TownAuthorityEventFactors.EventType : number}

TownUtil.getReputation🔗

function TownUtil.getReputation(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number}): number
Parameters
  • TownAuthorityEventFactors
  • {TownAuthorityEventFactors.EventType : number}
Returns
  1. number

TownUtil.getReputationBreakdown🔗

function TownUtil.getReputationBreakdown(TownAuthorityEventFactors, {TownAuthorityEventFactors.EventType : number}): {TownAuthorityEventFactors.EventType : number}
Parameters
  • TownAuthorityEventFactors
  • {TownAuthorityEventFactors.EventType : number}
Returns
  1. {TownAuthorityEventFactors.EventType : number}

TownUtil.level2name🔗

function TownUtil.level2name(integer): string
Parameters
  • integer
Returns
  1. string

TownUtil.getTownForSimEntity🔗

function TownUtil.getTownForSimEntity(Engine.Entity, boolean): Engine.Entity
Parameters
  • Engine.Entity
  • boolean
Returns
  1. Engine.Entity

TownUtil.isMarketingActive🔗

function TownUtil.isMarketingActive(integer, TownAuthorityEventFactors): boolean
Parameters
  • integer
  • TownAuthorityEventFactors
Returns
  1. boolean

TownUtil.forEachMatchingStocklist🔗

function TownUtil.forEachMatchingStocklist(Engine.Component.StockList, function(Engine.Entity, CargoTypeId)): {CargoTypeId : boolean}

return input/output cargo types (depending on argument stockListType)

Parameters
  • Engine.Component.StockList
  • function(Engine.Entity, CargoTypeId)
Returns
  1. {CargoTypeId : boolean}