GameboardPatrolRouteOptions

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

Options for planning one patrol route.

Extends

• Omit<GameboardSpawnLocationOptions, "count">

Properties

count?

optional count?: number

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

Requested waypoint 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?

optional id?: string

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

Route id.

---

idPrefix?

optional idPrefix?: string

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

Prefix used for generated spawn ids.

Inherited from

SpawnLocationOptions.idPrefix

---

loop?

optional loop?: boolean

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

Whether the patrol returns to its first waypoint.

---

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

---

minElevation?

optional minElevation?: number

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

Minimum candidate elevation.

Inherited from

GameboardSpawnLocationOptions.minElevation

---

profile?

optional profile?: GameboardNavigationProfile

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

Navigation profile used to reject blocked candidates.

Inherited from

GameboardSpawnLocationOptions.profile

---

requireCompleteRoute?

optional requireCompleteRoute?: boolean

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

Treat missing route segments as errors.

---

routeProfile?

optional routeProfile?: GameboardNavigationProfile

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

Navigation profile used for route segments.

---

seed?

optional seed?: string | number

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

Seed used when candidate order must be randomized.

Inherited from

SpawnLocationOptions.seed

---

spawnGroups?

optional spawnGroups?: GameboardSpawnGroupPlan

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

Existing spawn group plan used for start resolution.

---

start?

optional start?: string | HexCoordinates

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

Explicit start tile, actor, or key.

---

startGroupId?

optional startGroupId?: string

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

Spawn group id used for the start waypoint.

---

startLocationIndex?

optional startLocationIndex?: number

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

Location index within the start spawn group.

---

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