Sailing

Group
player
Methods
17
Fields
None

Getting one

player:sailing()

Methods

MethodReturnsDescription
boarded()BoardedBoat?The boat the player is on; nil ashore.
boats(){ OwnedBoat }The player's boats, by slot: the slots that hold one.
lastBoarded()number?The slot of the player's boat last boarded; nil for none.
crew(){ Crewmate }The player's crew, by slot.
docks(){ Dock }Every port and mooring point, in the game's table order.
dock(number)Dock?The dock with this id; nil for an id the game does not list.
dockAt(WorldPoint?)number?The dock a boat at point may disembark at: strictly inside the ring of buoys round a port's gangplank, else within 12 tiles of a mooring…
dockArea(number)DockArea?Where a boat may disembark at a dock; nil for an id no dock has.
portTasks(){ PortTask }The port tasks the player holds, by slot.
portTaskSlots()numberHow many port task slots the player has, 1 to 5.
trial()Trial?The Barracuda Trial the player is in; nil outside one.
trialMasterState(TrialKind)numberA trial's master state: 0 talk only, 1 can start, 2 none.
trialBest(TrialKind)number?The player's fastest personal best at a trial, in game ticks, across its ranks; nil before any.
trialRankBest(TrialKind, TrialRank)number?The player's personal best at one rank of a trial, in game ticks; nil before any, and always for "unranked", which keeps none.
shipwreck(number)Shipwreck?The shipwreck an object is, live or depleted; nil for any other object.
pilot()TrialPilotThis plugin's trial pilot, which sails a lap of a Barracuda Trial on the boat the player is on. There is one per plugin, and one helm: its…
voyage()VoyageThis plugin's voyage, which sails the boat the player is on through areas to a goal area, its click there made for you. There is one per pl…

Returned by

MethodReturnsDescription
PlayerDomain.sailingSailingSailing: the boat the player is on, their boats, crew, docks, port tasks, Barracuda Trials and shipwrecks.

Method details

lastBoarded

lastBoarded: (Sailing) -> number?

The slot of the player's boat last boarded; nil for none.

docks

docks: (Sailing) -> { Dock }

Every port and mooring point, in the game's table order.

dock

dock: (Sailing, number) -> Dock?

The dock with this id; nil for an id the game does not list.

id
The dock's id, 0 to 60.

dockAt

dockAt: (Sailing, WorldPoint?) -> number?

The dock a boat at point may disembark at: strictly inside the ring of buoys round a port's gangplank, else within 12 tiles of a mooring point or of the gangplank of a port with no ring buoys. nil away from every dock, or ashore with no point given.

point
The boat's tile; the boat the player is on, where the server has it, when omitted.

dockArea

dockArea: (Sailing, number) -> DockArea?

Where a boat may disembark at a dock; nil for an id no dock has.

id
The dock's id, 0 to 60.

trial

trial: (Sailing) -> Trial?

The Barracuda Trial the player is in; nil outside one.

trialMasterState

trialMasterState: (Sailing, TrialKind) -> number

A trial's master state: 0 talk only, 1 can start, 2 none.

kind
The trial: "temporTantrum", "jubblyJive" or "gwenithGlide".

trialBest

trialBest: (Sailing, TrialKind) -> number?

The player's fastest personal best at a trial, in game ticks, across its ranks; nil before any.

kind
The trial, e.g. "jubblyJive".

trialRankBest

trialRankBest: (Sailing, TrialKind, TrialRank) -> number?

The player's personal best at one rank of a trial, in game ticks; nil before any, and always for "unranked", which keeps none.

kind
The trial, e.g. "jubblyJive".
rank
The rank, e.g. "shark".

shipwreck

shipwreck: (Sailing, number) -> Shipwreck?

The shipwreck an object is, live or depleted; nil for any other object.

id
The object's id.

pilot

pilot: (Sailing) -> TrialPilot

This plugin's trial pilot, which sails a lap of a Barracuda Trial on the boat the player is on. There is one per plugin, and one helm: its start stops the plugin's webwalk and drops its voyage, and a voyage's or a webwalk's start stops it. Raises where no plugin's code is running to own it, as player:webwalk() does; so does start.

voyage

voyage: (Sailing) -> Voyage

This plugin's voyage, which sails the boat the player is on through areas to a goal area, its click there made for you. There is one per plugin, and one helm: its start stops the plugin's webwalk and drops its trial pilot, and either of those started drops it. Raises where no plugin's code is running to own it, as player:webwalk() does; so does start.