BoatHeading

A value shape that methods take or return.

Group
player
Methods
None
Fields
4

Getting one

player:sailing():boarded():heading()

Fields

FieldTypeDescription
orientationnumberThe boat's orientation, 0 to 2047.
stepnumberThe orientation rounded to the 16 headings a boat sails at, 0 to 15: heading k is orientation 128 * k.
targetOrientationnumberThe orientation the boat is turning to; orientation when it is not turning.
targetStepnumbertargetOrientation rounded to a heading, as step is.

Returned by

MethodReturnsDescription
BoardedBoat.headingBoatHeading?Where the boat faces and where it is turning to; nil when it cannot be read.