GameboardSpawnLocationOptions

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

Options for selecting spawn locations from a gameboard plan.

Extends

Omit<SpawnLocationOptions, "shape" | "candidates" | "passable">

Extended by

GameboardSpawnGroupRule

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.

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.

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.

profile?

optional profile?: GameboardNavigationProfile

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

Navigation profile used to reject blocked candidates.

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.

tileTags?

optional tileTags?: readonly string[]

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

Tile tags that must all be present.