SpawnLocationOptions

Options for deterministic spawn coordinate selection and projection.

Properties

optional candidates?: readonly HexCoordinates[]

Explicit candidate coordinates to choose from instead of the whole shape.

count: number

Number of spawn locations to return.

optional edgePadding?: number

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

optional elevation?: number

Elevation used when projecting spawn locations to world positions.

optional idPrefix?: string

Prefix used for generated spawn ids.

optional minDistance?: number

Minimum axial distance between returned spawn coordinates.

optional passable?: (coordinates) => boolean

Predicate used to reject blocked or otherwise unsuitable coordinates.

boolean

optional seed?: string | number

Seed used when candidate order must be randomized.

shape: GameboardShape

Board shape to select candidate spawn coordinates from.