InspectGameboardPlacementOccupancyOptions
Defined in: src/koota/koota.ts:206
Options for simulating whether a placement can occupy a tile footprint.
Properties
Section titled “Properties”at:
string|HexCoordinates
Defined in: src/koota/koota.ts:208
Origin tile or tile key for the proposed placement.
ignorePlacementIds?
Section titled “ignorePlacementIds?”
optionalignorePlacementIds?: readonlystring[]
Defined in: src/koota/koota.ts:216
Placement ids ignored when checking blockers, usually the moving entity.
optionalkind?:GameboardPlacementKind
Defined in: src/koota/koota.ts:210
Placement kind to evaluate. Defaults to prop.
layer?
Section titled “layer?”
optionallayer?:GameboardPlacementLayer
Defined in: src/koota/koota.ts:212
Placement layer to evaluate. Defaults from kind.
metadata?
Section titled “metadata?”
optionalmetadata?:Readonly<Record<string,string|number|boolean|null>>
Defined in: src/koota/koota.ts:214
Placement metadata used for footprint and occupancy rules.
requireUnblocked?
Section titled “requireUnblocked?”
optionalrequireUnblocked?:boolean
Defined in: src/koota/koota.ts:218
Require no blockers even if the proposed placement itself is non-blocking.