Skip to content
declarative-hex-worlds

GameboardNavigationProfile

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

Pathfinding profile for terrain, elevation, occupancy, and custom movement rules.

Properties

Section titled “Properties”

allowedTerrain?

Section titled “allowedTerrain?”

optional allowedTerrain?: readonly GameboardTerrain[]

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

Terrain values the profile may enter. Undefined means all except blocked terrain.

allowGoalBlocked?

Section titled “allowGoalBlocked?”

optional allowGoalBlocked?: boolean

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

Whether the goal tile may be blocked.

allowStartBlocked?

Section titled “allowStartBlocked?”

optional allowStartBlocked?: boolean

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

Whether the start tile may be blocked.

blockedTerrain?

Section titled “blockedTerrain?”

optional blockedTerrain?: readonly GameboardTerrain[]

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

Terrain values the profile may not enter.

blockingPlacementKinds?

Section titled “blockingPlacementKinds?”

optional blockingPlacementKinds?: readonly GameboardPlacementKind[]

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

Placement kinds that block movement.

blockingPlacementLayers?

Section titled “blockingPlacementLayers?”

optional blockingPlacementLayers?: readonly GameboardPlacementLayer[]

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

Placement layers that block movement.

canEnter?

Section titled “canEnter?”

optional canEnter?: (tile, context) => boolean

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

Optional custom tile-entry predicate.

Parameters

Section titled “Parameters”
tile
Section titled “tile”

GameboardTileSpec

context
Section titled “context”

GameboardNavigationContext

Returns

Section titled “Returns”

boolean

cost?

Section titled “cost?”

optional cost?: (from, to, baseCost) => number

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

Optional custom movement-cost function.

Parameters

Section titled “Parameters”
from
Section titled “from”

GameboardTileSpec

to
Section titled “to”

GameboardTileSpec

baseCost
Section titled “baseCost”

number

Returns

Section titled “Returns”

number

ignorePlacementIds?

Section titled “ignorePlacementIds?”

optional ignorePlacementIds?: readonly string[]

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

Placement ids ignored by occupancy checks.

maxElevationStep?

Section titled “maxElevationStep?”

optional maxElevationStep?: number

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

Maximum allowed elevation change between adjacent tiles.

terrainCosts?

Section titled “terrainCosts?”

optional terrainCosts?: Readonly<Record<string, number>>

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

Additional movement costs by terrain value.