Module content.gui.construction.construction_react_util🔗

 
global record ConstructionReactUtil  
record ItemDisableCache    company: CompanyUtil.ConstructionDisableCacheData
end

  
record ItemDisableReason    reason: string
    elapsedCooldownFraction: number
    category: string
end

  
record ConstructionMenuSetTabEventParam    tabIndex: integer
    allowStacking: boolean
    sublistId: string
end

  
record ConstructionMenuSelectConstructionEventParam    resName: ResName
end

  
record SimpleTooltipRecipeParams    
record MessageGoodOrBad      message: string
      good: boolean
      bad: boolean
end

    message: MessageGoodOrBad
    cost: integer
end

  
record DefinitionWithFilterCategories    definition: ConstructionDefinition
    filterCategories: {string}
end

  getConstructionDefinitions: function(): {ConstructionDefinition}
  convertScriptParamsToMenuParams: function({ScriptParam}, boolean): {ConstructionMenuParam}
  getPerksProspectionDefinitions: function(): {ConstructionDefinition}
  getModuleDefinitions: function(): {ConstructionDefinition}
  getStreetDefinitions: function(boolean): {ConstructionDefinition}
  getStreetToolsHudIcons: function(ConstructionActionHudIconConstructionType): ConstructionActionHudIcons
  getTrackDefinitions: function(): {ConstructionDefinition}
  getMaterialsDefinitions: function(ConstructionToolParam.TerrainToolData, boolean): {ConstructionDefinition}
  forEachDefinition: function(function(ConstructionDefinition), ConstructionActionRepository)
  makeItemDisabledCache: function({ConstructionDefinition}): ItemDisableCache
  checkItemDisabledDefault: function(ConstructionDefinition, ItemDisableCache): ItemDisableReason
  checkItemRemainingNum: function(ConstructionDefinition, ItemDisableCache): integer | nil
  makeUndergroundParam: function(function(integer, integer, boolean) : integer, function({string : number}) : ConstructionMenuParam.CheckEnabledResult, boolean): ConstructionMenuParam
  
record BrushConstructionArgs    numSizes: integer
    minSize: number
    maxSize: number
    scale: number
    prefix: string
    defaultStrength: number
    single: boolean
    slope: boolean
    invert: boolean
    invertTooltip: string
    randomize: boolean
    ignoreCollision: boolean
    eraseWhenEmpty: boolean
    heightMaps: {integer}
end

  getBrushConstructionParams: function(ConstructionReactUtil.BrushConstructionArgs): {ConstructionMenuParam}
  getMenuCategories: function(ConstructionActionRepository): {ConstructionMenu : {{ConstructionMenuCategory, {ConstructionDefinition}}}}
  getConstructionActionRepository: function(ConstructionToolParam.TerrainToolData, boolean): ConstructionActionRepository
  getActionParams: function(ConstructionDefinition, {string : number}, ConstructionActionRepository, boolean, ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>, Engine.Entity, function(Engine.Entity) : {Notification}, ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>): ConstructionMenuActionParams
  getAllCompanyDefinitions: function(ConstructionToolParam.TerrainToolData): {ConstructionDefinition}
  constructIcon: function(IconWithAvailability, boolean): TreeNodeId
  mergeLayerConfig: function(LayerConfig, LayerConfig): LayerConfig
  makeWhiteScreen: function(LayerConfig, LayerColors)
  SimpleTooltipRecipe: Recipe<ConstructionReactUtil.SimpleTooltipRecipeParams>
  RegisterCustomSelectorBasedActionRecipe: function<P>(string, RegisterCustomSelectorBasedActionRecipeParams<P>): Recipe<ConstructionCustomActionParams<P>>
end


global record StampData  heightmap: string
  icon: string
end

Category: globals🔗

ConstructionReactUtil🔗

 
global record ConstructionReactUtil  
record ItemDisableCache    company: CompanyUtil.ConstructionDisableCacheData
end

  
record ItemDisableReason    reason: string
    elapsedCooldownFraction: number
    category: string
end

  
record ConstructionMenuSetTabEventParam    tabIndex: integer
    allowStacking: boolean
    sublistId: string
end

  
record ConstructionMenuSelectConstructionEventParam    resName: ResName
end

  
record SimpleTooltipRecipeParams    
record MessageGoodOrBad      message: string
      good: boolean
      bad: boolean
end

    message: MessageGoodOrBad
    cost: integer
end

  
record DefinitionWithFilterCategories    definition: ConstructionDefinition
    filterCategories: {string}
end

  getConstructionDefinitions: function(): {ConstructionDefinition}
  convertScriptParamsToMenuParams: function({ScriptParam}, boolean): {ConstructionMenuParam}
  getPerksProspectionDefinitions: function(): {ConstructionDefinition}
  getModuleDefinitions: function(): {ConstructionDefinition}
  getStreetDefinitions: function(boolean): {ConstructionDefinition}
  getStreetToolsHudIcons: function(ConstructionActionHudIconConstructionType): ConstructionActionHudIcons
  getTrackDefinitions: function(): {ConstructionDefinition}
  getMaterialsDefinitions: function(ConstructionToolParam.TerrainToolData, boolean): {ConstructionDefinition}
  forEachDefinition: function(function(ConstructionDefinition), ConstructionActionRepository)
  makeItemDisabledCache: function({ConstructionDefinition}): ItemDisableCache
  checkItemDisabledDefault: function(ConstructionDefinition, ItemDisableCache): ItemDisableReason
  checkItemRemainingNum: function(ConstructionDefinition, ItemDisableCache): integer | nil
  makeUndergroundParam: function(function(integer, integer, boolean) : integer, function({string : number}) : ConstructionMenuParam.CheckEnabledResult, boolean): ConstructionMenuParam
  
record BrushConstructionArgs    numSizes: integer
    minSize: number
    maxSize: number
    scale: number
    prefix: string
    defaultStrength: number
    single: boolean
    slope: boolean
    invert: boolean
    invertTooltip: string
    randomize: boolean
    ignoreCollision: boolean
    eraseWhenEmpty: boolean
    heightMaps: {integer}
end

  getBrushConstructionParams: function(ConstructionReactUtil.BrushConstructionArgs): {ConstructionMenuParam}
  getMenuCategories: function(ConstructionActionRepository): {ConstructionMenu : {{ConstructionMenuCategory, {ConstructionDefinition}}}}
  getConstructionActionRepository: function(ConstructionToolParam.TerrainToolData, boolean): ConstructionActionRepository
  getActionParams: function(ConstructionDefinition, {string : number}, ConstructionActionRepository, boolean, ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>, Engine.Entity, function(Engine.Entity) : {Notification}, ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>): ConstructionMenuActionParams
  getAllCompanyDefinitions: function(ConstructionToolParam.TerrainToolData): {ConstructionDefinition}
  constructIcon: function(IconWithAvailability, boolean): TreeNodeId
  mergeLayerConfig: function(LayerConfig, LayerConfig): LayerConfig
  makeWhiteScreen: function(LayerConfig, LayerColors)
  SimpleTooltipRecipe: Recipe<ConstructionReactUtil.SimpleTooltipRecipeParams>
  RegisterCustomSelectorBasedActionRecipe: function<P>(string, RegisterCustomSelectorBasedActionRecipeParams<P>): Recipe<ConstructionCustomActionParams<P>>
end

ConstructionReactUtil.ItemDisableCache🔗

record ConstructionReactUtil.ItemDisableCache  company: CompanyUtil.ConstructionDisableCacheData
end

ConstructionReactUtil.ItemDisableCache.company🔗

ConstructionReactUtil.ItemDisableCache.company: CompanyUtil.ConstructionDisableCacheData

ConstructionReactUtil.ItemDisableReason🔗

record ConstructionReactUtil.ItemDisableReason  reason: string
  elapsedCooldownFraction: number
  category: string
end

ConstructionReactUtil.ItemDisableReason.reason🔗

ConstructionReactUtil.ItemDisableReason.reason: string

ConstructionReactUtil.ItemDisableReason.elapsedCooldownFraction🔗

ConstructionReactUtil.ItemDisableReason.elapsedCooldownFraction: number

ConstructionReactUtil.ItemDisableReason.category🔗

ConstructionReactUtil.ItemDisableReason.category: string

ConstructionReactUtil.ConstructionMenuSetTabEventParam🔗

record ConstructionReactUtil.ConstructionMenuSetTabEventParam  tabIndex: integer
  allowStacking: boolean
  sublistId: string
end

ConstructionReactUtil.ConstructionMenuSetTabEventParam.tabIndex🔗

ConstructionReactUtil.ConstructionMenuSetTabEventParam.tabIndex: integer

ConstructionReactUtil.ConstructionMenuSetTabEventParam.allowStacking🔗

ConstructionReactUtil.ConstructionMenuSetTabEventParam.allowStacking: boolean

ConstructionReactUtil.ConstructionMenuSetTabEventParam.sublistId🔗

ConstructionReactUtil.ConstructionMenuSetTabEventParam.sublistId: string

ConstructionReactUtil.ConstructionMenuSelectConstructionEventParam🔗

record ConstructionReactUtil.ConstructionMenuSelectConstructionEventParam  resName: ResName
end

ConstructionReactUtil.ConstructionMenuSelectConstructionEventParam.resName🔗

ConstructionReactUtil.ConstructionMenuSelectConstructionEventParam.resName: ResName

ConstructionReactUtil.SimpleTooltipRecipeParams🔗

 
record ConstructionReactUtil.SimpleTooltipRecipeParams  
record MessageGoodOrBad    message: string
    good: boolean
    bad: boolean
end

  message: MessageGoodOrBad
  cost: integer
end

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad🔗

record ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad  message: string
  good: boolean
  bad: boolean
end

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad.message🔗

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad.message: string

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad.good🔗

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad.good: boolean

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad.bad🔗

ConstructionReactUtil.SimpleTooltipRecipeParams.MessageGoodOrBad.bad: boolean

ConstructionReactUtil.SimpleTooltipRecipeParams.message🔗

ConstructionReactUtil.SimpleTooltipRecipeParams.message: MessageGoodOrBad

ConstructionReactUtil.SimpleTooltipRecipeParams.cost🔗

ConstructionReactUtil.SimpleTooltipRecipeParams.cost: integer

ConstructionReactUtil.DefinitionWithFilterCategories🔗

record ConstructionReactUtil.DefinitionWithFilterCategories  definition: ConstructionDefinition
  filterCategories: {string}
end

ConstructionReactUtil.DefinitionWithFilterCategories.definition🔗

ConstructionReactUtil.DefinitionWithFilterCategories.definition: ConstructionDefinition

ConstructionReactUtil.DefinitionWithFilterCategories.filterCategories🔗

ConstructionReactUtil.DefinitionWithFilterCategories.filterCategories: {string}

ConstructionReactUtil.getConstructionDefinitions🔗

function ConstructionReactUtil.getConstructionDefinitions(): {ConstructionDefinition}
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.convertScriptParamsToMenuParams🔗

function ConstructionReactUtil.convertScriptParamsToMenuParams({ScriptParam}, boolean): {ConstructionMenuParam}
Parameters
  • {ScriptParam}
  • boolean
Returns
  1. {ConstructionMenuParam}

ConstructionReactUtil.getPerksProspectionDefinitions🔗

function ConstructionReactUtil.getPerksProspectionDefinitions(): {ConstructionDefinition}
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.getModuleDefinitions🔗

function ConstructionReactUtil.getModuleDefinitions(): {ConstructionDefinition}
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.getStreetDefinitions🔗

function ConstructionReactUtil.getStreetDefinitions(boolean): {ConstructionDefinition}
Parameters
  • boolean
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.getStreetToolsHudIcons🔗

function ConstructionReactUtil.getStreetToolsHudIcons(ConstructionActionHudIconConstructionType): ConstructionActionHudIcons
Parameters
  • ConstructionActionHudIconConstructionType
Returns
  1. ConstructionActionHudIcons

ConstructionReactUtil.getTrackDefinitions🔗

function ConstructionReactUtil.getTrackDefinitions(): {ConstructionDefinition}
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.getMaterialsDefinitions🔗

function ConstructionReactUtil.getMaterialsDefinitions(ConstructionToolParam.TerrainToolData, boolean): {ConstructionDefinition}
Parameters
  • ConstructionToolParam.TerrainToolData
  • boolean
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.forEachDefinition🔗

function ConstructionReactUtil.forEachDefinition(function(ConstructionDefinition), ConstructionActionRepository)
Parameters
  • function(ConstructionDefinition)
  • ConstructionActionRepository

ConstructionReactUtil.makeItemDisabledCache🔗

function ConstructionReactUtil.makeItemDisabledCache({ConstructionDefinition}): ItemDisableCache
Parameters
  • {ConstructionDefinition}
Returns
  1. ItemDisableCache

ConstructionReactUtil.checkItemDisabledDefault🔗

function ConstructionReactUtil.checkItemDisabledDefault(ConstructionDefinition, ItemDisableCache): ItemDisableReason
Parameters
  • ConstructionDefinition
  • ItemDisableCache
Returns
  1. ItemDisableReason

ConstructionReactUtil.checkItemRemainingNum🔗

function ConstructionReactUtil.checkItemRemainingNum(ConstructionDefinition, ItemDisableCache): integer | nil
Parameters
  • ConstructionDefinition
  • ItemDisableCache
Returns
  1. integer | nil

ConstructionReactUtil.makeUndergroundParam🔗

function ConstructionReactUtil.makeUndergroundParam(function(integer, integer, boolean) : integer, function({string : number}) : ConstructionMenuParam.CheckEnabledResult, boolean): ConstructionMenuParam
Parameters
  • function(integer, integer, boolean): integer
  • function({string : number}): ConstructionMenuParam.CheckEnabledResult
  • boolean
Returns
  1. ConstructionMenuParam

ConstructionReactUtil.BrushConstructionArgs🔗

record ConstructionReactUtil.BrushConstructionArgs  numSizes: integer
  minSize: number
  maxSize: number
  scale: number
  prefix: string
  defaultStrength: number
  single: boolean
  slope: boolean
  invert: boolean
  invertTooltip: string
  randomize: boolean
  ignoreCollision: boolean
  eraseWhenEmpty: boolean
  heightMaps: {integer}
end

ConstructionReactUtil.BrushConstructionArgs.numSizes🔗

ConstructionReactUtil.BrushConstructionArgs.numSizes: integer

ConstructionReactUtil.BrushConstructionArgs.minSize🔗

ConstructionReactUtil.BrushConstructionArgs.minSize: number

ConstructionReactUtil.BrushConstructionArgs.maxSize🔗

ConstructionReactUtil.BrushConstructionArgs.maxSize: number

ConstructionReactUtil.BrushConstructionArgs.scale🔗

ConstructionReactUtil.BrushConstructionArgs.scale: number

ConstructionReactUtil.BrushConstructionArgs.prefix🔗

ConstructionReactUtil.BrushConstructionArgs.prefix: string

ConstructionReactUtil.BrushConstructionArgs.defaultStrength🔗

ConstructionReactUtil.BrushConstructionArgs.defaultStrength: number

ConstructionReactUtil.BrushConstructionArgs.single🔗

ConstructionReactUtil.BrushConstructionArgs.single: boolean

ConstructionReactUtil.BrushConstructionArgs.slope🔗

ConstructionReactUtil.BrushConstructionArgs.slope: boolean

ConstructionReactUtil.BrushConstructionArgs.invert🔗

ConstructionReactUtil.BrushConstructionArgs.invert: boolean

ConstructionReactUtil.BrushConstructionArgs.invertTooltip🔗

ConstructionReactUtil.BrushConstructionArgs.invertTooltip: string

ConstructionReactUtil.BrushConstructionArgs.randomize🔗

ConstructionReactUtil.BrushConstructionArgs.randomize: boolean

