api:building_part

BUILDING_PART

Category: Asset

Parent class: ASSET

List of BUILDING_PART assets

Properties

Name

Type: string
Expected: string value

Description

Type: string
Expected: string value

Category

Type: BUILDING_PART_TYPE
Expected: enum value
Default value: BUILDING_PART_TYPE.OTHER

IsMonumentCore

Type: boolean
Expected: boolean value
Default value: false

IsMoveBuildingInsteadOfPart

Type: boolean
Expected: boolean value
Default value: false

IsDestructible

Type: boolean
Expected: boolean value
Default value: true

IsVisibleWhenBuilt

Type: boolean
Expected: boolean value
Default value: true

IsMovableWhenBuilt

Type: boolean
Expected: boolean value
Default value: false

IsShowInUi

Type: boolean
Expected: boolean value
Default value: true

IsOnlyAttached

Type: boolean
Expected: boolean value
Default value: false

IsRestrictedToBuilding

Type: boolean
Expected: boolean value
Default value: false

HasMaximumInstancePerBuilding

Type: boolean
Expected: boolean value
Default value: false

MaximumInstancePerBuilding

Type: integer
Expected: integer value
Default value: 0

ConstructorData

Type: BUILDING_CONSTRUCTOR
Expected: BUILDING_CONSTRUCTOR value

AssetBuildingFunction

Type: BUILDING_FUNCTION
Expected: asset ID
Default value: nil

BuildingZone

Type: BUILDING_ZONE
Expected: BUILDING_ZONE value

ConstructionVisual

Type: PREFAB
Expected: asset ID
Default value: nil

ConstructionStepMode

Type: CONSTRUCTION_STEP_MODE
Expected: enum value
Default value: CONSTRUCTION_STEP_MODE.ADDITIVE

EstateSplendor

Type: list<ESTATE_QUANTITY_PAIR>
Expected: list of ESTATE_QUANTITY_PAIR values

Cost

Type: BUILDING_PART_COST
Expected: BUILDING_PART_COST value

CraftedResourceNeeded

Type: RESOURCE
Expected: asset ID
Default value: nil

Capacity

Type: integer
Expected: integer value
Default value: 0

BeautificationValue

Type: integer
Expected: integer value
Default value: 0

BeautificationCategory

Type: BEAUTIFICATION_CATEGORY
Expected: enum value
Default value: BEAUTIFICATION_CATEGORY.GENERAL

UndesirabilityValue

Type: integer
Expected: integer value
Default value: 0

DesirabilityModifiers

Type: list<DESIRABILITY_MODIFIER_ITEM>
Expected: list of DESIRABILITY_MODIFIER_ITEM values

api/building_part.txt · Last modified: 2023/10/02 13:54 (external edit)