Module content.game_mechanics.towns.town_react_util🔗

 
global record TownReactUtil  getRatingClass: function(RatingLevel): string
  getStringForTownAuthorityEventFactors: function(TownAuthorityEventFactors.EventType): string
  getAdviceForTownAuthorityEventFactors: function(TownAuthorityEventFactors.EventType, integer): string
  
enum TownInfoTabType    "Bonuses"
    "Delivery"
    "Happiness"
    "Noise"
    "Overview"
    "Pollution"
    "Reputation"
    "Supplies"
    "Traffic"
end

  
record RatingBarParams    icon: string
    tooltip: string
    barTooltip: string
    value: number
    maxValue: number
    numFractions: integer
    onClick: function()
    hideText: boolean
    showIcon: boolean
end

  RatingBar: Recipe<RatingBarParams>
  
record TownDetailsParam    entity: Engine.Entity
    setLinesExpandedState: function(string, boolean)
end

  getEditorSupplyDetails: function(): Recipe<TownReactUtil.TownDetailsParam>
  GetRatingsDashboard: function(): {TownInfoTabType : {TownUtil.Rating, Recipe<TownDetailsParam>, string}}
  
record TownRatingIconWithTextParams    entity: Engine.Entity
    rating: TownUtil.Rating
    text: string
    tooltip: string
    wideIcon: boolean
    activeTab: boolean
end

  TownRatingIconWithText: Recipe<TownRatingIconWithTextParams>
  getGrowthLevelText: function(RatingLevel): string
  TownPopulationWidget: Recipe<TownDetailsParam>
  
record TownRatingIconParams    
enum IconSize      "Default"
      "Large"
end

    entity: Engine.Entity
    rating: TownUtil.Rating
    tooltip: string
    iconSize: IconSize
end

  TownRatingIcon: Recipe<TownRatingIconParams>
end

Category: globals🔗

TownReactUtil🔗

 
global record TownReactUtil  getRatingClass: function(RatingLevel): string
  getStringForTownAuthorityEventFactors: function(TownAuthorityEventFactors.EventType): string
  getAdviceForTownAuthorityEventFactors: function(TownAuthorityEventFactors.EventType, integer): string
  
enum TownInfoTabType    "Bonuses"
    "Delivery"
    "Happiness"
    "Noise"
    "Overview"
    "Pollution"
    "Reputation"
    "Supplies"
    "Traffic"
end

  
record RatingBarParams    icon: string
    tooltip: string
    barTooltip: string
    value: number
    maxValue: number
    numFractions: integer
    onClick: function()
    hideText: boolean
    showIcon: boolean
end

  RatingBar: Recipe<RatingBarParams>
  
record TownDetailsParam    entity: Engine.Entity
    setLinesExpandedState: function(string, boolean)
end

  getEditorSupplyDetails: function(): Recipe<TownReactUtil.TownDetailsParam>
  GetRatingsDashboard: function(): {TownInfoTabType : {TownUtil.Rating, Recipe<TownDetailsParam>, string}}
  
record TownRatingIconWithTextParams    entity: Engine.Entity
    rating: TownUtil.Rating
    text: string
    tooltip: string
    wideIcon: boolean
    activeTab: boolean
end

  TownRatingIconWithText: Recipe<TownRatingIconWithTextParams>
  getGrowthLevelText: function(RatingLevel): string
  TownPopulationWidget: Recipe<TownDetailsParam>
  
record TownRatingIconParams    
enum IconSize      "Default"
      "Large"
end

    entity: Engine.Entity
    rating: TownUtil.Rating
    tooltip: string
    iconSize: IconSize
end

  TownRatingIcon: Recipe<TownRatingIconParams>
end

TownReactUtil.getRatingClass🔗

function TownReactUtil.getRatingClass(RatingLevel): string
Parameters
  • RatingLevel
Returns
  1. string

TownReactUtil.getStringForTownAuthorityEventFactors🔗

function TownReactUtil.getStringForTownAuthorityEventFactors(TownAuthorityEventFactors.EventType): string
Parameters
  • TownAuthorityEventFactors.EventType
Returns
  1. string

TownReactUtil.getAdviceForTownAuthorityEventFactors🔗

function TownReactUtil.getAdviceForTownAuthorityEventFactors(TownAuthorityEventFactors.EventType, integer): string
Parameters
  • TownAuthorityEventFactors.EventType
  • integer
Returns
  1. string

TownReactUtil.TownInfoTabType🔗

enum TownReactUtil.TownInfoTabType  "Bonuses"
  "Delivery"
  "Happiness"
  "Noise"
  "Overview"
  "Pollution"
  "Reputation"
  "Supplies"
  "Traffic"
end

TownReactUtil.TownInfoTabType."Bonuses"🔗

TownReactUtil.TownInfoTabType."Delivery"🔗

TownReactUtil.TownInfoTabType."Happiness"🔗

TownReactUtil.TownInfoTabType."Noise"🔗

TownReactUtil.TownInfoTabType."Overview"🔗

TownReactUtil.TownInfoTabType."Pollution"🔗

TownReactUtil.TownInfoTabType."Reputation"🔗

TownReactUtil.TownInfoTabType."Supplies"🔗

TownReactUtil.TownInfoTabType."Traffic"🔗

TownReactUtil.RatingBarParams🔗

record TownReactUtil.RatingBarParams  icon: string
  tooltip: string
  barTooltip: string
  value: number
  maxValue: number
  numFractions: integer
  onClick: function()
  hideText: boolean
  showIcon: boolean
end

TownReactUtil.RatingBarParams.icon🔗

TownReactUtil.RatingBarParams.icon: string

TownReactUtil.RatingBarParams.tooltip🔗

TownReactUtil.RatingBarParams.tooltip: string

TownReactUtil.RatingBarParams.barTooltip🔗

TownReactUtil.RatingBarParams.barTooltip: string

TownReactUtil.RatingBarParams.value🔗

TownReactUtil.RatingBarParams.value: number

TownReactUtil.RatingBarParams.maxValue🔗

TownReactUtil.RatingBarParams.maxValue: number

TownReactUtil.RatingBarParams.numFractions🔗

TownReactUtil.RatingBarParams.numFractions: integer

TownReactUtil.RatingBarParams.onClick🔗

function TownReactUtil.RatingBarParams.onClick()

TownReactUtil.RatingBarParams.hideText🔗

TownReactUtil.RatingBarParams.hideText: boolean

TownReactUtil.RatingBarParams.showIcon🔗

TownReactUtil.RatingBarParams.showIcon: boolean

TownReactUtil.RatingBar🔗

TownReactUtil.RatingBar: Recipe<RatingBarParams>

TownReactUtil.TownDetailsParam🔗

record TownReactUtil.TownDetailsParam  entity: Engine.Entity
  setLinesExpandedState: function(string, boolean)
end

TownReactUtil.TownDetailsParam.entity🔗

TownReactUtil.TownDetailsParam.entity: Engine.Entity

TownReactUtil.TownDetailsParam.setLinesExpandedState🔗

function TownReactUtil.TownDetailsParam.setLinesExpandedState(string, boolean)
Parameters
  • string
  • boolean

TownReactUtil.getEditorSupplyDetails🔗

function TownReactUtil.getEditorSupplyDetails(): Recipe<TownReactUtil.TownDetailsParam>
Returns
  1. Recipe<TownReactUtil.TownDetailsParam>

TownReactUtil.GetRatingsDashboard🔗

function TownReactUtil.GetRatingsDashboard(): {TownInfoTabType : {TownUtil.Rating, Recipe<TownDetailsParam>, string}}
Returns
  1. {TownInfoTabType : {TownUtil.Rating, Recipe<TownDetailsParam>, string}}

TownReactUtil.TownRatingIconWithTextParams🔗

record TownReactUtil.TownRatingIconWithTextParams  entity: Engine.Entity
  rating: TownUtil.Rating
  text: string
  tooltip: string
  wideIcon: boolean
  activeTab: boolean
end

TownReactUtil.TownRatingIconWithTextParams.entity🔗

TownReactUtil.TownRatingIconWithTextParams.entity: Engine.Entity

TownReactUtil.TownRatingIconWithTextParams.rating🔗

TownReactUtil.TownRatingIconWithTextParams.rating: TownUtil.Rating

TownReactUtil.TownRatingIconWithTextParams.text🔗

TownReactUtil.TownRatingIconWithTextParams.text: string

TownReactUtil.TownRatingIconWithTextParams.tooltip🔗

TownReactUtil.TownRatingIconWithTextParams.tooltip: string

TownReactUtil.TownRatingIconWithTextParams.wideIcon🔗

TownReactUtil.TownRatingIconWithTextParams.wideIcon: boolean

TownReactUtil.TownRatingIconWithTextParams.activeTab🔗

TownReactUtil.TownRatingIconWithTextParams.activeTab: boolean

TownReactUtil.TownRatingIconWithText🔗

TownReactUtil.TownRatingIconWithText: Recipe<TownRatingIconWithTextParams>

TownReactUtil.getGrowthLevelText🔗

function TownReactUtil.getGrowthLevelText(RatingLevel): string
Parameters
  • RatingLevel
Returns
  1. string

TownReactUtil.TownPopulationWidget🔗

TownReactUtil.TownPopulationWidget: Recipe<TownDetailsParam>

TownReactUtil.TownRatingIconParams🔗

 
record TownReactUtil.TownRatingIconParams  
enum IconSize    "Default"
    "Large"
end

  entity: Engine.Entity
  rating: TownUtil.Rating
  tooltip: string
  iconSize: IconSize
end

TownReactUtil.TownRatingIconParams.IconSize🔗

enum TownReactUtil.TownRatingIconParams.IconSize  "Default"
  "Large"
end

TownReactUtil.TownRatingIconParams.IconSize."Default"🔗

TownReactUtil.TownRatingIconParams.IconSize."Large"🔗

TownReactUtil.TownRatingIconParams.entity🔗

TownReactUtil.TownRatingIconParams.entity: Engine.Entity

TownReactUtil.TownRatingIconParams.rating🔗

TownReactUtil.TownRatingIconParams.rating: TownUtil.Rating

TownReactUtil.TownRatingIconParams.tooltip🔗

TownReactUtil.TownRatingIconParams.tooltip: string

TownReactUtil.TownRatingIconParams.iconSize🔗

TownReactUtil.TownRatingIconParams.iconSize: IconSize

TownReactUtil.TownRatingIcon🔗

TownReactUtil.TownRatingIcon: Recipe<TownRatingIconParams>