====== COMP_BUILDING ======

**Category**: Component

Parent class:  [[:api:comp_abstract_buildable|COMP_ABSTRACT_BUILDABLE]]\\

//[[:annotations#lazy-init|Lazy-init]]//

===== Properties =====

----

==== AssetBuilding ====
//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//

  * **Type**: ''[[:api:building|BUILDING]]''
  * **Expected**: ''asset ID''

----

==== AppliedMaterialSetIndex ====
//[[:annotations#serialized|Serialized]]//

  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''0''

===== Functions =====

----

==== getBuildingPartList ====

''[[:data-types#list|list]]<[[:api:comp_building_part|COMP_BUILDING_PART]]> **getBuildingPartList**()''


----

==== getSubBuildingList ====

''[[:data-types#list|list]]<[[:api:comp_building|COMP_BUILDING]]> **getSubBuildingList**()''


----

==== getEditMode ====

''[[:data-types#boolean|boolean]] **getEditMode**([//includeSubBuildings//])''

^ Name ^ Type ^ Description ^
| //''includeSubBuildings''// | ''[[:data-types#boolean|boolean]]'' |  |

===== Events =====

----

==== ON_PREVIEW_PART_ADDED ====
''ON_PREVIEW_PART_ADDED([[:api:comp_building_part|COMP_BUILDING_PART]])''

----

==== ON_PREVIEW_PART_MOVED ====
''ON_PREVIEW_PART_MOVED([[:api:comp_building_part|COMP_BUILDING_PART]])''

----

==== ON_PREVIEW_PART_PLACED ====
''ON_PREVIEW_PART_PLACED([[:api:comp_building_part|COMP_BUILDING_PART]], [[:data-types#boolean|boolean]])''

----

==== ON_EDIT_MODE_CHANGED ====
''ON_EDIT_MODE_CHANGED([[:data-types#boolean|boolean]])''

----

==== ON_BUILDING_PART_REMOVED ====
''ON_BUILDING_PART_REMOVED([[:api:comp_building_part|COMP_BUILDING_PART]] isRootPart, [[:data-types#boolean|boolean]] isRootPart)''

----

==== ON_SUB_BUILDING_ADDED ====
''ON_SUB_BUILDING_ADDED([[:api:comp_building|COMP_BUILDING]])''

----

==== ON_SUB_BUILDING_DESTROYED ====
''ON_SUB_BUILDING_DESTROYED([[:api:comp_building|COMP_BUILDING]])''

----

==== ON_SUB_BUILDING_COMPLETED ====
''ON_SUB_BUILDING_COMPLETED([[:api:comp_building|COMP_BUILDING]] isConstructionFinished, [[:data-types#boolean|boolean]] isConstructionFinished)''

----

==== ON_CONSTRUCTION_STARTED ====
''ON_CONSTRUCTION_STARTED([[:api:comp_building|COMP_BUILDING]])''

----

==== ON_UPGRADING ====
''ON_UPGRADING([[:api:comp_building|COMP_BUILDING]])''

----

==== ON_BUILDING_DESTROYED ====
''ON_BUILDING_DESTROYED([[:api:comp_building|COMP_BUILDING]])''

----

==== ON_BUILDING_COMPLETED ====
''ON_BUILDING_COMPLETED([[:api:comp_building|COMP_BUILDING]] isConstructionFinished, [[:data-types#boolean|boolean]] isConstructionFinished)''

----

==== ON_CUSTOM_NAME_CHANGED ====
''ON_CUSTOM_NAME_CHANGED([[:data-types#string|string]])''

----

==== ON_BUILDING_CHANGED ====
''ON_BUILDING_CHANGED()''

----

==== ON_BUILDING_FUNCTION_ASSIGNED ====
''ON_BUILDING_FUNCTION_ASSIGNED()''

----

==== ON_BUILDING_BATCH_CHANGE_FINISHED ====
''ON_BUILDING_BATCH_CHANGE_FINISHED()''

----

==== ON_BUILDING_BATCH_CHANGE_IN_FRAME ====
''ON_BUILDING_BATCH_CHANGE_IN_FRAME()''

----

==== ON_BUILDING_PART_BUILT ====
''ON_BUILDING_PART_BUILT([[:api:comp_building_part|COMP_BUILDING_PART]])''

----

==== ON_MATERIAL_SET_CHANGED ====
''ON_MATERIAL_SET_CHANGED()''

----

==== ON_CONSTRUCTION_CONDITION_TOGGLED ====
''ON_CONSTRUCTION_CONDITION_TOGGLED()''