Sailing API

Control player-owned boats, inspect sailing state, and interact with sailing-specific actions.

sailing.BoatType.RAFT
sailing.BoatType.SKIFF
sailing.BoatType.SLOOP
sailing.BoatType.WILL_ANNE

sailing.MoveMode.STATIONARY
sailing.MoveMode.MOVING_FORWARD
sailing.MoveMode.REVERSING

sailing.Heading provides the 16-way sailing headings, for example:

sailing.Heading.NORTH
sailing.Heading.NORTH_EAST
sailing.Heading.WEST_SOUTH_WEST
sailing.Heading.SOUTH_SOUTH_EAST

sailing:on_boat() -> boolean

Returns:

• boolean - True when the local player is currently on their boat.

---

sailing:at_sails() -> boolean

Returns:

• boolean - True when the player is positioned at the sails.

---

sailing:navigating() -> boolean

Returns:

• boolean - True when the player is actively navigating at the helm.

---

sailing:boat_type() -> string

Returns:

• string - One of the sailing.BoatType.* values.

---

sailing:move_mode() -> string | nil

Returns:

• string | nil - One of the sailing.MoveMode.* values, or nil if unavailable.

---

sailing:stationary() -> boolean

Returns:

• boolean - True if the boat is stationary.

---

sailing:moving_forward() -> boolean

Returns:

• boolean - True if the boat is moving forward.

---

sailing:reversing() -> boolean

Returns:

• boolean - True if the boat is reversing.

---

sailing:current_heading() -> string | nil

Returns:

• string | nil - Current heading as sailing.Heading.*, or nil if unknown.

---

sailing:direction(x: number, y: number, floor: number) -> string

Calculates the closest sailing.Heading.* from the current boat position toward a target tile.

Example:

local heading = sailing:direction(3020, 3105, 0)
if heading == sailing.Heading.NORTH_EAST then
    logger:info("Need to head northeast")
end

---

sailing:angle() -> number | nil

Returns:

• number | nil - Current boat angle in degrees, or nil.

---

sailing:board_boat() -> boolean

Boards the boat through a nearby gangplank.

Returns:

• boolean - True if successful.

---

sailing:disembark_boat() -> boolean

Leaves the boat through a nearby gangplank.

Returns:

• boolean - True if successful.

---

sailing:navigate() -> boolean

Moves the player to the helm and enters navigation mode.

Returns:

• boolean - True if successful.

---

sailing:stop_navigating() -> boolean

Stops navigating at the helm.

Returns:

• boolean - True if successful.

---

sailing:set_sails() -> boolean

Sets the sails and waits for the boat to begin moving forward.

Returns:

• boolean - True if successful.

---

sailing:unset_sails() -> boolean

Unsets the sails and waits for the boat to stop.

Returns:

• boolean - True if successful.

---

sailing:reverse() -> boolean

Reverses the boat.

Returns:

• boolean - True if successful.

---

sailing:trim_sails() -> boolean

Trims sails for Sailing XP.

Returns:

• boolean - True if successful.

---

sailing:open_cargo() -> boolean

Opens the boat's cargo hold.

Returns:

• boolean - True if successful.

---

sailing:get_port_tasks() -> table

Returns:

• table - Array of active port task entries. Each entry includes slot, value, and task_type.

---

if sailing:on_boat() and not sailing:navigating() then
    sailing:navigate()
end

if sailing:navigating() and not sailing:moving_forward() then
    sailing:set_sails()
end

---

if sailing:navigating() and not sailing:reversing() then
    if sailing:reverse() then
        logger:info("Boat is reversing")
    end
end

---

local move_mode = sailing:move_mode()
local heading = sailing:current_heading()

logger:info("Move mode: " .. tostring(move_mode))
logger:info("Heading: " .. tostring(heading))

---

• API Overview — Module index (open the sailing tab in the client when needed)
• Skills API — Sailing XP and levels
• Game Objects API — Lower-level world object interaction