Module content.gui.construction.construction_menu🔗

global enum ConstructionActionCustomHudIcons  "MAINTENANCE_STATION"
end


global enum ConstructionActionHudIconConstructionType  "RAIL"
  "ROAD"
  "TRAM"
  "WATER"
end


global record ConstructionActionHudIconParams  defaultIcons: {Engine.ComponentType}
  customIcons: {ConstructionActionCustomHudIcons}
  stationType: ConstructionActionHudIconStationType
  constructionType: ConstructionActionHudIconConstructionType
  depotType: ConstructionActionHudIconConstructionType
  accessNotificationCacheFn: function(Engine.Entity): {Notification}
  showPerksAndTowns: boolean
end


global enum ConstructionActionHudIconStationType  "CARGO"
  "PASSENGER"
end


global record ConstructionActionHudIcons  componentTypes: {Engine.ComponentType}
  showDistricts: boolean
  showTownBorders: boolean
  showPerksAndTowns: boolean
  params: ConstructionActionHudIconParams
end


global record ConstructionActionRepository  terrainModifierHeightmaps: {integer}
  cargoTypes: {CargoTypeId}
  landUse2CargoTypes: {LandUseType : {CargoTypeId}}
  terrainToolData: ConstructionToolParam.TerrainToolData
  hasHeightMapTextureTool: boolean
end


global record ConstructionAvailability  yearFrom: integer
  yearTo: integer
end


global record ConstructionCustomAction<P>  recipe: Recipe<ConstructionCustomActionParams<P>>
  customParam: P
end


global record ConstructionCustomActionParams<P>  gameCtx: GameContext
  definition: ConstructionDefinition
  customParam: P
  isActive: boolean
  abort: function()
  setActionFn: function(function() : TreeNodeId, string)
  getCurrentParams: function(): {string : number}
end


 
global record ConstructionDefinition  
record DefinitionDisabled    message: string
end

  action: ConstructionMenuAction
  resName: ResName
  constructions: {ResName}
  builderAudioRes: {ResName}
  resIndex: integer
  icon: IconWithAvailability
  previewIcon: IconWithAvailability
  name: string
  description: string
  params: {ConstructionMenuParam}
  categories: {string}
  availability: ConstructionAvailability
  placementTag: string
  metadata: ConstructionDescMetadata
  constructionTemplate: integer
  hudIcons: ConstructionActionHudIcons
  showInAllCategories: boolean
  disabled: DefinitionDisabled
  terrainContours: boolean
  navigableWater: boolean
  configureLayerScript: ScriptRef
  configureHudIconsScript: ScriptRef
  customAction: ConstructionCustomAction<<any type>>
  order: integer
  attributes: {string : {number, number}}
  attributesCostPerKm: boolean
  cargoTypeSet: CargoTypeSet
  keepDisabledActive: boolean
  showNumRemaining: boolean
  numRemaining: integer
  menuCategory: ModelMetadata.MenuCategory
  moduleType: string
  categoryList: ModelMetadata.CategoryList
end


global enum ConstructionMenu  "AIR"
  "BULLDOZER"
  "INDUSTRY"
  "LANDSCAPING"
  "MODULES"
  "MODULE_BULLDOZER"
  "PERKS"
  "RAIL"
  "ROAD"
  "ROADS"
  "TOWN"
  "WAREHOUSE"
  "WATER"
end


global enum ConstructionMenuAction  "ACTION_ASSET_BRUSH"
  "ACTION_BULLDOZER"
  "ACTION_BUS_LANE_TOOL"
  "ACTION_CONSTRUCTION_BUILDER"
  "ACTION_CROSSWALK_MODIFIER_TOOL"
  "ACTION_CUSTOM"
  "ACTION_ECO_INDUSTRY"
  "ACTION_LANE_MODIFIER_TOOL"
  "ACTION_MARKETING"
  "ACTION_MODULE_BUILDER"
  "ACTION_MODULE_BULLDOZER"
  "ACTION_PLAYER_OWNED_TOOL"
  "ACTION_PROSPECTION"
  "ACTION_STREET_BUILDER_UPGRADER"
  "ACTION_STREET_TERMINAL_BUILDER"
  "ACTION_TERRAIN_MODIFIER_FLATTEN_TOOL"
  "ACTION_TERRAIN_MODIFIER_HEIGHTMAP_TOOL"
  "ACTION_TERRAIN_MODIFIER_LOWER_TOOL"
  "ACTION_TERRAIN_MODIFIER_RAISE_TOOL"
  "ACTION_TERRAIN_MODIFIER_SMOOTH_TOOL"
  "ACTION_TERRAIN_PAINTER"
  "ACTION_TOWN_BUILDER"
  "ACTION_TOWN_BUILDER_EXPERIMENTAL"
  "ACTION_TRACK_BUILDER_UPGRADER"
  "ACTION_TRACK_EDGE_DECORATION_TOOL"
  "ACTION_TRACK_ELECTRIFICATION_TOOL"
  "ACTION_TRAFFIC_LIGHT_TOOL"
  "ACTION_TRAM_TRACK_TOOL"
