BoatPosition

A value shape that methods take or return.

Group
player
Methods
None
Fields
3

Getting one

player:sailing():boarded():position()
player:sailing():boarded():target()

Fields

FieldTypeDescription
tileWorldPointThe sea tile it is on.
fineXnumberIts fine x in the top level's scene, 128 to a tile.
fineYnumberIts fine y in the top level's scene, 128 to a tile.

Returned by

MethodReturnsDescription
BoardedBoat.positionBoatPosition?Where the boat is now; nil when its position cannot be read.
BoardedBoat.targetBoatPosition?Where the boat is moving to, else where it is; nil when it cannot be read.
OwnedBoat.positionBoatPosition?Where the boat is, while it is the boat in the world and loaded near you; nil otherwise.