Skip to content

InspectGameboardPlacementOccupancyOptions

Defined in: src/koota/koota.ts:206

Options for simulating whether a placement can occupy a tile footprint.

at: string | HexCoordinates

Defined in: src/koota/koota.ts:208

Origin tile or tile key for the proposed placement.


optional ignorePlacementIds?: readonly string[]

Defined in: src/koota/koota.ts:216

Placement ids ignored when checking blockers, usually the moving entity.


optional kind?: GameboardPlacementKind

Defined in: src/koota/koota.ts:210

Placement kind to evaluate. Defaults to prop.


optional layer?: GameboardPlacementLayer

Defined in: src/koota/koota.ts:212

Placement layer to evaluate. Defaults from kind.


optional metadata?: Readonly<Record<string, string | number | boolean | null>>

Defined in: src/koota/koota.ts:214

Placement metadata used for footprint and occupancy rules.


optional requireUnblocked?: boolean

Defined in: src/koota/koota.ts:218

Require no blockers even if the proposed placement itself is non-blocking.