preview:api:zone

Table of Contents

ZONE
- Properties

ZONE

Category: Asset

Parent class: ASSET

List of ZONE assets

Properties

Name

Type: string
Expected: string value

ZoningCategory

Type: ZONING_CATEGORY
Expected: enum value
Default value: ZONING_CATEGORY.DEFAULT

Color

Type: color
Expected: color value
Default value: COL_WHITE

Icon

Type: ATLAS_CELL
Expected: asset ID

HoverIcon

Type: ATLAS_CELL
Expected: asset ID

SelectionIcon

Type: ATLAS_CELL
Expected: asset ID

ForbiddenZone

Type: boolean
Expected: boolean value
Default value: false

DesirabilityLayerToShow

Type: DESIRABILITY
Expected: asset ID
Default value: nil

Description

Type: string
Expected: string value

IsLockedByDefault

Type: boolean
Expected: boolean value
Default value: true

IsGlobalZone

Type: boolean
Expected: boolean value
Default value: true

IsDiscardingUnplayableTerritory

Type: boolean
Expected: boolean value
Default value: true

DrawZoneTileCount

Type: vec2i
Expected: vec2i value
Default value: { 8, 8 }

DrawZoneTileSize

Type: float
Expected: float value
Default value: 128.0f

IsShowPaintedZone

Type: boolean
Expected: boolean value
Default value: true

preview/api/zone.txt · Last modified: 2025/09/24 14:16 by 127.0.0.1