end


global record ConstructionMenuActionParams  constructionActionParams: Builtin.ConstructionActionParam
  hudIconManagerParams: Builtin.HudIconManagerConfigParam<ConstructionActionHudIconParams>
  layerConfig: LayerConfig
end


global record ConstructionMenuCategory  category: string
  menu: ConstructionMenu
  name: string
  icon: ResName
  order: integer
end


global record ConstructionMenuModuleCategory  categoryName: string
  category: string
  icon: string
  modules: {{string, ModuleDesc}}
  typeAvailability: {string : ConstructionAvailability}
end


 
global record ConstructionMenuParam  new: function(): ConstructionMenuParam
  key: string
  name: string
  tooltip: string
  values: {string}
  numbers: {number}
  defaultIndex: Index
  uiType: ScriptParamType
  iconStyle: ScriptParamUtil.ParamForUi.IconStyle
  location: ScriptParamLocation
  displayMode: ScriptParamDisplayMode
  yearFrom: integer
  yearTo: integer
  group: string
  tooltips: {string}
  
enum CheckEnabledResult    "Disabled"
    "Enabled"
    "Hidden"
    "InputActionOnly"
end

  onChangeFn: function(number, ConstructionMenuParamsAPI, number)
  checkEnabledFn: function({string : number}): ConstructionMenuParam.CheckEnabledResult
  makeCompactButtonFn: function(number): TreeNodeId
  formatValueFn: function(number): string
  getImageFn: function(integer): string
  stepValueFn: function(number, integer, boolean): number
  getFilterObjectsFn: function(): {MenuCategoryUtil.FilterObject}, integer
  hideLabel: boolean
  resetOnCategoryChange: boolean
  resetOnMenuClose: boolean
  resetOnDefinitionChange: boolean
  preserveValueInAllCategories: boolean
  constructionParam: boolean
  id: string
end


global record ConstructionMenuParamInfo  index: integer
  param: ConstructionMenuParam
  value: number
end


global record ConstructionMenuParamsAPI  setActiveDefinition: function(ConstructionDefinition, integer, string): {string : number}
  getParamsForDefinition: function(ConstructionDefinition, integer): {string : number}
  getStoredValues: function(integer): {string : number}
  changeParam: function(integer, number)
  setParamDisabled: function(integer, boolean)
  isParamActive: function(string): boolean
  getParam: function(integer): ConstructionMenuParam
  getCategory: function(): integer
  getParamByKey: function(string): ConstructionMenuParamInfo
  updateVisibility: function()
  getCurrentParams: function(): {string : number}
  onInfoPopupVisibilityChange: function(boolean)
end


global record ConstructionToolData  getDefinitionFn: ScriptRef
  isDisabledFn: ScriptRef
end


global record IconWithAvailability  icon: string
  lockedIcon: string
  yearFrom: {{integer, string}}
end


global record RegisterCustomSelectorBasedActionRecipeParams<P>  isAvailable: function(ConstructionCustomActionParams<P>): boolean
  isActive: boolean
  onHover: function(ConstructionCustomActionParams<P>, Engine.Entity, {integer}, Gui.SelectionDetails): SelectorBasedActionHoverResult
  onSelect: function(ConstructionCustomActionParams<P>, Engine.Entity)
  filter: function(Engine.Entity)
end


global record SelectorBasedActionHoverResult  param: Builtin.ActionTooltipParam<<any type>>
  mouseCursor: integer
end

Category: globals🔗

ConstructionActionCustomHudIcons🔗

global enum ConstructionActionCustomHudIcons  "MAINTENANCE_STATION"
end

ConstructionActionCustomHudIcons."MAINTENANCE_STATION"🔗

ConstructionActionHudIconConstructionType🔗

global enum ConstructionActionHudIconConstructionType  "RAIL"
  "ROAD"
  "TRAM"
  "WATER"
end

ConstructionActionHudIconConstructionType."RAIL"🔗

ConstructionActionHudIconConstructionType."ROAD"🔗

ConstructionActionHudIconConstructionType."TRAM"🔗

ConstructionActionHudIconConstructionType."WATER"🔗

ConstructionActionHudIconParams🔗

global record ConstructionActionHudIconParams  defaultIcons: {Engine.ComponentType}
  customIcons: {ConstructionActionCustomHudIcons}
  stationType: ConstructionActionHudIconStationType
  constructionType: ConstructionActionHudIconConstructionType
  depotType: ConstructionActionHudIconConstructionType
  accessNotificationCacheFn: function(Engine.Entity): {Notification}
  showPerksAndTowns: boolean
end

ConstructionActionHudIconParams.defaultIcons🔗

ConstructionActionHudIconParams.defaultIcons: {Engine.ComponentType}

ConstructionActionHudIconParams.customIcons🔗

ConstructionActionHudIconParams.customIcons: {ConstructionActionCustomHudIcons}

