====== BUILDING_FUNCTION_RESOURCE_DEPOT ======

**Category**: Asset

Parent class: [[:api:building_function | BUILDING_FUNCTION]]\\



[[:assets:building_function#building_function_resource_depot| List of BUILDING_FUNCTION_RESOURCE_DEPOT assets]]

===== Properties =====

----

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

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

----

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

Used to add parameter to description in the order of the list.
  * **Type**: ''[[:data-types#list|list]]<[[:api:resource_depot_description_parameters | RESOURCE_DEPOT_DESCRIPTION_PARAMETERS]]>''
  * **Expected**: ''list of enum values''

----

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

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

----

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

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

----

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

If m_canBeUsedForInputInventory is true, it will be overridden with infinite input
  * **Type**: ''[[:data-types#integer_and_unsigned_integer|integer_and_unsigned_integer]]''
  * **Expected**: ''integer value''
  * **Default value**: ''0''

----

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

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

----

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

If enabled, the depot can be targeted for general resource needs filling
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''true''

----

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

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

----

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

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

----

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

If enabled, the resource quantity pair entry in the input collection will be removed when quantity drops to 0
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

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

If enabled, the resource quantity pair entry in the output collection will be removed when quantity drops to 0
  * **Type**: ''[[:data-types#boolean|boolean]]''
  * **Expected**: ''boolean value''
  * **Default value**: ''false''

----

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

Duration of villager's stay when consuming from this resource depot.
  * **Type**: ''[[:data-types#float|float]]''
  * **Expected**: ''float value''
  * **Default value**: ''1.0f''

----

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

  * **Type**: ''[[:api:resource_stockpile_settings | RESOURCE_STOCKPILE_SETTINGS]]''
  * **Expected**: ''asset ID''
  * **Default value**: ''nil''