GameboardPlacementOccupancyInspection
Defined in: src/koota/koota.ts:224
Detailed result from an occupancy inspection.
Properties
Section titled “Properties”blockers
Section titled “blockers”blockers: readonly
PlacementOccupancySnapshot[]
Defined in: src/koota/koota.ts:238
Blocking occupancy records found in the footprint.
blocksMovement
Section titled “blocksMovement”blocksMovement:
boolean
Defined in: src/koota/koota.ts:234
Whether the proposed placement blocks movement.
canOccupy
Section titled “canOccupy”canOccupy:
boolean
Defined in: src/koota/koota.ts:240
Whether the placement can occupy the inspected footprint.
coordinates
Section titled “coordinates”coordinates:
HexCoordinates
Defined in: src/koota/koota.ts:228
Axial coordinates for the origin tile.
footprintTileKeys
Section titled “footprintTileKeys”footprintTileKeys: readonly
string[]
Defined in: src/koota/koota.ts:230
Tile keys in the proposed placement footprint.
missingTileKeys
Section titled “missingTileKeys”missingTileKeys: readonly
string[]
Defined in: src/koota/koota.ts:232
Footprint tile keys not present in the world.
occupancyGroup
Section titled “occupancyGroup”occupancyGroup:
string
Defined in: src/koota/koota.ts:236
Occupancy group assigned to the proposed placement.
reason?
Section titled “reason?”
optionalreason?:string
Defined in: src/koota/koota.ts:242
Machine-readable reason when canOccupy is false.
tileKey
Section titled “tileKey”tileKey:
string
Defined in: src/koota/koota.ts:226
Origin tile key that was inspected.