ConstructionReactUtil.BrushConstructionArgs.ignoreCollision🔗

ConstructionReactUtil.BrushConstructionArgs.ignoreCollision: boolean

ConstructionReactUtil.BrushConstructionArgs.eraseWhenEmpty🔗

ConstructionReactUtil.BrushConstructionArgs.eraseWhenEmpty: boolean

ConstructionReactUtil.BrushConstructionArgs.heightMaps🔗

ConstructionReactUtil.BrushConstructionArgs.heightMaps: {integer}

ConstructionReactUtil.getBrushConstructionParams🔗

function ConstructionReactUtil.getBrushConstructionParams(ConstructionReactUtil.BrushConstructionArgs): {ConstructionMenuParam}
Parameters
  • ConstructionReactUtil.BrushConstructionArgs
Returns
  1. {ConstructionMenuParam}

ConstructionReactUtil.getMenuCategories🔗

function ConstructionReactUtil.getMenuCategories(ConstructionActionRepository): {ConstructionMenu : {{ConstructionMenuCategory, {ConstructionDefinition}}}}
Parameters
  • ConstructionActionRepository
Returns
  1. {ConstructionMenu : {{ConstructionMenuCategory, {ConstructionDefinition}}}}

ConstructionReactUtil.getConstructionActionRepository🔗

function ConstructionReactUtil.getConstructionActionRepository(ConstructionToolParam.TerrainToolData, boolean): ConstructionActionRepository
Parameters
  • ConstructionToolParam.TerrainToolData
  • boolean
Returns
  1. ConstructionActionRepository

ConstructionReactUtil.getActionParams🔗

function ConstructionReactUtil.getActionParams(ConstructionDefinition, {string : number}, ConstructionActionRepository, boolean, ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>, Engine.Entity, function(Engine.Entity) : {Notification}, ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>): ConstructionMenuActionParams
Parameters
  • ConstructionDefinition
  • {string : number}
  • ConstructionActionRepository
  • boolean
  • ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>
  • Engine.Entity
  • function(Engine.Entity): {Notification}
  • ReactRefWrapApiT<<any type>, ConstructionMenuParamsAPI>
Returns
  1. ConstructionMenuActionParams

ConstructionReactUtil.getAllCompanyDefinitions🔗

function ConstructionReactUtil.getAllCompanyDefinitions(ConstructionToolParam.TerrainToolData): {ConstructionDefinition}
Parameters
  • ConstructionToolParam.TerrainToolData
Returns
  1. {ConstructionDefinition}

ConstructionReactUtil.constructIcon🔗

function ConstructionReactUtil.constructIcon(IconWithAvailability, boolean): TreeNodeId
Parameters
  • IconWithAvailability
  • boolean
Returns
  1. TreeNodeId

ConstructionReactUtil.mergeLayerConfig🔗

function ConstructionReactUtil.mergeLayerConfig(LayerConfig, LayerConfig): LayerConfig
Parameters
  • LayerConfig
  • LayerConfig
Returns
  1. LayerConfig

ConstructionReactUtil.makeWhiteScreen🔗

function ConstructionReactUtil.makeWhiteScreen(LayerConfig, LayerColors)
Parameters
  • LayerConfig
  • LayerColors

ConstructionReactUtil.SimpleTooltipRecipe🔗

ConstructionReactUtil.SimpleTooltipRecipe: Recipe<ConstructionReactUtil.SimpleTooltipRecipeParams>

ConstructionReactUtil.RegisterCustomSelectorBasedActionRecipe🔗

function ConstructionReactUtil.RegisterCustomSelectorBasedActionRecipe<P>(string, RegisterCustomSelectorBasedActionRecipeParams<P>): Recipe<ConstructionCustomActionParams<P>>
Type Parameters
  • P
Parameters
  • string
  • RegisterCustomSelectorBasedActionRecipeParams<P>
Returns
  1. Recipe<ConstructionCustomActionParams<P>>

StampData🔗

global record StampData  heightmap: string
  icon: string
end

StampData.heightmap🔗

StampData.heightmap: string

StampData.icon🔗

StampData.icon: string