Differences

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

--- api:component [2021/07/30 11:28] – [finalize] polymorphgames
+++ api:component [2024/02/06 13:53] (current) – external edit 127.0.0.1
@@ Line 5: / Line 5: @@
 Inherited by:
-  * [[api:comp_building_part|COMP_BUILDING_PART]]
+  * [[:api:comp_abstract_buildable|COMP_ABSTRACT_BUILDABLE]]
-  * [[api:comp_rigid_body|COMP_RIGID_BODY]]
+  * [[:api:comp_agent|COMP_AGENT]]
-  * [[api:comp_dirt_rectangle|COMP_DIRT_RECTANGLE]]
+  * [[:api:comp_agent_need_processor|COMP_AGENT_NEED_PROCESSOR]]
-  * [[api:comp_plantable|COMP_PLANTABLE]]
+  * [[:api:comp_building_attach_node|COMP_BUILDING_ATTACH_NODE]]
-  * [[api:comp_crop_field_element|COMP_CROP_FIELD_ELEMENT]]
+  * [[:api:comp_building_manager|COMP_BUILDING_MANAGER]]
-  * [[api:comp_particle_emitter_toggle|COMP_PARTICLE_EMITTER_TOGGLE]]
+  * [[:api:comp_building_zone|COMP_BUILDING_ZONE]]
-  * [[api:comp_main_game_loop|COMP_MAIN_GAME_LOOP]]
+  * [[:api:comp_crop_field_element|COMP_CROP_FIELD_ELEMENT]]
-  * [[api:comp_particle_emitter|COMP_PARTICLE_EMITTER]]
+  * [[:api:comp_dirt_circle|COMP_DIRT_CIRCLE]]
-  * [[api:comp_building_attach_node|COMP_BUILDING_ATTACH_NODE]]
+  * [[:api:comp_dirt_rectangle|COMP_DIRT_RECTANGLE]]
-  * [[api:comp_grounded|COMP_GROUNDED]]
+  * [[:api:comp_grounded|COMP_GROUNDED]]
-  * [[api:comp_agent|COMP_AGENT]]
+  * [[:api:comp_guest|COMP_GUEST]]
-  * [[api:comp_villager|COMP_VILLAGER]]
+  * [[:api:comp_immigration_manager|COMP_IMMIGRATION_MANAGER]]
-  * [[api:comp_resource_container|COMP_RESOURCE_CONTAINER]]
+  * [[:api:comp_interactive_location|COMP_INTERACTIVE_LOCATION]]
-  * [[api:comp_workplace|COMP_WORKPLACE]]
+  * [[:api:comp_inventory|COMP_INVENTORY]]
-  * [[api:comp_building|COMP_BUILDING]]
+  * [[:api:comp_livestock|COMP_LIVESTOCK]]
-  * [[api:comp_building_manager|COMP_BUILDING_MANAGER]]
+  * [[:api:comp_lodging|COMP_LODGING]]
-  * [[api:comp_building_zone|COMP_BUILDING_ZONE]]
+  * [[:api:comp_main_game_loop|COMP_MAIN_GAME_LOOP]]
-  * [[api:comp_quotable|COMP_QUOTABLE]]
+  * [[:api:comp_mandate_manager|COMP_MANDATE_MANAGER]]
-  * [[api:comp_dirt_circle|COMP_DIRT_CIRCLE]]
+  * [[:api:comp_mandate_office|COMP_MANDATE_OFFICE]]
-  * [[api:comp_resource_generator|COMP_RESOURCE_GENERATOR]]
+  * [[:api:comp_particle_emitter|COMP_PARTICLE_EMITTER]]
-  * [[api:comp_tree|COMP_TREE]]
+  * [[:api:comp_particle_emitter_toggle|COMP_PARTICLE_EMITTER_TOGGLE]]
+  * [[:api:comp_plantable|COMP_PLANTABLE]]
+  * [[:api:comp_quotable|COMP_QUOTABLE]]
+  * [[:api:comp_resource_container|COMP_RESOURCE_CONTAINER]]
+  * [[:api:comp_resource_depot|COMP_RESOURCE_DEPOT]]
+  * [[:api:comp_resource_generator|COMP_RESOURCE_GENERATOR]]
+  * [[:api:comp_resource_stockpile|COMP_RESOURCE_STOCKPILE]]
+  * [[:api:comp_rigid_body|COMP_RIGID_BODY]]
+  * [[:api:comp_soldier|COMP_SOLDIER]]
+  * [[:api:comp_trader|COMP_TRADER]]
+  * [[:api:comp_tree|COMP_TREE]]
+  * [[:api:comp_vehicle|COMP_VEHICLE]]
+  * [[:api:comp_victory_condition_manager|COMP_VICTORY_CONDITION_MANAGER]]
+  * [[:api:comp_villager|COMP_VILLAGER]]
+  * [[:api:comp_villager_manager|COMP_VILLAGER_MANAGER]]
+  * [[:api:comp_warehouse_setuper|COMP_WAREHOUSE_SETUPER]]
+  * [[:api:comp_workplace|COMP_WORKPLACE]]
+  * [[:api:visitor|VISITOR]]
+===== Properties =====
+----
+==== Enabled ====
+//[[:annotations#runtime_only|Runtime only]]//
+  * **Type**: ''[[:data-types#boolean|boolean]]''
+  * **Expected**: ''boolean value''
 ===== Functions =====
@@ Line 33: / Line 62: @@
 ==== getOwner ====
-''[[api:game_object|GAME_OBJECT]] **getOwner**()''
+''[[:api:game_object|GAME_OBJECT]] **getOwner**()''
@@ Line 40: / Line 69: @@
 ==== getLevel ====
-''[[api:level|LEVEL]] **getLevel**()''
+''[[:api:level|LEVEL]] **getLevel**()''
@@ Line 47: / Line 76: @@
 ==== isPreInitialized ====
-''boolean **isPreInitialized**()''
+''[[:data-types#boolean|boolean]] **isPreInitialized**()''
@@ Line 54: / Line 83: @@
 ==== isInitialized ====
-''boolean **isInitialized**()''
+''[[:data-types#boolean|boolean]] **isInitialized**()''
@@ Line 61: / Line 90: @@
 ==== isEnabled ====
-''boolean **isEnabled**()''
+''[[:data-types#boolean|boolean]] **isEnabled**()''
+Deprecated since version 1.8.1; use Enabled property instead
@@ Line 68: / Line 99: @@
 ==== hasEnabledFlag ====
-''boolean **hasEnabledFlag**()''
+''[[:data-types#boolean|boolean]] **hasEnabledFlag**()''
@@ Line 75: / Line 106: @@
 ==== init ====
-**[[:custom-classes#Extendable classes|Virtual function]]**
+//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 ''void **init**()''
@@ Line 84: / Line 115: @@
 ==== onFinalize ====
-**[[:custom-classes#Extendable classes|Virtual function]]**
+//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 ''void **onFinalize**(//isClearingLevel//)''
 ^ Name ^ Type ^ Description ^
-| //''isClearingLevel''// | ''boolean'' |  |
+| //''isClearingLevel''// | ''[[:data-types#boolean|boolean]]'' |  |
 ----
-==== destroy ====
+==== onDestroy ====
-**[[:custom-classes#Extendable classes|Virtual function]]**
+//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
-''void **destroy**(//isClearingLevel//)''
+''void **onDestroy**(//isClearingLevel//)''
 ^ Name ^ Type ^ Description ^
-| //''isClearingLevel''// | ''boolean'' |  |
+| //''isClearingLevel''// | ''[[:data-types#boolean|boolean]]'' |  |
 ----
@@ Line 106: / Line 137: @@
 ==== onEnabled ====
-**[[:custom-classes#Extendable classes|Virtual function]]**
+//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 ''void **onEnabled**()''
@@ Line 115: / Line 146: @@
 ==== onDisabled ====
-**[[:custom-classes#Extendable classes|Virtual function]]**
+//[[:custom-classes#Extendable classes|Virtual function]], [[:custom-classes#Protected|Protected function]]//
 ''void **onDisabled**()''
+----
+==== getComponentType ====
+''[[:data-types#component_type|component_type]] **getComponentType**()''