User Tools

Site Tools


api:building_function

BUILDING_FUNCTION

Properties


Name

Serialized

  • Type: string
  • Expected: string value

Description

Serialized

  • Type: string
  • Expected: string value

HasMaximumInstance

Serialized

  • Type: boolean
  • Expected: boolean value
  • Default value: false

MaximumInstanceAllowed

Serialized


UpkeepPerCapacity

Serialized


UpkeepPerCapacityMultiplier

Serialized

  • Type: float
  • Expected: float value
  • Default value: 1.0f

GameRuleModifierList

Serialized


IsDescriptionOverride

Serialized

  • Type: boolean
  • Expected: boolean value
  • Default value: true

ShowNameInTags

Serialized

  • Type: boolean
  • Expected: boolean value
  • Default value: false

IsDisplayable

Serialized

  • Type: boolean
  • Expected: boolean value
  • Default value: true

Functions


onBuildingFunctionKnown

Virtual function

void onBuildingFunctionKnown(level)

Name Type Description
level LEVEL

onBuildingFunctionAvailable

Virtual function

void onBuildingFunctionAvailable(level)

Name Type Description
level LEVEL

activateBuilding

Virtual function, Protected function

boolean activateBuilding(object)

Deprecated since version 1.9.7; Override onInit instead

Name Type Description
object GAME_OBJECT

onInit

Virtual function, Protected function

boolean onInit(object)

Name Type Description
object GAME_OBJECT

onSetIsActive

Virtual function, Protected function

void onSetIsActive(object, isActive)

Name Type Description
object GAME_OBJECT
isActive boolean

reloadBuildingFunction

Virtual function, Protected function

void reloadBuildingFunction(object)

Name Type Description
object GAME_OBJECT

removeBuildingFunction

Virtual function, Protected function

void removeBuildingFunction(object)

Name Type Description
object GAME_OBJECT
api/building_function.txt · Last modified: 2024/02/06 13:53 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki