Foundation - Modding Documentation

User Tools

Site Tools

Trace:
preview:api:building_function

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
preview:api:building_function [2020/07/07 17:52] – maximepreview:api:building_function [2023/12/12 12:15] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== BUILDING_FUNCTION ====== ====== BUILDING_FUNCTION ======
  
-//Abstract class//\\+**[[:custom-classes#Extendable classes|Extendable]]**\\
 **Category**: Asset **Category**: Asset
- 
-**Extendable** 
  
 Parent class:  [[preview:api:asset|ASSET]]\\ Parent class:  [[preview:api:asset|ASSET]]\\
 Inherited by: Inherited by:
 +  * [[preview:api:building_function_assignable|BUILDING_FUNCTION_ASSIGNABLE]]
   * [[preview:api:building_function_bridge|BUILDING_FUNCTION_BRIDGE]]   * [[preview:api:building_function_bridge|BUILDING_FUNCTION_BRIDGE]]
 +  * [[preview:api:building_function_great_hall|BUILDING_FUNCTION_GREAT_HALL]]
 +  * [[preview:api:building_function_house|BUILDING_FUNCTION_HOUSE]]
   * [[preview:api:building_function_inn|BUILDING_FUNCTION_INN]]   * [[preview:api:building_function_inn|BUILDING_FUNCTION_INN]]
-  * [[preview:api:building_function_village_center|BUILDING_FUNCTION_VILLAGE_CENTER]] +  * [[preview:api:building_function_interactive_location|BUILDING_FUNCTION_INTERACTIVE_LOCATION]] 
-  * [[preview:api:building_function_public_lounge|BUILDING_FUNCTION_PUBLIC_LOUNGE]]+  * [[preview:api:building_function_lodging|BUILDING_FUNCTION_LODGING]] 
 +  * [[preview:api:building_function_monastery|BUILDING_FUNCTION_MONASTERY]] 
 +  * [[preview:api:building_function_musical_part|BUILDING_FUNCTION_MUSICAL_PART]]
   * [[preview:api:building_function_point_of_interest|BUILDING_FUNCTION_POINT_OF_INTEREST]]   * [[preview:api:building_function_point_of_interest|BUILDING_FUNCTION_POINT_OF_INTEREST]]
-  * [[preview:api:building_function_great_hall|BUILDING_FUNCTION_GREAT_HALL]]+  * [[preview:api:building_function_public_lounge|BUILDING_FUNCTION_PUBLIC_LOUNGE]]
   * [[preview:api:building_function_public_lounge_room|BUILDING_FUNCTION_PUBLIC_LOUNGE_ROOM]]   * [[preview:api:building_function_public_lounge_room|BUILDING_FUNCTION_PUBLIC_LOUNGE_ROOM]]
-  * [[preview:api:building_function_monastery|BUILDING_FUNCTION_MONASTERY]] 
-  * [[preview:api:building_function_assignable|BUILDING_FUNCTION_ASSIGNABLE]] 
-  * [[preview:api:building_function_church_bell|BUILDING_FUNCTION_CHURCH_BELL]] 
-  * [[preview:api:building_function_house|BUILDING_FUNCTION_HOUSE]] 
   * [[preview:api:building_function_resource_generator|BUILDING_FUNCTION_RESOURCE_GENERATOR]]   * [[preview:api:building_function_resource_generator|BUILDING_FUNCTION_RESOURCE_GENERATOR]]
 +  * [[preview:api:building_function_resource_stockpile|BUILDING_FUNCTION_RESOURCE_STOCKPILE]]
 +  * [[preview:api:building_function_training_site|BUILDING_FUNCTION_TRAINING_SITE]]
 +  * [[preview:api:building_function_unique_resource_depot|BUILDING_FUNCTION_UNIQUE_RESOURCE_DEPOT]]
 +  * [[preview:api:building_function_village_center|BUILDING_FUNCTION_VILLAGE_CENTER]]
   * [[preview:api:building_function_workplace|BUILDING_FUNCTION_WORKPLACE]]   * [[preview:api:building_function_workplace|BUILDING_FUNCTION_WORKPLACE]]
-  * [[preview:api:building_function_lord_manor|BUILDING_FUNCTION_LORD_MANOR]]+ 
  
 [[preview:assets:building_function| List of BUILDING_FUNCTION assets]] [[preview:assets:building_function| List of BUILDING_FUNCTION assets]]
Line 30: Line 34:
  
 ==== Name ==== ==== Name ====
