preview:api:building

BUILDING

Deprecated names:

MONUMENT

Category: Asset

Parent class: ASSET

List of BUILDING assets

Properties

Name

Type: string
Expected: string value

Description

Type: string
Expected: string value

OrderId

Type: integer_and_unsigned_integer
Expected: integer value
Default value: 0

BuildingType

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

NavMeshLockCategory

Type: NAVMESH_LOCK_CATEGORY
Expected: enum value
Default value: NAVMESH_LOCK_CATEGORY.NONE

HasOwnNavMeshZoneId

Type: boolean
Expected: boolean value
Default value: true

IsForceMonument

Forces building to be considered as a monument. For example, this will allow the building to have decorations and masterpieces.

Type: boolean
Expected: boolean value
Default value: false

AssetCoreBuildingPart

Type: BUILDING_PART
Expected: asset ID

AssetMiniatureBuildingPart

Type: BUILDING_PART
Expected: asset ID
Default value: nil

SubAssetBuildingList

Type: list<BUILDING>
Expected: list of asset IDs

AssetBuildingPartList

Type: list<BUILDING_PART>
Expected: list of asset IDs

BuildingModel

Type: PREFAB
Expected: asset ID
Default value: nil

AssetBuildingFunction

Type: BUILDING_FUNCTION
Expected: asset ID
Default value: nil

DesirabilityLayer

Type: DESIRABILITY
Expected: asset ID
Default value: nil

ConstructionCompletedOverrideAudioKey

Type: string
Expected: string value

IsManuallyUnlocked

Type: boolean
Expected: boolean value
Default value: false

IsDestructible

Type: boolean
Expected: boolean value
Default value: true

IsPartsDestructible

Type: boolean
Expected: boolean value
Default value: true

IsEditable

Type: boolean
Expected: boolean value
Default value: false

IsHidden

Type: boolean
Expected: boolean value
Default value: false

IsClearTrees

Type: boolean
Expected: boolean value
Default value: false

IsUnique

Type: boolean
Expected: boolean value
Default value: false

IsAttachable

Type: boolean
Expected: boolean value
Default value: true

MaterialSetList

Not used for sub-buildings. Sub-buildings will use material set from parent building.

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

RequiredPartList

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

AssetBuildingConditionConfigList

Type: list<BUILDING_GAME_CONDITION_CONFIG>
Expected: list of asset IDs

preview/api/building.txt · Last modified: 2023/12/12 12:15 by 127.0.0.1