====== BUILDING_FUNCTION_WORKPLACE ======

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

Parent class: [[:api:building_function | BUILDING_FUNCTION]]\\
Inherited by:
  * [[:api:building_function_bailiff_office | BUILDING_FUNCTION_BAILIFF_OFFICE]]
  * [[:api:building_function_builder_workshop | BUILDING_FUNCTION_BUILDER_WORKSHOP]]
  * [[:api:building_function_church | BUILDING_FUNCTION_CHURCH]]
  * [[:api:building_function_crafting_workshop | BUILDING_FUNCTION_CRAFTING_WORKSHOP]]
  * [[:api:building_function_encampment | BUILDING_FUNCTION_ENCAMPMENT]]
  * [[:api:building_function_farm | BUILDING_FUNCTION_FARM]]
  * [[:api:building_function_fishing | BUILDING_FUNCTION_FISHING]]
  * [[:api:building_function_forester | BUILDING_FUNCTION_FORESTER]]
  * [[:api:building_function_healing_house | BUILDING_FUNCTION_HEALING_HOUSE]]
  * [[:api:building_function_kitchen | BUILDING_FUNCTION_KITCHEN]]
  * [[:api:building_function_livestock_farm | BUILDING_FUNCTION_LIVESTOCK_FARM]]
  * [[:api:building_function_lodging | BUILDING_FUNCTION_LODGING]]
  * [[:api:building_function_market | BUILDING_FUNCTION_MARKET]]
  * [[:api:building_function_quarry | BUILDING_FUNCTION_QUARRY]]
  * [[:api:building_function_tax_office | BUILDING_FUNCTION_TAX_OFFICE]]
  * [[:api:building_function_treasury | BUILDING_FUNCTION_TREASURY]]
  * [[:api:building_function_warehouse | BUILDING_FUNCTION_WAREHOUSE]]
  * [[:dlc:agriculture|{{assets:dlc:agriculture.png?16x16|DLC agriculture}}]][[:api:building_function_workplace_common_croft | BUILDING_FUNCTION_WORKPLACE_COMMON_CROFT]]
  * [[:api:building_function_workplace_guard | BUILDING_FUNCTION_WORKPLACE_GUARD]]



[[:assets:building_function#building_function_workplace| List of BUILDING_FUNCTION_WORKPLACE assets]]

===== Properties =====

----

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

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

----

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

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

----

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

Will override worker capacity if the value is over 0.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.0f''

----

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

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

----

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

Will override output capacity if the value is over 0.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''0.0f''

----

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

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

----

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

  * **Type**: ''[[:api:association_job_behavior | ASSOCIATION_JOB_BEHAVIOR]]''
  * **Expected**: ''ASSOCIATION_JOB_BEHAVIOR value''

----

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

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

----

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

If false, monument like the Monastery, can't automatically assign worker to this workplace
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''true''

----

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

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

----

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

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

----

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

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

----

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

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

----

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

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

----

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

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

----

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

  * **Type**: ''[[:data-types#list|list]]<[[:api:workplace_recipe | WORKPLACE_RECIPE]]>''
  * **Expected**: ''list of asset IDs''

----

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

This will be multiplied by the needed resources quantities to determine input inventory's capacity. \\ For gathering workplaces, should set at 0, since they have no input inventory.
  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''10''

----

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

  * **Type**: ''[[:api:desirability | DESIRABILITY]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

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

  * **Type**: ''[[:api:notification | NOTIFICATION]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

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

  * **Type**: ''[[:api:notification | NOTIFICATION]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''

----

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

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

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

  * **Type**: ''[[:data-types#string|string]]''
  * **Expected**: ''string value''

----

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

Display input resources in description if workplace has input resources.
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''true''

----

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

If set, will replace the default working activity message used in the behavior
  * **Type**: ''[[:api:work_agent_activity_message | WORK_AGENT_ACTIVITY_MESSAGE]]''
  * **Expected**: ''WORK_AGENT_ACTIVITY_MESSAGE value''
  * **Default value**: ''nil''

----

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

Deprecated since version 1.12; use WORKPLACE_RECIPE instead

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

----

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

Deprecated since version 1.12; use WORKPLACE_RECIPE instead

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