Module content.game_mechanics.towns.town_cargo🔗

global record TownCargoUtil
  growthPerTick: number
  levelUpSizeFactor: number
  levelUpFactorRange: number
  townExpScaling: number
  authority2xpFactor: {RatingLevel : number}
  ensureState: function(TownsGrowthState, Engine.Entity)
  getTownCargoState: function(Engine.Entity): TownsGrowthState.TownData
  getLevelAndFraction: function(integer): integer, number, integer, integer
  getGrowthFactor: function(Engine.Entity, TownsGrowthState): number
end
global record TownGrowthConfig
  expPerCargoItemToTown: integer
  expPerPersonArriveAtTown: integer
  expBaseTownLevel: integer
end
[Expand All] [Collapse All]
global record TownsGrowthState
  
record TownData
    experience: integer
    initialLevel: integer
    level: integer
    cargoDelivered: boolean
    
record AddedExperience
      rawExperience: integer
      multipliedExperience: integer
end
    accumulatedExperience: {string : {integer : TownsGrowthState.TownData.AddedExperience}}
end
  townState: {Engine.Entity : TownData}
  cargoDemandsSorted: {CargoTypeId}
  disabledCelebratoryFireworks: boolean
end

Category: globals🔗

TownCargoUtil🔗

global record TownCargoUtil
  growthPerTick: number
  levelUpSizeFactor: number
  levelUpFactorRange: number
  townExpScaling: number
  authority2xpFactor: {RatingLevel : number}
  ensureState: function(TownsGrowthState, Engine.Entity)
  getTownCargoState: function(Engine.Entity): TownsGrowthState.TownData
  getLevelAndFraction: function(integer): integer, number, integer, integer
  getGrowthFactor: function(Engine.Entity, TownsGrowthState): number
end

TownCargoUtil.growthPerTick🔗

TownCargoUtil.growthPerTick: number

TownCargoUtil.levelUpSizeFactor🔗

TownCargoUtil.levelUpSizeFactor: number

TownCargoUtil.levelUpFactorRange🔗

TownCargoUtil.levelUpFactorRange: number

TownCargoUtil.townExpScaling🔗

TownCargoUtil.townExpScaling: number

TownCargoUtil.authority2xpFactor🔗

TownCargoUtil.authority2xpFactor: {RatingLevel : number}

TownCargoUtil.ensureState🔗

function TownCargoUtil.ensureState(TownsGrowthState, Engine.Entity)

• TownsGrowthState
• Engine.Entity

TownCargoUtil.getTownCargoState🔗

function TownCargoUtil.getTownCargoState(Engine.Entity): TownsGrowthState.TownData

• Engine.Entity

1. TownsGrowthState.TownData

TownCargoUtil.getLevelAndFraction🔗

function TownCargoUtil.getLevelAndFraction(integer): integer, number, integer, integer

return: current level, fraction/percentage reached of current level, experience needed for current level, experience needed for next level

• integer

1. integer
2. number
3. integer
4. integer

TownCargoUtil.getGrowthFactor🔗

function TownCargoUtil.getGrowthFactor(Engine.Entity, TownsGrowthState): number

• Engine.Entity
• TownsGrowthState

1. number

TownGrowthConfig🔗

global record TownGrowthConfig
  expPerCargoItemToTown: integer
  expPerPersonArriveAtTown: integer
  expBaseTownLevel: integer
end

TownGrowthConfig.expPerCargoItemToTown🔗

TownGrowthConfig.expPerCargoItemToTown: integer

TownGrowthConfig.expPerPersonArriveAtTown🔗

TownGrowthConfig.expPerPersonArriveAtTown: integer

TownGrowthConfig.expBaseTownLevel🔗

TownGrowthConfig.expBaseTownLevel: integer

TownsGrowthState🔗

[Expand All] [Collapse All]
global record TownsGrowthState
  
record TownData
    experience: integer
    initialLevel: integer
    level: integer
    cargoDelivered: boolean
    
record AddedExperience
      rawExperience: integer
      multipliedExperience: integer
end
    accumulatedExperience: {string : {integer : TownsGrowthState.TownData.AddedExperience}}
end
  townState: {Engine.Entity : TownData}
  cargoDemandsSorted: {CargoTypeId}
  disabledCelebratoryFireworks: boolean
end

TownsGrowthState.TownData🔗

[Expand All] [Collapse All]
record TownsGrowthState.TownData
  experience: integer
  initialLevel: integer
  level: integer
  cargoDelivered: boolean
  
record AddedExperience
    rawExperience: integer
    multipliedExperience: integer
end
  accumulatedExperience: {string : {integer : TownsGrowthState.TownData.AddedExperience}}
end

TownsGrowthState.TownData.experience🔗

TownsGrowthState.TownData.experience: integer

TownsGrowthState.TownData.initialLevel🔗

TownsGrowthState.TownData.initialLevel: integer

TownsGrowthState.TownData.level🔗

TownsGrowthState.TownData.level: integer

TownsGrowthState.TownData.cargoDelivered🔗

TownsGrowthState.TownData.cargoDelivered: boolean

TownsGrowthState.TownData.AddedExperience🔗

record TownsGrowthState.TownData.AddedExperience
  rawExperience: integer
  multipliedExperience: integer
end

TownsGrowthState.TownData.AddedExperience.rawExperience🔗

TownsGrowthState.TownData.AddedExperience.rawExperience: integer

TownsGrowthState.TownData.AddedExperience.multipliedExperience🔗

TownsGrowthState.TownData.AddedExperience.multipliedExperience: integer

TownsGrowthState.TownData.accumulatedExperience🔗

TownsGrowthState.TownData.accumulatedExperience: {string : {integer : TownsGrowthState.TownData.AddedExperience}}

TownsGrowthState.townState🔗

TownsGrowthState.townState: {Engine.Entity : TownData}

TownsGrowthState.cargoDemandsSorted🔗

TownsGrowthState.cargoDemandsSorted: {CargoTypeId}

TownsGrowthState.disabledCelebratoryFireworks🔗

TownsGrowthState.disabledCelebratoryFireworks: boolean