-  * **Type**: ''string''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#string|string]]'' 
 +  * **Expected**: ''string value'' 
 + 
 +---- 
 + 
 +==== Description ==== 
 +//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#string|string]]'' 
 +  * **Expected**: ''string value''
  
 ---- ----
  
 ==== HasMaximumInstance ==== ==== HasMaximumInstance ====
-  * **Type**: ''boolean''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]'' 
 +  * **Expected**: ''boolean value''
   * **Default value**: ''false''   * **Default value**: ''false''
  
Line 41: Line 59:
  
 ==== MaximumInstanceAllowed ==== ==== MaximumInstanceAllowed ====
-  * **Type**: ''integer''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' 
 +  * **Expected**: ''integer value''
   * **Default value**: ''1''   * **Default value**: ''1''
  
Line 47: Line 68:
  
 ==== UpkeepPerCapacity ==== ==== UpkeepPerCapacity ====
-  * **Type**: ''list<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:api:resource_collection_value|RESOURCE_COLLECTION_VALUE]]'' 
 +  * **Can also be built from**: ''[[preview:data-types#list|list]]<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>'' 
 +  * **Expected**: ''RESOURCE_COLLECTION_VALUE value'' or ''list of RESOURCE_QUANTITY_PAIR values''
  
 ---- ----
  
 ==== UpkeepPerCapacityMultiplier ==== ==== UpkeepPerCapacityMultiplier ====
-  * **Type**: ''float''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#float|float]]'' 
 +  * **Expected**: ''float value''
   * **Default value**: ''1.0f''   * **Default value**: ''1.0f''
 +
 +----
 +
 +==== GameRuleModifierList ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:game_rule_modifier|GAME_RULE_MODIFIER]]>''
 +  * **Expected**: ''list of GAME_RULE_MODIFIER values''
 +
 +----
 +
 +==== IsDescriptionOverride ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''true''
 +
 +----
 +
 +==== ShowNameInTags ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''false''
 +
 +----
 +
 +==== IsDisplayable ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''true''
 +
 ===== Functions ===== ===== Functions =====
 +
 +----
 +
 +==== onBuildingFunctionKnown ====
 +
 +//[[:custom-classes#Extendable classes|Virtual function]]//
 +
 +''void **onBuildingFunctionKnown**(//level//)''
 +
 +^ Name ^ Type ^ Description ^
 +| //''level''// | ''[[preview:api:level|LEVEL]]'' |  |
  
 ---- ----
  
 ==== onBuildingFunctionAvailable ==== ==== onBuildingFunctionAvailable ====
 +
 +//[[:custom-classes#Extendable classes|Virtual function]]//
 +
 ''void **onBuildingFunctionAvailable**(//level//)'' ''void **onBuildingFunctionAvailable**(//level//)''
  
Line 67: Line 145:
  
 ==== activateBuilding ==== ==== activateBuilding ====
-''boolean **activateBuilding**(//object//)''+ 
 +//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]// 
 + 
 +''[[preview:data-types#boolean|boolean]] **activateBuilding**(//object//)'' 
 + 
 +Deprecated since version 1.9.7; Override onInit instead
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
 | //''object''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  | | //''object''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
 +
 +----
 +
 +==== onInit ====
 +
 +//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 +
 +''[[preview:data-types#boolean|boolean]] **onInit**(//object//)''
 +
 +^ Name ^ Type ^ Description ^
 +| //''object''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
 +
 +----
 +
 +==== onSetIsActive ====
 +
 +//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 +
 +''void **onSetIsActive**(//object//, //isActive//)''
 +
 +^ Name ^ Type ^ Description ^
 +| //''object''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
 +| //''isActive''// | ''[[preview:data-types#boolean|boolean]]'' |  |
  
 ---- ----
  
 ==== reloadBuildingFunction ==== ==== reloadBuildingFunction ====
 +
 +//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 +
 ''void **reloadBuildingFunction**(//object//)'' ''void **reloadBuildingFunction**(//object//)''
  
Line 83: Line 192:
  
 ==== removeBuildingFunction ==== ==== removeBuildingFunction ====
 +
 +//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 +
 ''void **removeBuildingFunction**(//object//)'' ''void **removeBuildingFunction**(//object//)''
  
 ^ Name ^ Type ^ Description ^ ^ Name ^ Type ^ Description ^
 | //''object''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  | | //''object''// | ''[[preview:api:game_object|GAME_OBJECT]]'' |  |
 +
  
preview/api/building_function.txt · Last modified: 2023/12/12 12:15 by 127.0.0.1
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki