BoatTrim
A value shape that methods take or return.
Getting one
player:sailing():boarded():trim()Fields
| Field | Type | Description |
|---|---|---|
ready | boolean | Whether the trim window is open: trimming now catches the gust. |
ticksLeft | number? | Game ticks left in the window; nil when it is not open, or the client cannot read it. |
waiting | boolean | Whether the sails wait for a gust (not while a speed boost is on). |
ticksToGust | number? | Game ticks until the gust; nil when not waiting, or the client cannot read it. |
Returned by
| Method | Returns | Description |
|---|---|---|
BoardedBoat.trim | BoatTrim | The sails' trim. |