GameboardNavigation
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:109
Reusable navigation facade for one plan/profile pair.
Properties
Section titled “Properties”canEnter
Section titled “canEnter”canEnter: (
coordinates,from?) =>boolean
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:125
Return whether a tile can be entered from an optional source tile.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”string | HexCoordinates
string | HexCoordinates
Returns
Section titled “Returns”boolean
findPath
Section titled “findPath”findPath: (
start,goal) =>GameboardNavigationPathResult
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:131
Find a path between two tiles.
Parameters
Section titled “Parameters”string | HexCoordinates
string | HexCoordinates
Returns
Section titled “Returns”isBlocked
Section titled “isBlocked”isBlocked: (
coordinates) =>boolean
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:123
Return whether a tile key or coordinates are blocked.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”string | HexCoordinates
Returns
Section titled “Returns”boolean
movementCost
Section titled “movementCost”movementCost: (
from,to) =>number
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:127
Calculate movement cost between adjacent tiles.
Parameters
Section titled “Parameters”string | HexCoordinates
string | HexCoordinates
Returns
Section titled “Returns”number
neighbors
Section titled “neighbors”neighbors: (
coordinates) =>GameboardTileSpec[]
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:129
Return neighboring tiles inside the board.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”string | HexCoordinates
Returns
Section titled “Returns”occupancy
Section titled “occupancy”occupancy:
GameboardOccupancyIndex
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:117
Occupancy lookup for the plan/profile pair.
placementsAt
Section titled “placementsAt”placementsAt: (
coordinates) => readonlyGameboardPlacementSpec[]
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:121
Read placements occupying a tile.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”string | HexCoordinates
Returns
Section titled “Returns”readonly GameboardPlacementSpec[]
plan:
GameboardPlan
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:111
Board plan being navigated.
profile
Section titled “profile”profile:
RequiredGameboardNavigationProfile
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:113
Normalized required navigation profile.
reachable
Section titled “reachable”reachable: (
start,movementBudget) =>GameboardReachableTile[]
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:136
Return tiles reachable from a start tile within a movement budget.
Parameters
Section titled “Parameters”string | HexCoordinates
movementBudget
Section titled “movementBudget”number
Returns
Section titled “Returns”tileAt
Section titled “tileAt”tileAt: (
coordinates) =>GameboardTileSpec|undefined
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:119
Resolve a tile from coordinates or tile key.
Parameters
Section titled “Parameters”coordinates
Section titled “coordinates”string | HexCoordinates
Returns
Section titled “Returns”GameboardTileSpec | undefined
tilesByKey
Section titled “tilesByKey”tilesByKey:
ReadonlyMap<string,GameboardTileSpec>
Defined in: packages/declarative-hex-worlds/src/gameboard/navigation.ts:115
Tile lookup by tile key.