BoatTrim

A value shape that methods take or return.

Group
player
Methods
None
Fields
4

Getting one

player:sailing():boarded():trim()

Fields

FieldTypeDescription
readybooleanWhether the trim window is open: trimming now catches the gust.
ticksLeftnumber?Game ticks left in the window; nil when it is not open, or the client cannot read it.
waitingbooleanWhether the sails wait for a gust (not while a speed boost is on).
ticksToGustnumber?Game ticks until the gust; nil when not waiting, or the client cannot read it.

Returned by

MethodReturnsDescription
BoardedBoat.trimBoatTrimThe sails' trim.