GameboardScenarioPatrolRoute

Defined in: packages/declarative-hex-worlds/src/scenario/scenario.ts:86

Patrol route rule embedded in a scenario.

Extends

• GameboardPatrolRouteRule

Properties

count?

optional count?: number

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:73

Requested waypoint count.

Inherited from

GameboardPatrolRouteRule.count

---

edgePadding?

optional edgePadding?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/grid.ts:87

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

Inherited from

SpawnLocationOptions.edgePadding

---

elevation?

optional elevation?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/grid.ts:89

Elevation used when projecting spawn locations to world positions.

Inherited from

SpawnLocationOptions.elevation

---

excludeTileTags?

optional excludeTileTags?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/gameboard/spawn-groups.ts:34

Tile tags that must all be absent.

Inherited from

GameboardPatrolRouteRule.excludeTileTags

---

id

id: string

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:95

Stable route id.

Inherited from

GameboardPatrolRouteRule.id

---

idPrefix?

optional idPrefix?: string

Defined in: packages/declarative-hex-worlds/src/coordinates/grid.ts:91

Prefix used for generated spawn ids.

Inherited from

SpawnLocationOptions.idPrefix

---

loop?

optional loop?: boolean

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:85

Whether the patrol returns to its first waypoint.

Inherited from

GameboardPatrolRouteRule.loop

---

maxElevation?

optional maxElevation?: number

Defined in: packages/declarative-hex-worlds/src/gameboard/spawn-groups.ts:30

Maximum candidate elevation.

Inherited from

GameboardPatrolRouteRule.maxElevation

---

minDistance?

optional minDistance?: number

Defined in: packages/declarative-hex-worlds/src/coordinates/grid.ts:85

Minimum axial distance between returned spawn coordinates.

Inherited from

SpawnLocationOptions.minDistance

---

minElevation?

optional minElevation?: number

Defined in: packages/declarative-hex-worlds/src/gameboard/spawn-groups.ts:28

Minimum candidate elevation.

Inherited from

GameboardPatrolRouteRule.minElevation

---

profile?

optional profile?: GameboardNavigationProfile

Defined in: packages/declarative-hex-worlds/src/gameboard/spawn-groups.ts:24

Navigation profile used to reject blocked candidates.

Inherited from

GameboardPatrolRouteRule.profile

---

requireCompleteRoute?

optional requireCompleteRoute?: boolean

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:87

Treat missing route segments as errors.

Inherited from

GameboardPatrolRouteRule.requireCompleteRoute

---

routeProfile?

optional routeProfile?: GameboardNavigationProfile

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:83

Navigation profile used for route segments.

Inherited from

GameboardPatrolRouteRule.routeProfile

---

seed?

optional seed?: string | number

Defined in: packages/declarative-hex-worlds/src/coordinates/grid.ts:79

Seed used when candidate order must be randomized.

Inherited from

SpawnLocationOptions.seed

---

start?

optional start?: string | HexCoordinates

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:75

Explicit start tile, actor, or key.

Inherited from

GameboardPatrolRouteRule.start

---

startGroupId?

optional startGroupId?: string

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:77

Spawn group id used for the start waypoint.

Inherited from

GameboardPatrolRouteRule.startGroupId

---

startLocationIndex?

optional startLocationIndex?: number

Defined in: packages/declarative-hex-worlds/src/gameboard/patrol-routes.ts:79

Location index within the start spawn group.

Inherited from

GameboardPatrolRouteRule.startLocationIndex

---

terrain?

optional terrain?: GameboardTerrain | readonly GameboardTerrain[]

Defined in: packages/declarative-hex-worlds/src/gameboard/spawn-groups.ts:26

Allowed terrain for spawn candidates.

Inherited from

GameboardPatrolRouteRule.terrain

---

tileTags?

optional tileTags?: readonly string[]

Defined in: packages/declarative-hex-worlds/src/gameboard/spawn-groups.ts:32

Tile tags that must all be present.

Inherited from

GameboardPatrolRouteRule.tileTags