api:building_function
Table of Contents
BUILDING_FUNCTION
Properties
Name
NamePluralKey
Description
HasMaximumInstance
MaximumInstanceAllowed
UpkeepPerCapacity
- Can also be built from:
list<RESOURCE_QUANTITY_PAIR> - Expected:
RESOURCE_COLLECTION_VALUE valueorlist of RESOURCE_QUANTITY_PAIR values
UpkeepPerCapacityMultiplier
GameRuleModifierList
IsDescriptionOverride
ShowNameInTags
IsDisplayable
IsCallRemoveBuildingFunctionOnBuildableDestruction
- Type:
boolean - Expected:
boolean value - Default value:
false
Functions
onBuildingFunctionKnown
onBuildingFunctionAvailable
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: 2025/08/25 14:15 by 127.0.0.1