ConstructionActionHudIconParams.stationType🔗

ConstructionActionHudIconParams.stationType: ConstructionActionHudIconStationType

ConstructionActionHudIconParams.constructionType🔗

ConstructionActionHudIconParams.constructionType: ConstructionActionHudIconConstructionType

ConstructionActionHudIconParams.depotType🔗

ConstructionActionHudIconParams.depotType: ConstructionActionHudIconConstructionType

ConstructionActionHudIconParams.accessNotificationCacheFn🔗

function ConstructionActionHudIconParams.accessNotificationCacheFn(Engine.Entity): {Notification}
Parameters
  • Engine.Entity
Returns
  1. {Notification}

ConstructionActionHudIconParams.showPerksAndTowns🔗

ConstructionActionHudIconParams.showPerksAndTowns: boolean

ConstructionActionHudIconStationType🔗

global enum ConstructionActionHudIconStationType  "CARGO"
  "PASSENGER"
end

ConstructionActionHudIconStationType."CARGO"🔗

ConstructionActionHudIconStationType."PASSENGER"🔗

ConstructionActionHudIcons🔗

global record ConstructionActionHudIcons  componentTypes: {Engine.ComponentType}
  showDistricts: boolean
  showTownBorders: boolean
  showPerksAndTowns: boolean
  params: ConstructionActionHudIconParams
end

ConstructionActionHudIcons.componentTypes🔗

ConstructionActionHudIcons.componentTypes: {Engine.ComponentType}

ConstructionActionHudIcons.showDistricts🔗

ConstructionActionHudIcons.showDistricts: boolean

ConstructionActionHudIcons.showTownBorders🔗

ConstructionActionHudIcons.showTownBorders: boolean

ConstructionActionHudIcons.showPerksAndTowns🔗

ConstructionActionHudIcons.showPerksAndTowns: boolean

ConstructionActionHudIcons.params🔗

ConstructionActionHudIcons.params: ConstructionActionHudIconParams

ConstructionActionRepository🔗

global record ConstructionActionRepository  terrainModifierHeightmaps: {integer}
  cargoTypes: {CargoTypeId}
  landUse2CargoTypes: {LandUseType : {CargoTypeId}}
  terrainToolData: ConstructionToolParam.TerrainToolData
  hasHeightMapTextureTool: boolean
end

ConstructionActionRepository.terrainModifierHeightmaps🔗

ConstructionActionRepository.terrainModifierHeightmaps: {integer}

ConstructionActionRepository.cargoTypes🔗

ConstructionActionRepository.cargoTypes: {CargoTypeId}

ConstructionActionRepository.landUse2CargoTypes🔗

ConstructionActionRepository.landUse2CargoTypes: {LandUseType : {CargoTypeId}}

ConstructionActionRepository.terrainToolData🔗

ConstructionActionRepository.terrainToolData: ConstructionToolParam.TerrainToolData

ConstructionActionRepository.hasHeightMapTextureTool🔗

ConstructionActionRepository.hasHeightMapTextureTool: boolean

ConstructionAvailability🔗

global record ConstructionAvailability  yearFrom: integer
  yearTo: integer
end

ConstructionAvailability.yearFrom🔗

ConstructionAvailability.yearFrom: integer

ConstructionAvailability.yearTo🔗

ConstructionAvailability.yearTo: integer

ConstructionCustomAction🔗

global record ConstructionCustomAction<P>  recipe: Recipe<ConstructionCustomActionParams<P>>
  customParam: P
end
Type Parameters
  • P

ConstructionCustomAction.recipe🔗

ConstructionCustomAction.recipe: Recipe<ConstructionCustomActionParams<P>>

ConstructionCustomAction.customParam🔗

ConstructionCustomAction.customParam: P

ConstructionCustomActionParams🔗

global record ConstructionCustomActionParams<P>  gameCtx: GameContext
  definition: ConstructionDefinition
  customParam: P
  isActive: boolean
  abort: function()
  setActionFn: function(function() : TreeNodeId, string)
  getCurrentParams: function(): {string : number}
end
Type Parameters
  • P

ConstructionCustomActionParams.gameCtx🔗

ConstructionCustomActionParams.gameCtx: GameContext

ConstructionCustomActionParams.definition🔗

ConstructionCustomActionParams.definition: ConstructionDefinition

ConstructionCustomActionParams.customParam🔗

ConstructionCustomActionParams.customParam: P

ConstructionCustomActionParams.isActive🔗

ConstructionCustomActionParams.isActive: boolean

ConstructionCustomActionParams.abort🔗

function ConstructionCustomActionParams.abort()

ConstructionCustomActionParams.setActionFn🔗

function ConstructionCustomActionParams.setActionFn(function() : TreeNodeId, string)
Parameters
  • function(): TreeNodeId
  • string

ConstructionCustomActionParams.getCurrentParams🔗

function ConstructionCustomActionParams.getCurrentParams(): {string : number}
Returns
  1. {string : number}

ConstructionDefinition🔗

 
global record ConstructionDefinition  
record DefinitionDisabled    message: string
end

  action: ConstructionMenuAction
  resName: ResName
  constructions: {ResName}
  builderAudioRes: {ResName}
  resIndex: integer
  icon: IconWithAvailability
  previewIcon: IconWithAvailability
  name: string
  description: string
  params: {ConstructionMenuParam}
  categories: {string}
  availability: ConstructionAvailability
  placementTag: string
  metadata: ConstructionDescMetadata
  constructionTemplate: integer
  hudIcons: ConstructionActionHudIcons
  showInAllCategories: boolean
  disabled: DefinitionDisabled
  terrainContours: boolean
  navigableWater: boolean
  configureLayerScript: ScriptRef
  configureHudIconsScript: ScriptRef
  customAction: ConstructionCustomAction<<any type>>
  order: integer
  attributes: {string : {number, number}}
  attributesCostPerKm: boolean
  cargoTypeSet: CargoTypeSet
  keepDisabledActive: boolean
  showNumRemaining: boolean
  numRemaining: integer
  menuCategory: ModelMetadata.MenuCategory
  moduleType: string
  categoryList: ModelMetadata.CategoryList
end

ConstructionDefinition.DefinitionDisabled🔗

record ConstructionDefinition.DefinitionDisabled  message: string
end

ConstructionDefinition.DefinitionDisabled.message🔗

ConstructionDefinition.DefinitionDisabled.message: string

ConstructionDefinition.action🔗

ConstructionDefinition.action: ConstructionMenuAction

ConstructionDefinition.resName🔗

ConstructionDefinition.resName: ResName

ConstructionDefinition.constructions🔗

ConstructionDefinition.constructions: {ResName}

ConstructionDefinition.builderAudioRes🔗

ConstructionDefinition.builderAudioRes: {ResName}

ConstructionDefinition.resIndex🔗

ConstructionDefinition.resIndex: integer

ConstructionDefinition.icon🔗

ConstructionDefinition.icon: IconWithAvailability

ConstructionDefinition.previewIcon🔗

ConstructionDefinition.previewIcon: IconWithAvailability

ConstructionDefinition.name🔗

ConstructionDefinition.name: string

ConstructionDefinition.description🔗

ConstructionDefinition.description: string

ConstructionDefinition.params🔗

ConstructionDefinition.params: {ConstructionMenuParam}

ConstructionDefinition.categories🔗

ConstructionDefinition.categories: {string}

ConstructionDefinition.availability🔗

ConstructionDefinition.availability: ConstructionAvailability

ConstructionDefinition.placementTag🔗

ConstructionDefinition.placementTag: string

ConstructionDefinition.metadata🔗

ConstructionDefinition.metadata: ConstructionDescMetadata

ConstructionDefinition.constructionTemplate🔗

ConstructionDefinition.constructionTemplate: integer

ConstructionDefinition.hudIcons🔗

ConstructionDefinition.hudIcons: ConstructionActionHudIcons

ConstructionDefinition.showInAllCategories🔗

ConstructionDefinition.showInAllCategories: boolean

ConstructionDefinition.disabled🔗

ConstructionDefinition.disabled: DefinitionDisabled

ConstructionDefinition.terrainContours🔗

ConstructionDefinition.terrainContours: boolean

ConstructionDefinition.navigableWater🔗

ConstructionDefinition.navigableWater: boolean

ConstructionDefinition.configureLayerScript🔗

ConstructionDefinition.configureLayerScript: ScriptRef

ConstructionDefinition.configureHudIconsScript🔗

ConstructionDefinition.configureHudIconsScript: ScriptRef

ConstructionDefinition.customAction🔗

ConstructionDefinition.customAction: ConstructionCustomAction<<any type>>

ConstructionDefinition.order🔗

ConstructionDefinition.order: integer

ConstructionDefinition.attributes🔗

ConstructionDefinition.attributes: {string : {number, number}}

ConstructionDefinition.attributesCostPerKm🔗

ConstructionDefinition.attributesCostPerKm: boolean

ConstructionDefinition.cargoTypeSet🔗

ConstructionDefinition.cargoTypeSet: CargoTypeSet

ConstructionDefinition.keepDisabledActive🔗

ConstructionDefinition.keepDisabledActive: boolean

ConstructionDefinition.showNumRemaining🔗

ConstructionDefinition.showNumRemaining: boolean

ConstructionDefinition.numRemaining🔗

ConstructionDefinition.numRemaining: integer

ConstructionDefinition.menuCategory🔗

ConstructionDefinition.menuCategory: ModelMetadata.MenuCategory

ConstructionDefinition.moduleType🔗

ConstructionDefinition.moduleType: string

ConstructionDefinition.categoryList🔗

ConstructionDefinition.categoryList: ModelMetadata.CategoryList

ConstructionMenu🔗

global enum ConstructionMenu  "AIR"
  "BULLDOZER"
  "INDUSTRY"
  "LANDSCAPING"
  "MODULES"
  "MODULE_BULLDOZER"
  "PERKS"
  "RAIL"
  "ROAD"
  "ROADS"
  "TOWN"
  "WAREHOUSE"
  "WATER"
end

ConstructionMenu."AIR"🔗

ConstructionMenu."BULLDOZER"🔗

ConstructionMenu."INDUSTRY"🔗

ConstructionMenu."LANDSCAPING"🔗

ConstructionMenu."MODULES"🔗

ConstructionMenu."MODULE_BULLDOZER"🔗

ConstructionMenu."PERKS"🔗

ConstructionMenu."RAIL"🔗

ConstructionMenu."ROAD"🔗

ConstructionMenu."ROADS"🔗

ConstructionMenu."TOWN"🔗

ConstructionMenu."WAREHOUSE"🔗

ConstructionMenu."WATER"🔗

ConstructionMenuAction🔗

global enum ConstructionMenuAction  "ACTION_ASSET_BRUSH"
  "ACTION_BULLDOZER"
  "ACTION_BUS_LANE_TOOL"
  "ACTION_CONSTRUCTION_BUILDER"
  "ACTION_CROSSWALK_MODIFIER_TOOL"
  "ACTION_CUSTOM"
  "ACTION_ECO_INDUSTRY"
  "ACTION_LANE_MODIFIER_TOOL"
  "ACTION_MARKETING"
  "ACTION_MODULE_BUILDER"
  "ACTION_MODULE_BULLDOZER"
  "ACTION_PLAYER_OWNED_TOOL"
  "ACTION_PROSPECTION"
  "ACTION_STREET_BUILDER_UPGRADER"
  "ACTION_STREET_TERMINAL_BUILDER"
  "ACTION_TERRAIN_MODIFIER_FLATTEN_TOOL"
  "ACTION_TERRAIN_MODIFIER_HEIGHTMAP_TOOL"
  "ACTION_TERRAIN_MODIFIER_LOWER_TOOL"
  "ACTION_TERRAIN_MODIFIER_RAISE_TOOL"
  "ACTION_TERRAIN_MODIFIER_SMOOTH_TOOL"
  "ACTION_TERRAIN_PAINTER"
  "ACTION_TOWN_BUILDER"
  "ACTION_TOWN_BUILDER_EXPERIMENTAL"
  "ACTION_TRACK_BUILDER_UPGRADER"
  "ACTION_TRACK_EDGE_DECORATION_TOOL"
  "ACTION_TRACK_ELECTRIFICATION_TOOL"
  "ACTION_TRAFFIC_LIGHT_TOOL"
  "ACTION_TRAM_TRACK_TOOL"
end

ConstructionMenuAction."ACTION_ASSET_BRUSH"🔗

ConstructionMenuAction."ACTION_BULLDOZER"🔗

ConstructionMenuAction."ACTION_BUS_LANE_TOOL"🔗

ConstructionMenuAction."ACTION_CONSTRUCTION_BUILDER"🔗

ConstructionMenuAction."ACTION_CROSSWALK_MODIFIER_TOOL"🔗

ConstructionMenuAction."ACTION_CUSTOM"🔗

ConstructionMenuAction."ACTION_ECO_INDUSTRY"🔗

ConstructionMenuAction."ACTION_LANE_MODIFIER_TOOL"🔗

ConstructionMenuAction."ACTION_MARKETING"🔗

ConstructionMenuAction."ACTION_MODULE_BUILDER"🔗

ConstructionMenuAction."ACTION_MODULE_BULLDOZER"🔗

ConstructionMenuAction."ACTION_PLAYER_OWNED_TOOL"🔗

ConstructionMenuAction."ACTION_PROSPECTION"🔗

ConstructionMenuAction."ACTION_STREET_BUILDER_UPGRADER"🔗

ConstructionMenuAction."ACTION_STREET_TERMINAL_BUILDER"🔗

ConstructionMenuAction."ACTION_TERRAIN_MODIFIER_FLATTEN_TOOL"🔗

ConstructionMenuAction."ACTION_TERRAIN_MODIFIER_HEIGHTMAP_TOOL"🔗

ConstructionMenuAction."ACTION_TERRAIN_MODIFIER_LOWER_TOOL"🔗

ConstructionMenuAction."ACTION_TERRAIN_MODIFIER_RAISE_TOOL"🔗

ConstructionMenuAction."ACTION_TERRAIN_MODIFIER_SMOOTH_TOOL"🔗

ConstructionMenuAction."ACTION_TERRAIN_PAINTER"🔗

ConstructionMenuAction."ACTION_TOWN_BUILDER"🔗

ConstructionMenuAction."ACTION_TOWN_BUILDER_EXPERIMENTAL"🔗

ConstructionMenuAction."ACTION_TRACK_BUILDER_UPGRADER"🔗

ConstructionMenuAction."ACTION_TRACK_EDGE_DECORATION_TOOL"🔗

