Foundation - Modding Documentation

User Tools

Site Tools

Trace:
preview:api:building_function_workplace

Differences

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

Link to this comparison view

Next revision		Previous revision
preview:api:building_function_workplace [2020/07/07 15:04] – external edit 127.0.0.1preview:api:building_function_workplace [2023/12/12 12:15] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== BUILDING_FUNCTION_WORKPLACE ====== ====== BUILDING_FUNCTION_WORKPLACE ======
  
 +**[[:custom-classes#Extendable classes|Extendable]]**\\
 **Category**: Asset **Category**: Asset
  
Line 6: Line 7:
 Inherited by: Inherited by:
   * [[preview:api:building_function_bailiff_office|BUILDING_FUNCTION_BAILIFF_OFFICE]]   * [[preview:api:building_function_bailiff_office|BUILDING_FUNCTION_BAILIFF_OFFICE]]
 +  * [[preview:api:building_function_builder_workshop|BUILDING_FUNCTION_BUILDER_WORKSHOP]]
   * [[preview:api:building_function_church|BUILDING_FUNCTION_CHURCH]]   * [[preview:api:building_function_church|BUILDING_FUNCTION_CHURCH]]
-  * [[preview:api:building_function_market|BUILDING_FUNCTION_MARKET]]+  * [[preview:api:building_function_crafting_workshop|BUILDING_FUNCTION_CRAFTING_WORKSHOP]] 
 +  * [[preview:api:building_function_farm|BUILDING_FUNCTION_FARM]] 
 +  * [[preview:api:building_function_fishing|BUILDING_FUNCTION_FISHING]]
   * [[preview:api:building_function_forester|BUILDING_FUNCTION_FORESTER]]   * [[preview:api:building_function_forester|BUILDING_FUNCTION_FORESTER]]
-  * [[preview:api:building_function_warehouse|BUILDING_FUNCTION_WAREHOUSE]]+  * [[preview:api:building_function_kitchen|BUILDING_FUNCTION_KITCHEN]]
   * [[preview:api:building_function_livestock_farm|BUILDING_FUNCTION_LIVESTOCK_FARM]]   * [[preview:api:building_function_livestock_farm|BUILDING_FUNCTION_LIVESTOCK_FARM]]
-  * [[preview:api:building_function_tax_office|BUILDING_FUNCTION_TAX_OFFICE]]+  * [[preview:api:building_function_market|BUILDING_FUNCTION_MARKET]]
   * [[preview:api:building_function_quarry|BUILDING_FUNCTION_QUARRY]]   * [[preview:api:building_function_quarry|BUILDING_FUNCTION_QUARRY]]
-  * [[preview:api:building_function_farm|BUILDING_FUNCTION_FARM]] +  * [[preview:api:building_function_tax_office|BUILDING_FUNCTION_TAX_OFFICE]]
-  * [[preview:api:building_function_crafting_workshop|BUILDING_FUNCTION_CRAFTING_WORKSHOP]] +
-  * [[preview:api:building_function_kitchen|BUILDING_FUNCTION_KITCHEN]] +
-  * [[preview:api:building_function_treasury|BUILDING_FUNCTION_TREASURY]] +
-  * [[preview:api:building_function_fishing|BUILDING_FUNCTION_FISHING]]+
   * [[preview:api:building_function_training_ground|BUILDING_FUNCTION_TRAINING_GROUND]]   * [[preview:api:building_function_training_ground|BUILDING_FUNCTION_TRAINING_GROUND]]
 +  * [[preview:api:building_function_treasury|BUILDING_FUNCTION_TREASURY]]
 +  * [[preview:api:building_function_warehouse|BUILDING_FUNCTION_WAREHOUSE]]
 +
 +
  
 [[preview:assets:building_function#building_function_workplace| List of BUILDING_FUNCTION_WORKPLACE assets]] [[preview:assets:building_function#building_function_workplace| List of BUILDING_FUNCTION_WORKPLACE assets]]
Line 27: Line 31:
  
 ==== WorkerCapacity ==== ==== WorkerCapacity ====
-  * **Type**: ''integer''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]'' 
 +  * **Expected**: ''integer value''
   * **Default value**: ''1''   * **Default value**: ''1''
  
Line 33: Line 40:
  
 ==== IsInfiniteCapacity ==== ==== IsInfiniteCapacity ====
-  * **Type**: ''boolean''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]'' 
 +  * **Expected**: ''boolean value''
   * **Default value**: ''false''   * **Default value**: ''false''
 +
 +----
 +
 +==== WorkerRatioFromCapacity ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +Will override worker capacity if the value is over 0.
 +  * **Type**: ''[[preview:data-types#float|float]]''
 +  * **Expected**: ''float value''
 +  * **Default value**: ''0.0f''
  
 ---- ----
  
 ==== UpkeepPerWorker ==== ==== UpkeepPerWorker ====
-  * **Type**: ''list<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:api:resource_collection_value|RESOURCE_COLLECTION_VALUE]]'' 
 +  * **Can also be built from**: ''[[preview:data-types#list|list]]<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>'' 
 +  * **Expected**: ''RESOURCE_COLLECTION_VALUE value'' or ''list of RESOURCE_QUANTITY_PAIR values''
  
 ---- ----
  
 ==== RelatedJob ==== ==== RelatedJob ====
 +//[[:annotations#serialized|Serialized]]//
 +
   * **Type**: ''[[preview:api:association_job_behavior|ASSOCIATION_JOB_BEHAVIOR]]''   * **Type**: ''[[preview:api:association_job_behavior|ASSOCIATION_JOB_BEHAVIOR]]''
 +  * **Expected**: ''ASSOCIATION_JOB_BEHAVIOR value''
  
 ---- ----
  
 ==== IsPrivate ==== ==== IsPrivate ====
-  * **Type**: ''boolean''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]'' 
 +  * **Expected**: ''boolean value''
   * **Default value**: ''false''   * **Default value**: ''false''
 +
 +----
 +
 +==== CanAssignWorkerAutomatically ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +If false, monument like the Monastery, can't automatically assign worker to this workplace
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''true''
  
 ---- ----
  
 ==== HasResourceDepot ==== ==== HasResourceDepot ====
-  * **Type**: ''boolean''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]'' 
 +  * **Expected**: ''boolean value''
   * **Default value**: ''true''   * **Default value**: ''true''
 +
 +----
 +
 +==== IsPausable ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''true''
 +
 +----
 +
 +==== RandomWorkstationReservation ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''false''
 +
 +----
 +
 +==== ShowProgressBar ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#boolean|boolean]]''
 +  * **Expected**: ''boolean value''
 +  * **Default value**: ''true''
 +
 +----
 +
 +==== ProductionCycleDurationInSec ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#float|float]]''
 +  * **Expected**: ''float value''
 +  * **Default value**: ''20.0f''
 +
 +----
 +
 +==== WorkCycleNeededToProduceOnce ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
 +  * **Expected**: ''integer value''
 +  * **Default value**: ''1''
  
 ---- ----
  
 ==== InputInventoryCapacity ==== ==== InputInventoryCapacity ====
-  * **Type**: ''list<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:api:resource_collection_value|RESOURCE_COLLECTION_VALUE]]'' 
 +  * **Can also be built from**: ''[[preview:data-types#list|list]]<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>'' 
 +  * **Expected**: ''RESOURCE_COLLECTION_VALUE value'' or ''list of RESOURCE_QUANTITY_PAIR values''
  
 ---- ----
  
 ==== ResourceListNeeded ==== ==== ResourceListNeeded ====
-  * **Type**: ''list<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:api:resource_collection_value|RESOURCE_COLLECTION_VALUE]]'' 
 +  * **Can also be built from**: ''[[preview:data-types#list|list]]<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>'' 
 +  * **Expected**: ''RESOURCE_COLLECTION_VALUE value'' or ''list of RESOURCE_QUANTITY_PAIR values''
  
 ---- ----
  
 ==== ResourceProduced ==== ==== ResourceProduced ====
-  * **Type**: ''list<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>''+//[[:annotations#serialized|Serialized]]// 
 + 
 +  * **Type**: ''[[preview:api:resource_collection_value|RESOURCE_COLLECTION_VALUE]]'' 
 +  * **Can also be built from**: ''[[preview:data-types#list|list]]<[[preview:api:resource_quantity_pair|RESOURCE_QUANTITY_PAIR]]>'' 
 +  * **Expected**: ''RESOURCE_COLLECTION_VALUE value'' or ''list of RESOURCE_QUANTITY_PAIR values''
  
 ---- ----
  
 ==== DesirabilityLayer ==== ==== DesirabilityLayer ====
 +//[[:annotations#serialized|Serialized]]//
 +
   * **Type**: ''[[preview:api:desirability|DESIRABILITY]]''   * **Type**: ''[[preview:api:desirability|DESIRABILITY]]''
-  * **Expected**: ''Asset ID''+  * **Expected**: ''asset ID''
   * **Default value**: ''nil''   * **Default value**: ''nil''
 +
 +----
 +
 +==== AssetNoZoneNotification ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:api:notification|NOTIFICATION]]''
 +  * **Expected**: ''asset ID''
 +  * **Default value**: ''nil''
 +
 +----
 +
 +==== AssetNoResourceInZoneNotification ====
 +//[[:annotations#serialized|Serialized]]//
 +
 +  * **Type**: ''[[preview:api:notification|NOTIFICATION]]''
 +  * **Expected**: ''asset ID''
 +  * **Default value**: ''nil''
 +
  
preview/api/building_function_workplace.1594148650.txt.gz · Last modified: 2020/07/07 15:04 by 127.0.0.1
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki