worldView
worldView: (BoardedBoat) -> numberThe boat's world view id.
player:sailing():boarded()| Method | Returns | Description |
|---|---|---|
worldView() | number | The 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() | boolean | Whether 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() | boolean | Whether the player is at the helm. |
atSails() | boolean | Whether the player is at the sails. |
helm() | BoatHelmStatus | What the helm shows. |
motion() | BoatMotion | How the boat moves under its sails. |
hp() | number | The boat's hit points. |
maxHp() | number | The boat's maximum hit points. |
repairKits() | number | Repair kits aboard. |
speed() | BoatSpeed | Base speed, speed cap and acceleration. |
speedBoost() | BoatSpeedBoost | The wind mote speed boost. |
windMotes() | number | Wind motes held. |
maxWindMotes() | number | The most wind motes the boat holds. |
windCatcherOn() | boolean | Whether the wind catcher is on. |
trim() | BoatTrim | The sails' trim. |
resistances() | BoatResistances | The boat's resistances, as its side panel shows them. |
playersAboard() | number | How many players are aboard. |
role() | number | The 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. |
| Method | Returns | Description |
|---|---|---|
Sailing.boarded | BoardedBoat? | The boat the player is on; nil ashore. |
worldViewworldView: (BoardedBoat) -> numberThe boat's world view id.
positionposition: (BoardedBoat) -> BoatPosition?Where the boat is now; nil when its position cannot be read.
orientationorientation: (BoardedBoat) -> number?The boat's orientation, 0 to 2047; nil when it cannot be read.
headingheading: (BoardedBoat) -> BoatHeading?Where the boat faces and where it is turning to; nil when it cannot be read.
movingmoving: (BoardedBoat) -> boolean?Whether the server is moving the boat; nil when it cannot be read.
targettarget: (BoardedBoat) -> BoatPosition?Where the boat is moving to, else where it is; nil when it cannot be read.
ownown: (BoardedBoat) -> booleanWhether the boat is one of the player's own.
slotslot: (BoardedBoat) -> number?The player's boat slot, 1 to 5, while the boat is the player's own; nil otherwise.
kindkind: (BoardedBoat) -> BoatKind?The boat type; nil when the client cannot read the game's boat table.
navigatingnavigating: (BoardedBoat) -> booleanWhether the player is at the helm.
atSailsatSails: (BoardedBoat) -> booleanWhether the player is at the sails.
helmhelm: (BoardedBoat) -> BoatHelmStatusWhat the helm shows.
motionmotion: (BoardedBoat) -> BoatMotionHow the boat moves under its sails.
hphp: (BoardedBoat) -> numberThe boat's hit points.
maxHpmaxHp: (BoardedBoat) -> numberThe boat's maximum hit points.
repairKitsrepairKits: (BoardedBoat) -> numberRepair kits aboard.
speedspeed: (BoardedBoat) -> BoatSpeedBase speed, speed cap and acceleration.
speedBoostspeedBoost: (BoardedBoat) -> BoatSpeedBoostThe wind mote speed boost.
windMoteswindMotes: (BoardedBoat) -> numberWind motes held.
maxWindMotesmaxWindMotes: (BoardedBoat) -> numberThe most wind motes the boat holds.
windCatcherOnwindCatcherOn: (BoardedBoat) -> booleanWhether the wind catcher is on.
trimtrim: (BoardedBoat) -> BoatTrimThe sails' trim.
resistancesresistances: (BoardedBoat) -> BoatResistancesThe boat's resistances, as its side panel shows them.
playersAboardplayersAboard: (BoardedBoat) -> numberHow many players are aboard.
rolerole: (BoardedBoat) -> numberThe game's code for the player's role aboard.
partsparts: (BoardedBoat) -> { BoatPart }The parts the boat wears. On a boat that is not the player's own, only the sail, steering and hull.
facilitiesfacilities: (BoardedBoat) -> { BoatFacility }The facilities in the boat's hotspots, each with its object on the deck.
crewcrew: (BoardedBoat) -> { Crewmate }The crew aboard, by slot.
cargocargo: (BoardedBoat) -> { ItemHandle }?The cargo hold's items; nil while the game names no hold. The items are read-only.