Differences

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

--- preview:api:comp_workplace [2020/07/07 17:52] – maxime
+++ preview:api:comp_workplace [2023/12/12 12:15] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== COMP_WORKPLACE ======
+**[[:custom-classes#Extendable classes|Extendable]]**\\
 **Category**: Component
-**Extendable**
 Parent class:  [[preview:api:component|COMPONENT]]\\
 Inherited by:
-  * [[preview:api:comp_farm_livestock|COMP_FARM_LIVESTOCK]]
+  * [[preview:api:comp_bailiff_office|COMP_BAILIFF_OFFICE]]
+  * [[preview:api:comp_builder_workshop|COMP_BUILDER_WORKSHOP]]
   * [[preview:api:comp_farm|COMP_FARM]]
+  * [[preview:api:comp_farm_livestock|COMP_FARM_LIVESTOCK]]
+  * [[preview:api:comp_workplace_forester|COMP_WORKPLACE_FORESTER]]
+  * [[preview:api:comp_workplace_kitchen|COMP_WORKPLACE_KITCHEN]]
+  * [[preview:api:comp_workplace_tax_office|COMP_WORKPLACE_TAX_OFFICE]]
 ===== Properties =====
@@ Line 15: / Line 21: @@
 ==== AssignedWorkerList ====
-  * **Type**: ''list<[[preview:api:comp_villager|COMP_VILLAGER]]>''
+//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//
-  * **Expected**: ''List of Pair of asset ID and component data type''
+  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:comp_villager|COMP_VILLAGER]]>''
+  * **Expected**: ''list of pairs of asset ID and component data type''
 ----
-==== PendingProductionCount ====
+==== ActiveVillagerProductionProgressList ====
-  * **Type**: ''integer''
+//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//
-  * **Default value**: ''0''
+  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:villager_value_pair|VILLAGER_VALUE_PAIR]]>''
+  * **Expected**: ''list of VILLAGER_VALUE_PAIR values''
 ----
 ==== IsPaused ====
-  * **Type**: ''boolean''
+//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//
+  * **Type**: ''[[preview:data-types#boolean|boolean]]''
+  * **Expected**: ''boolean value''
   * **Default value**: ''false''
 ----
-==== CurrentProductionAmountList ====
+==== CurrentProductionCycleCount ====
-  * **Type**: ''list<float>''
+//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//
-===== Functions =====
+  * **Type**: ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
+  * **Expected**: ''integer value''
+  * **Default value**: ''0''
 ----
-==== init ====
+==== CurrentProductionAmountList ====
-''void **init**()''
+//[[:annotations#serialized|Serialized]], [[:annotations#savegame|Savegame]]//
+  * **Type**: ''[[preview:data-types#list|list]]<[[preview:data-types#float|float]]>''
+  * **Expected**: ''list of float values''
+===== Functions =====
 ----
 ==== update ====
-''void **update**()''
+//[[:custom-classes#Extendable classes|Virtual function]]//
-----
+''void **update**()''
-==== finalize ====
-''void **finalize**(//isClearingLevel//)''
-^ Name ^ Type ^ Description ^
-| //''isClearingLevel''// | ''boolean'' |  |
 ----
 ==== setWorkplaceData ====
+//[[:custom-classes#Extendable classes|Virtual function]]//
 ''void **setWorkplaceData**(//workplaceData//)''
@@ Line 67: / Line 85: @@
 ==== registerVillager ====
-''boolean **registerVillager**(//villager//)''
+//[[:custom-classes#Extendable classes|Virtual function]]//
+''[[preview:data-types#boolean|boolean]] **registerVillager**(//villager//)''
 ^ Name ^ Type ^ Description ^
@@ Line 75: / Line 96: @@
 ==== unregisterVillager ====
-''boolean **unregisterVillager**(//villager//)''
+//[[:custom-classes#Extendable classes|Virtual function]]//
+''[[preview:data-types#boolean|boolean]] **unregisterVillager**(//villager//)''
 ^ Name ^ Type ^ Description ^
@@ Line 83: / Line 107: @@
 ==== getGatherableTargetPosition ====
+//[[:custom-classes#Extendable classes|Virtual function]]//
 ''void **getGatherableTargetPosition**(//villager//, //resource//, //resourcePosition//, //aroundResourcePosition//)''
@@ Line 90: / Line 117: @@
 | //''resourcePosition''// | ''[[preview:api:behavior_tree_data_location|BEHAVIOR_TREE_DATA_LOCATION]]'' |  |
 | //''aroundResourcePosition''// | ''[[preview:api:behavior_tree_data_location|BEHAVIOR_TREE_DATA_LOCATION]]'' |  |
 ===== Events =====
@@ Line 100: / Line 128: @@
 ==== ON_WORKPLACE_PAUSED ====
-''ON_WORKPLACE_PAUSED(boolean)''
+''ON_WORKPLACE_PAUSED([[preview:data-types#boolean|boolean]])''
 ----
 ==== ON_WORKPLACE_PRODUCED ====
-''ON_WORKPLACE_PRODUCED()''
+''ON_WORKPLACE_PRODUCED([[preview:api:resource_collection_value|RESOURCE_COLLECTION_VALUE]])''
+----
+==== ON_WORKPLACE_STATUS_UPDATE ====
+''ON_WORKPLACE_STATUS_UPDATE()''
+----
+==== ON_WORKPLACE_DATA_SET ====
+''ON_WORKPLACE_DATA_SET([[preview:api:building_function|BUILDING_FUNCTION]])''
+----
+==== ON_WORKPLACE_PRODUCTION_UPDATE ====
+''ON_WORKPLACE_PRODUCTION_UPDATE()''
+----
+==== ON_RESOURCE_DEPOT_LIST_UPDATE ====
+''ON_RESOURCE_DEPOT_LIST_UPDATE()''