BoardedBoat

Group
player
Methods
29
Fields
None

Getting one

player:sailing():boarded()

Methods

MethodReturnsDescription
worldView()numberThe boat's world view id.
position()BoatPosition?Where the boat is now; nil when its position cannot be read.
orientation()number?The boat's orientation, 0 to 2047; nil when it cannot be read.
heading()BoatHeading?Where the boat faces and where it is turning to; nil when it cannot be read.
moving()boolean?Whether the server is moving the boat; nil when it cannot be read.
target()BoatPosition?Where the boat is moving to, else where it is; nil when it cannot be read.
own()booleanWhether the boat is one of the player's own.
slot()number?The player's boat slot, 1 to 5, while the boat is the player's own; nil otherwise.
kind()BoatKind?The boat type; nil when the client cannot read the game's boat table.
navigating()booleanWhether the player is at the helm.
atSails()booleanWhether the player is at the sails.
helm()BoatHelmStatusWhat the helm shows.
motion()BoatMotionHow the boat moves under its sails.
hp()numberThe boat's hit points.
maxHp()numberThe boat's maximum hit points.
repairKits()numberRepair kits aboard.
speed()BoatSpeedBase speed, speed cap and acceleration.
speedBoost()BoatSpeedBoostThe wind mote speed boost.
windMotes()numberWind motes held.
maxWindMotes()numberThe most wind motes the boat holds.
windCatcherOn()booleanWhether the wind catcher is on.
trim()BoatTrimThe sails' trim.
resistances()BoatResistancesThe boat's resistances, as its side panel shows them.
playersAboard()numberHow many players are aboard.
role()numberThe game's code for the player's role aboard.
parts(){ BoatPart }The parts the boat wears. On a boat that is not the player's own, only the sail, steering and hull.
facilities(){ BoatFacility }The facilities in the boat's hotspots, each with its object on the deck.
crew(){ Crewmate }The crew aboard, by slot.
cargo(){ ItemHandle }?The cargo hold's items; nil while the game names no hold. The items are read-only.

Returned by

MethodReturnsDescription
Sailing.boardedBoardedBoat?The boat the player is on; nil ashore.

Method details

orientation

orientation: (BoardedBoat) -> number?

The boat's orientation, 0 to 2047; nil when it cannot be read.

moving

moving: (BoardedBoat) -> boolean?

Whether the server is moving the boat; nil when it cannot be read.

own

own: (BoardedBoat) -> boolean

Whether the boat is one of the player's own.

slot

slot: (BoardedBoat) -> number?

The player's boat slot, 1 to 5, while the boat is the player's own; nil otherwise.

role

role: (BoardedBoat) -> number

The game's code for the player's role aboard.

parts

parts: (BoardedBoat) -> { BoatPart }

The parts the boat wears. On a boat that is not the player's own, only the sail, steering and hull.