GameboardLayoutCriteria

Defined in: src/coordinates/layout.ts:200

Rules that determine whether a tile can be used as a placement site.

Properties

allowOccupied?

optional allowOccupied?: boolean

Defined in: src/coordinates/layout.ts:238

Allow placement on tiles with blocking occupants.

---

blockingPlacementKinds?

optional blockingPlacementKinds?: readonly GameboardPlacementKind[]

Defined in: src/coordinates/layout.ts:240

Placement kinds that should be treated as blockers.

---

blockingPlacementLayers?

optional blockingPlacementLayers?: readonly GameboardPlacementLayer[]

Defined in: src/coordinates/layout.ts:242

Placement layers that should be treated as blockers.

---

edgePadding?

optional edgePadding?: number

Defined in: src/coordinates/layout.ts:254

Number of outer rings excluded from placement.

---

elevation?

optional elevation?: number | readonly number[]

Defined in: src/coordinates/layout.ts:206

Allowed exact elevations.

---

excludeFootprintTerrain?

optional excludeFootprintTerrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/coordinates/layout.ts:236

Disallowed terrain across any footprint tile.

---

excludeTerrain?

optional excludeTerrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/coordinates/layout.ts:204

Disallowed origin tile terrain.

---

excludeTileTags?

optional excludeTileTags?: readonly string[]

Defined in: src/coordinates/layout.ts:214

Tile tags that must all be absent.

---

footprint?

optional footprint?: GameboardLayoutFootprintInput

Defined in: src/coordinates/layout.ts:228

Footprint required by the placement.

---

footprintTerrain?

optional footprintTerrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/coordinates/layout.ts:234

Allowed terrain across all footprint tiles.

---

forbiddenAdjacentPlacementKind?

optional forbiddenAdjacentPlacementKind?: GameboardPlacementKind | readonly GameboardPlacementKind[]

Defined in: src/coordinates/layout.ts:222

Adjacent placement kinds that must be absent.

---

forbiddenAdjacentPlacementLayer?

optional forbiddenAdjacentPlacementLayer?: GameboardPlacementLayer | readonly GameboardPlacementLayer[]

Defined in: src/coordinates/layout.ts:226

Adjacent placement layers that must be absent.

---

forbiddenAdjacentTerrain?

optional forbiddenAdjacentTerrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/coordinates/layout.ts:218

Adjacent terrain that must be absent.

---

ignorePlacementIds?

optional ignorePlacementIds?: readonly string[]

Defined in: src/coordinates/layout.ts:244

Placement ids ignored during occupancy checks.

---

maxDistance?

optional maxDistance?: number

Defined in: src/coordinates/layout.ts:252

Maximum distance from at least one maxDistanceFrom reference.

---

maxDistanceFrom?

optional maxDistanceFrom?: readonly (string | HexCoordinates)[]

Defined in: src/coordinates/layout.ts:250

Reference tiles that the site must stay near.

---

maxElevation?

optional maxElevation?: number

Defined in: src/coordinates/layout.ts:210

Maximum origin tile elevation.

---

maxPerTile?

optional maxPerTile?: number

Defined in: src/coordinates/layout.ts:258

Maximum selected slots allowed on one tile.

---

minDistance?

optional minDistance?: number

Defined in: src/coordinates/layout.ts:248

Minimum distance from every minDistanceFrom reference.

---

minDistanceBetween?

optional minDistanceBetween?: number

Defined in: src/coordinates/layout.ts:256

Minimum distance between selected sites from the same selection call.

---

minDistanceFrom?

optional minDistanceFrom?: readonly (string | HexCoordinates)[]

Defined in: src/coordinates/layout.ts:246

Reference tiles that the site must stay away from.

---

minElevation?

optional minElevation?: number

Defined in: src/coordinates/layout.ts:208

Minimum origin tile elevation.

---

prefer?

optional prefer?: readonly GameboardLayoutPreference[]

Defined in: src/coordinates/layout.ts:262

Weighted preferences used to score candidate sites.

---

requiredAdjacentPlacementKind?

optional requiredAdjacentPlacementKind?: GameboardPlacementKind | readonly GameboardPlacementKind[]

Defined in: src/coordinates/layout.ts:220

Adjacent placement kinds that must be present.

---

requiredAdjacentPlacementLayer?

optional requiredAdjacentPlacementLayer?: GameboardPlacementLayer | readonly GameboardPlacementLayer[]

Defined in: src/coordinates/layout.ts:224

Adjacent placement layers that must be present.

---

requiredAdjacentTerrain?

optional requiredAdjacentTerrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/coordinates/layout.ts:216

Adjacent terrain that must be present.

---

requireFootprintInBounds?

optional requireFootprintInBounds?: boolean

Defined in: src/coordinates/layout.ts:230

Reject sites whose footprint leaves the board.

---

requireFootprintUnoccupied?

optional requireFootprintUnoccupied?: boolean

Defined in: src/coordinates/layout.ts:232

Reject sites whose footprint has blocking occupancy.

---

slotGroup?

optional slotGroup?: string

Defined in: src/coordinates/layout.ts:260

Optional slot group used to share occupancy slots between compatible pieces.

---

terrain?

optional terrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/coordinates/layout.ts:202

Allowed origin tile terrain.

---

tileTags?

optional tileTags?: readonly string[]

Defined in: src/coordinates/layout.ts:212

Tile tags that must all be present.