slot
slot: (OwnedBoat) -> numberThe boat slot, 1 to 5.
| Method | Returns | Description |
|---|---|---|
slot() | number | The boat slot, 1 to 5. |
owned() | boolean | Whether the slot holds a boat. |
kind() | BoatKind? | The boat type; nil when the client cannot read the game's boat table. |
name() | string? | The boat's name, its words joined by spaces; nil when none can be read. |
parts() | { BoatPart } | The parts the boat wears. |
teleportFocus() | BoatTeleportFocus | The boat's teleport focus. |
facilities() | { BoatFacilityKind } | The facilities in the boat's hotspots. |
stats() | BoatStats? | The boat's stats: the only place its resistances come from while the player is not aboard. nil when the client cannot read the game's table… |
storedHp() | number? | The hit points the boat was left with; nil when none are stored. |
storedMaxHp() | number? | The maximum hit points the boat was left with; nil when none are stored. |
location() | BoatLocation? | Where the boat is; nil when the game names a dock the client cannot read. |
spawned() | boolean | Whether this is the boat in the world now. |
position() | BoatPosition? | Where the boat is, while it is the boat in the world and loaded near you; nil otherwise. |
orientation() | number? | The boat's orientation, 0 to 2047, while it is the boat in the world and loaded near you; nil otherwise. |
cargo() | { ItemHandle } | The cargo hold's items, read-only. Its size is stats().cargoSize. |
| Method | Returns | Description |
|---|---|---|
Sailing.boats | { OwnedBoat } | The player's boats, by slot: the slots that hold one. |
slotslot: (OwnedBoat) -> numberThe boat slot, 1 to 5.
ownedowned: (OwnedBoat) -> booleanWhether the slot holds a boat.
kindkind: (OwnedBoat) -> BoatKind?The boat type; nil when the client cannot read the game's boat table.
namename: (OwnedBoat) -> string?The boat's name, its words joined by spaces; nil when none can be read.
partsparts: (OwnedBoat) -> { BoatPart }The parts the boat wears.
teleportFocusteleportFocus: (OwnedBoat) -> BoatTeleportFocusThe boat's teleport focus.
facilitiesfacilities: (OwnedBoat) -> { BoatFacilityKind }The facilities in the boat's hotspots.
statsstats: (OwnedBoat) -> BoatStats?The boat's stats: the only place its resistances come from while the player is not aboard. nil when the client cannot read the game's tables, never a boat of zeros.
storedHpstoredHp: (OwnedBoat) -> number?The hit points the boat was left with; nil when none are stored.
storedMaxHpstoredMaxHp: (OwnedBoat) -> number?The maximum hit points the boat was left with; nil when none are stored.
locationlocation: (OwnedBoat) -> BoatLocation?Where the boat is; nil when the game names a dock the client cannot read.
spawnedspawned: (OwnedBoat) -> booleanWhether this is the boat in the world now.
positionposition: (OwnedBoat) -> BoatPosition?Where the boat is, while it is the boat in the world and loaded near you; nil otherwise.
orientationorientation: (OwnedBoat) -> number?The boat's orientation, 0 to 2047, while it is the boat in the world and loaded near you; nil otherwise.
cargocargo: (OwnedBoat) -> { ItemHandle }The cargo hold's items, read-only. Its size is stats().cargoSize.