RouteStep

A value shape that methods take or return.

Group
player
Methods
None
Fields
14

Fields

FieldTypeDescription
kind"walk" | "transport" | "sail"What the step does: walk, take a transport, or sail one sea tile to the next aboard.
fromWorldPointWhere the step starts.
toWorldPointWhere the step ends: a teleport's landing tile, for one.
durationTicksnumberThe ticks the path server expects the step to take.
transportTypestring?The transport's class, such as "TELEPORTATION_ITEM", "FAIRY_RING" or "CHARTER_SHIP".
namestring?What the path server calls it: an item teleport's item ("Games necklace"), a spell or minigame teleport ("Lumbridge Home Teleport"), el…
optionstring?The menu option that fires it: "Burthorpe" on a games necklace, "Open" on a door.
objectIdnumber?The object it interacts with.
itemIds{ number }Every item id that can fire it (an item teleport's charge variants); empty for anything else.
isTeleportbooleanWhether it is a teleport: a spell, an item, a portal, a lever, a minigame teleport or the jewellery box.
isHomeTeleportbooleanWhether it is a home teleport spell, which share one cooldown.
isMinigameTeleportbooleanWhether 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…
sailRouteSail?A sea step's data: a "sail" step's fit, a BOARD_BOAT's dock and slot, a DISEMBARK's dock.

Returned by

MethodReturnsDescription
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…

Field details

transportType

transportType: string?

The transport's class, such as "TELEPORTATION_ITEM", "FAIRY_RING" or "CHARTER_SHIP".

Returns
nil for a walk.

name

name: 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").

Returns
nil for a walk.

option

option: string?

The menu option that fires it: "Burthorpe" on a games necklace, "Open" on a door.

Returns
nil for a walk.

objectId

objectId: number?

The object it interacts with.

Returns
nil unless it is an object transport.

items

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 of the clause's items may be held.

sail

sail: RouteSail?

A sea step's data: a "sail" step's fit, a BOARD_BOAT's dock and slot, a DISEMBARK's dock.

Returns
nil on land.