Skip to content
declarative-hex-worlds

InspectGameboardPlacementOccupancyOptions

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:205

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

Properties

Section titled “Properties”

at

Section titled “at”

at: string | HexCoordinates

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:207

Origin tile or tile key for the proposed placement.

ignorePlacementIds?

Section titled “ignorePlacementIds?”

optional ignorePlacementIds?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:215

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

kind?

Section titled “kind?”

optional kind?: GameboardPlacementKind

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:209

Placement kind to evaluate. Defaults to prop.

layer?

Section titled “layer?”

optional layer?: GameboardPlacementLayer

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:211

Placement layer to evaluate. Defaults from kind.

metadata?

Section titled “metadata?”

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

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:213

Placement metadata used for footprint and occupancy rules.

requireUnblocked?

Section titled “requireUnblocked?”

optional requireUnblocked?: boolean

Defined in: packages/declarative-hex-worlds/src/koota/koota.ts:217

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