Travel

const Travel: object

Defined in: client/api.d.ts:1894

The local player’s fast travel, as something to read. There is deliberately no verb: starting a travel moves the player, advances the world clock and can fire a random event, so in a session that is the server’s decision rather than one for a resource on the traveller’s own machine.

Type Declaration

active

readonly active: boolean

Whether a fast travel is running right now.

position

readonly position: Vector3

Where the travel has got to along its route, in world-space metres. Zero while none is running: check active first.

canStart()

canStart(): number | null

Asks the game whether a fast travel could begin right now, without starting one. The answer is the game’s own refusal code; only 0 is proven, and it means yes.

Returns

number | null

The refusal code, or null before the player module is up.