Class NavigationApi

Index

Constructors

Methods

cardinalDirections directionOffset invertDirection isCardinalDirection normalizeDirection

Constructors

constructor

new NavigationApi(): NavigationApi
Returns NavigationApi

Methods

`Static`cardinalDirections

cardinalDirections(): readonly CardinalDirection[]
List of canonical cardinal directions (useful for tests / iteration).

Returns readonly CardinalDirection[]
- Defined in packages/server/src/mud/api/navigation.ts:100

`Static`directionOffset

directionOffset(direction: string): [number, number, number] | undefined
Grid offset triple for a direction (canonical or alias).

Returns undefined for non-cardinals.
Parameters
- direction: string
Returns [number, number, number] | undefined
- Defined in packages/server/src/mud/api/navigation.ts:88

`Static`invertDirection

invertDirection(direction: string): CardinalDirection | undefined
Return the cardinal inverse of a direction.

Returns undefined for non-cardinals (semantic labels like 'office' or vessel-synthesized 'out' have no structural inverse; arrival messages degrade to "Alice arrives." for those cases).
Parameters
- direction: string
Returns CardinalDirection | undefined
- Defined in packages/server/src/mud/api/navigation.ts:77

`Static`isCardinalDirection

isCardinalDirection(direction: string): boolean
Is direction (or its alias) one of the 10 canonical cardinals?
Parameters
- direction: string
Returns boolean
- Defined in packages/server/src/mud/api/navigation.ts:95

`Static`normalizeDirection

normalizeDirection(input: string): CardinalDirection | undefined
Normalize a direction string (or alias) to its canonical long-form name.

Returns undefined when the input doesn't name a cardinal direction — callers should treat that as "not a direction, try it as a vessel keyword / semantic label" (see GoController).
Parameters
- input: string
Returns CardinalDirection | undefined
- Defined in packages/server/src/mud/api/navigation.ts:64