GameboardPlacementOccupancyInspection
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:223
Detailed result from an occupancy inspection.
Properties
Section titled “Properties”blockers
Section titled “blockers”blockers: readonly
PlacementOccupancySnapshot[]
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:237
Blocking occupancy records found in the footprint.
blocksMovement
Section titled “blocksMovement”blocksMovement:
boolean
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:233
Whether the proposed placement blocks movement.
canOccupy
Section titled “canOccupy”canOccupy:
boolean
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:239
Whether the placement can occupy the inspected footprint.
coordinates
Section titled “coordinates”coordinates:
HexCoordinates
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:227
Axial coordinates for the origin tile.
footprintTileKeys
Section titled “footprintTileKeys”footprintTileKeys: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:229
Tile keys in the proposed placement footprint.
missingTileKeys
Section titled “missingTileKeys”missingTileKeys: readonly
string[]
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:231
Footprint tile keys not present in the world.
occupancyGroup
Section titled “occupancyGroup”occupancyGroup:
string
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:235
Occupancy group assigned to the proposed placement.
reason?
Section titled “reason?”
optionalreason?:string
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:241
Machine-readable reason when canOccupy is false.
tileKey
Section titled “tileKey”tileKey:
string
Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:225
Origin tile key that was inspected.