ConstructionMenuAction."ACTION_TRACK_ELECTRIFICATION_TOOL"🔗

ConstructionMenuAction."ACTION_TRAFFIC_LIGHT_TOOL"🔗

ConstructionMenuAction."ACTION_TRAM_TRACK_TOOL"🔗

ConstructionMenuActionParams🔗

global record ConstructionMenuActionParams  constructionActionParams: Builtin.ConstructionActionParam
  hudIconManagerParams: Builtin.HudIconManagerConfigParam<ConstructionActionHudIconParams>
  layerConfig: LayerConfig
end

ConstructionMenuActionParams.constructionActionParams🔗

ConstructionMenuActionParams.constructionActionParams: Builtin.ConstructionActionParam

ConstructionMenuActionParams.hudIconManagerParams🔗

ConstructionMenuActionParams.hudIconManagerParams: Builtin.HudIconManagerConfigParam<ConstructionActionHudIconParams>

ConstructionMenuActionParams.layerConfig🔗

ConstructionMenuActionParams.layerConfig: LayerConfig

ConstructionMenuCategory🔗

global record ConstructionMenuCategory  category: string
  menu: ConstructionMenu
  name: string
  icon: ResName
  order: integer
end

ConstructionMenuCategory.category🔗

ConstructionMenuCategory.category: string

ConstructionMenuCategory.menu🔗

ConstructionMenuCategory.menu: ConstructionMenu

ConstructionMenuCategory.name🔗

ConstructionMenuCategory.name: string

ConstructionMenuCategory.icon🔗

ConstructionMenuCategory.icon: ResName

ConstructionMenuCategory.order🔗

ConstructionMenuCategory.order: integer

ConstructionMenuModuleCategory🔗

global record ConstructionMenuModuleCategory  categoryName: string
  category: string
  icon: string
  modules: {{string, ModuleDesc}}
  typeAvailability: {string : ConstructionAvailability}
end

ConstructionMenuModuleCategory.categoryName🔗

ConstructionMenuModuleCategory.categoryName: string

ConstructionMenuModuleCategory.category🔗

ConstructionMenuModuleCategory.category: string

ConstructionMenuModuleCategory.icon🔗

ConstructionMenuModuleCategory.icon: string

ConstructionMenuModuleCategory.modules🔗

ConstructionMenuModuleCategory.modules: {{string, ModuleDesc}}

ConstructionMenuModuleCategory.typeAvailability🔗

ConstructionMenuModuleCategory.typeAvailability: {string : ConstructionAvailability}

ConstructionMenuParam🔗

 
global record ConstructionMenuParam  new: function(): ConstructionMenuParam
  key: string
  name: string
  tooltip: string
  values: {string}
  numbers: {number}
  defaultIndex: Index
  uiType: ScriptParamType
  iconStyle: ScriptParamUtil.ParamForUi.IconStyle
  location: ScriptParamLocation
  displayMode: ScriptParamDisplayMode
  yearFrom: integer
  yearTo: integer
  group: string
  tooltips: {string}
  
enum CheckEnabledResult    "Disabled"
    "Enabled"
    "Hidden"
    "InputActionOnly"
end

  onChangeFn: function(number, ConstructionMenuParamsAPI, number)
  checkEnabledFn: function({string : number}): ConstructionMenuParam.CheckEnabledResult
  makeCompactButtonFn: function(number): TreeNodeId
  formatValueFn: function(number): string
  getImageFn: function(integer): string
  stepValueFn: function(number, integer, boolean): number
  getFilterObjectsFn: function(): {MenuCategoryUtil.FilterObject}, integer
  hideLabel: boolean
  resetOnCategoryChange: boolean
  resetOnMenuClose: boolean
  resetOnDefinitionChange: boolean
  preserveValueInAllCategories: boolean
  constructionParam: boolean
  id: string
end

ConstructionMenuParam.new🔗

function ConstructionMenuParam.new(): ConstructionMenuParam
Returns
  1. ConstructionMenuParam

ConstructionMenuParam.key🔗

ConstructionMenuParam.key: string

ConstructionMenuParam.name🔗

ConstructionMenuParam.name: string

ConstructionMenuParam.tooltip🔗

ConstructionMenuParam.tooltip: string

ConstructionMenuParam.values🔗

ConstructionMenuParam.values: {string}

ConstructionMenuParam.numbers🔗

ConstructionMenuParam.numbers: {number}

ConstructionMenuParam.defaultIndex🔗

ConstructionMenuParam.defaultIndex: Index

ConstructionMenuParam.uiType🔗

ConstructionMenuParam.uiType: ScriptParamType

ConstructionMenuParam.iconStyle🔗

ConstructionMenuParam.iconStyle: ScriptParamUtil.ParamForUi.IconStyle

ConstructionMenuParam.location🔗

ConstructionMenuParam.location: ScriptParamLocation

ConstructionMenuParam.displayMode🔗

ConstructionMenuParam.displayMode: ScriptParamDisplayMode

ConstructionMenuParam.yearFrom🔗

ConstructionMenuParam.yearFrom: integer

ConstructionMenuParam.yearTo🔗

ConstructionMenuParam.yearTo: integer

ConstructionMenuParam.group🔗

ConstructionMenuParam.group: string

ConstructionMenuParam.tooltips🔗

ConstructionMenuParam.tooltips: {string}

ConstructionMenuParam.CheckEnabledResult🔗

enum ConstructionMenuParam.CheckEnabledResult  "Disabled"
  "Enabled"
  "Hidden"
  "InputActionOnly"
end

ConstructionMenuParam.CheckEnabledResult."Disabled"🔗

ConstructionMenuParam.CheckEnabledResult."Enabled"🔗

ConstructionMenuParam.CheckEnabledResult."Hidden"🔗

ConstructionMenuParam.CheckEnabledResult."InputActionOnly"🔗

ConstructionMenuParam.onChangeFn🔗

function ConstructionMenuParam.onChangeFn(number, ConstructionMenuParamsAPI, number)
Parameters
  • number
  • ConstructionMenuParamsAPI
  • number

ConstructionMenuParam.checkEnabledFn🔗

function ConstructionMenuParam.checkEnabledFn({string : number}): ConstructionMenuParam.CheckEnabledResult
Parameters
  • {string : number}
Returns
  1. ConstructionMenuParam.CheckEnabledResult

ConstructionMenuParam.makeCompactButtonFn🔗

function ConstructionMenuParam.makeCompactButtonFn(number): TreeNodeId
Parameters
  • number
Returns
  1. TreeNodeId

ConstructionMenuParam.formatValueFn🔗

function ConstructionMenuParam.formatValueFn(number): string
Parameters
  • number
Returns
  1. string

ConstructionMenuParam.getImageFn🔗

function ConstructionMenuParam.getImageFn(integer): string
Parameters
  • integer
Returns
  1. string

ConstructionMenuParam.stepValueFn🔗

function ConstructionMenuParam.stepValueFn(number, integer, boolean): number
Parameters
  • number
  • integer
  • boolean
Returns
  1. number

ConstructionMenuParam.getFilterObjectsFn🔗

function ConstructionMenuParam.getFilterObjectsFn(): {MenuCategoryUtil.FilterObject}, integer
Returns
  1. {MenuCategoryUtil.FilterObject}
  2. integer

ConstructionMenuParam.hideLabel🔗

ConstructionMenuParam.hideLabel: boolean

ConstructionMenuParam.resetOnCategoryChange🔗

ConstructionMenuParam.resetOnCategoryChange: boolean

ConstructionMenuParam.resetOnMenuClose🔗

ConstructionMenuParam.resetOnMenuClose: boolean

ConstructionMenuParam.resetOnDefinitionChange🔗

ConstructionMenuParam.resetOnDefinitionChange: boolean

ConstructionMenuParam.preserveValueInAllCategories🔗

ConstructionMenuParam.preserveValueInAllCategories: boolean

ConstructionMenuParam.constructionParam🔗

ConstructionMenuParam.constructionParam: boolean

ConstructionMenuParam.id🔗

ConstructionMenuParam.id: string

ConstructionMenuParamInfo🔗

global record ConstructionMenuParamInfo  index: integer
  param: ConstructionMenuParam
  value: number
end

ConstructionMenuParamInfo.index🔗

ConstructionMenuParamInfo.index: integer

ConstructionMenuParamInfo.param🔗

ConstructionMenuParamInfo.param: ConstructionMenuParam

ConstructionMenuParamInfo.value🔗

ConstructionMenuParamInfo.value: number

ConstructionMenuParamsAPI🔗

global record ConstructionMenuParamsAPI  setActiveDefinition: function(ConstructionDefinition, integer, string): {string : number}
  getParamsForDefinition: function(ConstructionDefinition, integer): {string : number}
  getStoredValues: function(integer): {string : number}
  changeParam: function(integer, number)
  setParamDisabled: function(integer, boolean)
  isParamActive: function(string): boolean
  getParam: function(integer): ConstructionMenuParam
  getCategory: function(): integer
  getParamByKey: function(string): ConstructionMenuParamInfo
  updateVisibility: function()
  getCurrentParams: function(): {string : number}
  onInfoPopupVisibilityChange: function(boolean)
end

ConstructionMenuParamsAPI.setActiveDefinition🔗

function ConstructionMenuParamsAPI.setActiveDefinition(ConstructionDefinition, integer, string): {string : number}
Parameters
  • ConstructionDefinition
  • integer
  • string
Returns
  1. {string : number}

ConstructionMenuParamsAPI.getParamsForDefinition🔗

function ConstructionMenuParamsAPI.getParamsForDefinition(ConstructionDefinition, integer): {string : number}
Parameters
  • ConstructionDefinition
  • integer
Returns
  1. {string : number}

ConstructionMenuParamsAPI.getStoredValues🔗

function ConstructionMenuParamsAPI.getStoredValues(integer): {string : number}
Parameters
  • integer
Returns
  1. {string : number}

ConstructionMenuParamsAPI.changeParam🔗

function ConstructionMenuParamsAPI.changeParam(integer, number)
Parameters
  • integer
  • number

ConstructionMenuParamsAPI.setParamDisabled🔗

function ConstructionMenuParamsAPI.setParamDisabled(integer, boolean)
Parameters
  • integer
  • boolean

ConstructionMenuParamsAPI.isParamActive🔗

function ConstructionMenuParamsAPI.isParamActive(string): boolean
Parameters
  • string
Returns
  1. boolean

ConstructionMenuParamsAPI.getParam🔗

function ConstructionMenuParamsAPI.getParam(integer): ConstructionMenuParam
Parameters
  • integer
Returns
  1. ConstructionMenuParam

ConstructionMenuParamsAPI.getCategory🔗

function ConstructionMenuParamsAPI.getCategory(): integer
Returns
  1. integer

ConstructionMenuParamsAPI.getParamByKey🔗

function ConstructionMenuParamsAPI.getParamByKey(string): ConstructionMenuParamInfo
Parameters
  • string
Returns
  1. ConstructionMenuParamInfo

ConstructionMenuParamsAPI.updateVisibility🔗

function ConstructionMenuParamsAPI.updateVisibility()

ConstructionMenuParamsAPI.getCurrentParams🔗

function ConstructionMenuParamsAPI.getCurrentParams(): {string : number}
Returns
  1. {string : number}

ConstructionMenuParamsAPI.onInfoPopupVisibilityChange🔗

function ConstructionMenuParamsAPI.onInfoPopupVisibilityChange(boolean)
Parameters
  • boolean

ConstructionToolData🔗

global record ConstructionToolData  getDefinitionFn: ScriptRef
  isDisabledFn: ScriptRef
end

ConstructionToolData.getDefinitionFn🔗

ConstructionToolData.getDefinitionFn: ScriptRef

ConstructionToolData.isDisabledFn🔗

ConstructionToolData.isDisabledFn: ScriptRef

IconWithAvailability🔗

global record IconWithAvailability  icon: string
  lockedIcon: string
  yearFrom: {{integer, string}}
end

IconWithAvailability.icon🔗

IconWithAvailability.icon: string

IconWithAvailability.lockedIcon🔗

IconWithAvailability.lockedIcon: string

IconWithAvailability.yearFrom🔗

IconWithAvailability.yearFrom: {{integer, string}}

RegisterCustomSelectorBasedActionRecipeParams🔗

global record RegisterCustomSelectorBasedActionRecipeParams<P>  isAvailable: function(ConstructionCustomActionParams<P>): boolean
  isActive: boolean
  onHover: function(ConstructionCustomActionParams<P>, Engine.Entity, {integer}, Gui.SelectionDetails): SelectorBasedActionHoverResult
  onSelect: function(ConstructionCustomActionParams<P>, Engine.Entity)
  filter: function(Engine.Entity)
end
Type Parameters
  • P

RegisterCustomSelectorBasedActionRecipeParams.isAvailable🔗

function RegisterCustomSelectorBasedActionRecipeParams.isAvailable(ConstructionCustomActionParams<P>): boolean
Parameters
  • ConstructionCustomActionParams<P>
Returns
  1. boolean

RegisterCustomSelectorBasedActionRecipeParams.isActive🔗

RegisterCustomSelectorBasedActionRecipeParams.isActive: boolean

RegisterCustomSelectorBasedActionRecipeParams.onHover🔗

function RegisterCustomSelectorBasedActionRecipeParams.onHover(ConstructionCustomActionParams<P>, Engine.Entity, {integer}, Gui.SelectionDetails): SelectorBasedActionHoverResult
Parameters
  • ConstructionCustomActionParams<P>
  • Engine.Entity
  • {integer}
  • Gui.SelectionDetails
Returns
  1. SelectorBasedActionHoverResult

RegisterCustomSelectorBasedActionRecipeParams.onSelect🔗

function RegisterCustomSelectorBasedActionRecipeParams.onSelect(ConstructionCustomActionParams<P>, Engine.Entity)
Parameters
  • ConstructionCustomActionParams<P>
  • Engine.Entity

RegisterCustomSelectorBasedActionRecipeParams.filter🔗

function RegisterCustomSelectorBasedActionRecipeParams.filter(Engine.Entity)
Parameters
  • Engine.Entity

SelectorBasedActionHoverResult🔗

global record SelectorBasedActionHoverResult  param: Builtin.ActionTooltipParam<<any type>>
  mouseCursor: integer
end

SelectorBasedActionHoverResult.param🔗

SelectorBasedActionHoverResult.param: Builtin.ActionTooltipParam<<any type>>

SelectorBasedActionHoverResult.mouseCursor🔗

SelectorBasedActionHoverResult.mouseCursor: integer