GameboardSpawnGroupRule

Defined in: src/gameboard/navigation.ts:199

Rule for selecting one spawn group and checking routes to earlier groups.

Extends

• GameboardSpawnLocationOptions

Properties

count

count: number

Defined in: src/coordinates/grid.ts:51

Number of spawn locations to return.

Inherited from

SpawnLocationOptions.count

---

edgePadding?

optional edgePadding?: number

Defined in: src/coordinates/grid.ts:61

Number of outer rings/rows to avoid when selecting automatic candidates.

Inherited from

SpawnLocationOptions.edgePadding

---

elevation?

optional elevation?: number

Defined in: src/coordinates/grid.ts:63

Elevation used when projecting spawn locations to world positions.

Inherited from

SpawnLocationOptions.elevation

---

excludeTileTags?

optional excludeTileTags?: readonly string[]

Defined in: src/gameboard/navigation.ts:193

Tile tags that must all be absent.

Inherited from

GameboardSpawnGroupRule.excludeTileTags

---

id

id: string

Defined in: src/gameboard/navigation.ts:201

Stable spawn group id.

---

idPrefix?

optional idPrefix?: string

Defined in: src/coordinates/grid.ts:65

Prefix used for generated spawn ids.

Inherited from

SpawnLocationOptions.idPrefix

---

maxElevation?

optional maxElevation?: number

Defined in: src/gameboard/navigation.ts:189

Maximum candidate elevation.

Inherited from

GameboardSpawnLocationOptions.maxElevation

---

minDistance?

optional minDistance?: number

Defined in: src/coordinates/grid.ts:59

Minimum axial distance between returned spawn coordinates.

Inherited from

SpawnLocationOptions.minDistance

---

minDistanceFromGroups?

optional minDistanceFromGroups?: number

Defined in: src/gameboard/navigation.ts:203

Minimum distance from locations selected by previous groups.

---

minElevation?

optional minElevation?: number

Defined in: src/gameboard/navigation.ts:187

Minimum candidate elevation.

Inherited from

GameboardSpawnLocationOptions.minElevation

---

pathToGroups?

optional pathToGroups?: readonly string[]

Defined in: src/gameboard/navigation.ts:205

Previous group ids that must be path-checked from this group.

---

profile?

optional profile?: GameboardNavigationProfile

Defined in: src/gameboard/navigation.ts:183

Navigation profile used to reject blocked candidates.

Inherited from

GameboardSpawnLocationOptions.profile

---

requirePathToGroups?

optional requirePathToGroups?: boolean

Defined in: src/gameboard/navigation.ts:207

Treat missing routes to pathToGroups as errors.

---

routeProfile?

optional routeProfile?: GameboardNavigationProfile

Defined in: src/gameboard/navigation.ts:209

Navigation profile used only for route checks.

---

seed?

optional seed?: string | number

Defined in: src/coordinates/grid.ts:53

Seed used when candidate order must be randomized.

Inherited from

SpawnLocationOptions.seed

---

terrain?

optional terrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: src/gameboard/navigation.ts:185

Allowed terrain for spawn candidates.

Inherited from

GameboardSpawnGroupRule.terrain

---

tileTags?

optional tileTags?: readonly string[]

Defined in: src/gameboard/navigation.ts:191

Tile tags that must all be present.

Inherited from

GameboardSpawnGroupRule.tileTags