BoatPosition
A value shape that methods take or return.
Getting one
player:sailing():boarded():position()
player:sailing():boarded():target()Fields
| Field | Type | Description |
|---|---|---|
tile | WorldPoint | The sea tile it is on. |
fineX | number | Its fine x in the top level's scene, 128 to a tile. |
fineY | number | Its fine y in the top level's scene, 128 to a tile. |
Returned by
| Method | Returns | Description |
|---|---|---|
BoardedBoat.position | BoatPosition? | Where the boat is now; nil when its position cannot be read. |
BoardedBoat.target | BoatPosition? | Where the boat is moving to, else where it is; nil when it cannot be read. |
OwnedBoat.position | BoatPosition? | Where the boat is, while it is the boat in the world and loaded near you; nil otherwise. |