transportType
transportType: string?The transport's class, such as "TELEPORTATION_ITEM", "FAIRY_RING" or "CHARTER_SHIP".
- Returns
nilfor a walk.
A value shape that methods take or return.
| Field | Type | Description |
|---|---|---|
kind | "walk" | "transport" | "sail" | What the step does: walk, take a transport, or sail one sea tile to the next aboard. |
from | WorldPoint | Where the step starts. |
to | WorldPoint | Where the step ends: a teleport's landing tile, for one. |
durationTicks | number | The ticks the path server expects the step to take. |
transportType | string? | The transport's class, such as "TELEPORTATION_ITEM", "FAIRY_RING" or "CHARTER_SHIP". |
name | string? | What the path server calls it: an item teleport's item ("Games necklace"), a spell or minigame teleport ("Lumbridge Home Teleport"), el… |
option | string? | The menu option that fires it: "Burthorpe" on a games necklace, "Open" on a door. |
objectId | number? | The object it interacts with. |
itemIds | { number } | Every item id that can fire it (an item teleport's charge variants); empty for anything else. |
isTeleport | boolean | Whether it is a teleport: a spell, an item, a portal, a lever, a minigame teleport or the jewellery box. |
isHomeTeleport | boolean | Whether it is a home teleport spell, which share one cooldown. |
isMinigameTeleport | boolean | Whether it is a minigame teleport, which share one cooldown. |
items | { { { id: number, amount: number } } } | What it needs: every clause is needed, and any one item of a clause satisfies it, with amount of it held. An amount of 0 means none o… |
sail | RouteSail? | A sea step's data: a "sail" step's fit, a BOARD_BOAT's dock and slot, a DISEMBARK's dock. |
| Method | Returns | Description |
|---|---|---|
PathQuery.steps | { RouteStep }? | The route, one step at a time, or nil until a route is found. A walk step is a stretch between the server's waypoints, not every tile wal… |
transportTypetransportType: string?The transport's class, such as "TELEPORTATION_ITEM", "FAIRY_RING" or "CHARTER_SHIP".
nil for a walk.namename: string?What the path server calls it: an item teleport's item ("Games necklace"), a spell or minigame teleport ("Lumbridge Home Teleport"), else an object's text ("Open Door 9398").
nil for a walk.optionoption: string?The menu option that fires it: "Burthorpe" on a games necklace, "Open" on a door.
nil for a walk.objectIdobjectId: number?The object it interacts with.
nil unless it is an object transport.itemsitems: { { { id: number, amount: number } } }What it needs: every clause is needed, and any one item of a clause satisfies it, with amount of it held. An amount of 0 means none of the clause's items may be held.
sailsail: RouteSail?A sea step's data: a "sail" step's fit, a BOARD_BOAT's dock and slot, a DISEMBARK's dock.
nil on land.