====== COMP_WORKPLACE ======

**[[:custom-classes#Extendable classes|Extendable]]**\\
**Category**: Component

Parent class: [[preview:api:component | COMPONENT]]\\
Inherited by:
  * [[preview:api:comp_bailiff_office | COMP_BAILIFF_OFFICE]]
  * [[preview:api:comp_builder_workshop | COMP_BUILDER_WORKSHOP]]
  * [[preview:api:comp_encampment | COMP_ENCAMPMENT]]
  * [[preview:api:comp_farm | COMP_FARM]]
  * [[preview:api:comp_farm_livestock | COMP_FARM_LIVESTOCK]]
  * [[preview:api:comp_healing_house | COMP_HEALING_HOUSE]]
  * [[preview:api:comp_lodging | COMP_LODGING]]
  * [[preview:api:comp_workplace_forester | COMP_WORKPLACE_FORESTER]]
  * [[preview:api:comp_workplace_guard | COMP_WORKPLACE_GUARD]]
  * [[preview:api:comp_workplace_kitchen | COMP_WORKPLACE_KITCHEN]]
  * [[preview:api:comp_workplace_tax_office | COMP_WORKPLACE_TAX_OFFICE]]



===== Properties =====

----

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

  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:comp_villager | COMP_VILLAGER]]>''
  * **Expected**: ''list of pairs of asset ID and component data type''

----

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

  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:villager_value_pair | VILLAGER_VALUE_PAIR]]>''
  * **Expected**: ''list of VILLAGER_VALUE_PAIR values''

----

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

  * **Type**: ''[[preview:data-types#list|list]]<[[preview:api:resource_collection_value | RESOURCE_COLLECTION_VALUE]]>''
  * **Can also be built from**: ''[[preview:data-types#list|list]]<[[preview:data-types#list|list]]<[[preview:api:resource_quantity_pair | RESOURCE_QUANTITY_PAIR]]>>''
  * **Expected**: ''list of RESOURCE_COLLECTION_VALUE values'' or ''list of lists of RESOURCE_QUANTITY_PAIR values''

----

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

  * **Type**: ''[[preview:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

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

  * **Type**: ''[[preview:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.0f''

----

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

  * **Type**: ''[[preview:data-types#list|list]]<[[preview:data-types#float|float]]>''
  * **Expected**: ''list of float values''

===== Functions =====

----

==== update ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''void **update**()''


----

==== setWorkplaceData ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''void **setWorkplaceData**(//workplaceData//)''

^ Name ^ Type ^ Description ^
| //''workplaceData''// | ''[[preview:api:building_function_workplace | BUILDING_FUNCTION_WORKPLACE]]'' |  |

----

==== registerVillager ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''[[preview:data-types#boolean|boolean]] **registerVillager**(//villager//)''

^ Name ^ Type ^ Description ^
| //''villager''// | ''[[preview:api:comp_villager | COMP_VILLAGER]]'' |  |

----

==== unregisterVillager ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''[[preview:data-types#boolean|boolean]] **unregisterVillager**(//villager//)''

^ Name ^ Type ^ Description ^
| //''villager''// | ''[[preview:api:comp_villager | COMP_VILLAGER]]'' |  |

----

==== getGatherableTargetPosition ====

//[[:custom-classes#Extendable classes|Virtual function]]//

''void **getGatherableTargetPosition**(//villager//, //resource//, //outResourcePosition//, //outAroundResourcePosition//)''

^ Name ^ Type ^ Description ^
| //''villager''// | ''[[preview:api:comp_villager | COMP_VILLAGER]]'' |  |
| //''resource''// | ''[[preview:api:comp_resource_container | COMP_RESOURCE_CONTAINER]]'' |  |
| //''outResourcePosition''// | ''[[preview:api:behavior_tree_data_location | BEHAVIOR_TREE_DATA_LOCATION]]'' | //[[:annotations#out_argument|Out argument]]// |
| //''outAroundResourcePosition''// | ''[[preview:api:behavior_tree_data_location | BEHAVIOR_TREE_DATA_LOCATION]]'' | //[[:annotations#out_argument|Out argument]]// |

===== Events =====

----

==== ON_ASSIGNED_WORKER_CHANGED ====
''ON_ASSIGNED_WORKER_CHANGED([[preview:api:comp_villager | COMP_VILLAGER]] isAssigned, [[preview:data-types#boolean|boolean]] isAssigned)''

----

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

----

==== 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_RESOURCES_CONSUMED_FOR_PRODUCTION ====
''ON_RESOURCES_CONSUMED_FOR_PRODUCTION()''

----

==== ON_RESOURCE_DEPOT_LIST_UPDATE ====
''ON_RESOURCE_DEPOT_LIST_UPDATE()''

----

==== ON_HAS_WORKER_ASSIGNED_CHANGED ====
''ON_HAS_WORKER_ASSIGNED_CHANGED()''

----

==== ON_WORKER_CAPACITY_CHANGED ====
''ON_WORKER_CAPACITY_CHANGED([[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] previousWorkerCapacity, [[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]] currentWorkerCapacity)''

----

==== ON_ASSIGN_BUTTON_FOCUSED ====
''ON_ASSIGN_BUTTON_FOCUSED()''

----

==== ON_UNASSIGN_BUTTON_FOCUSED ====
''ON_UNASSIGN_BUTTON_FOCUSED()''

----

==== ON_RECIPE_CHANGED ====
''ON_RECIPE_CHANGED()''

----

==== ON_ABLE_TO_GENERATE_INPUT_RESOURCE_TRANSPORT ====
''ON_ABLE_TO_GENERATE_INPUT_RESOURCE_TRANSPORT()''

----

==== ON_UNABLE_TO_GENERATE_INPUT_RESOURCE_TRANSPORT ====
''ON_UNABLE_TO_GENERATE_INPUT_RESOURCE_TRANSPORT()''

----

==== ON_OUTPUT_FULL_FOR_PRODUCTION ====
''ON_OUTPUT_FULL_FOR_PRODUCTION()''