Getting one
player:sailing():pilot():status()
Fields
| Field | Type | Description |
|---|
state | "idle" | "preparing" | "sailing" | "done" | "failed" | "idle" no lap since the last stop(), "preparing" it is taking the helm or opening the sail controls, "sailing" the lap is being sai… |
|---|
reason | string? | Why it failed, in words. |
|---|
remaining | number | How many of the lap's objectives (its crates, click steps, portals) are still to do; 0 when idle. |
|---|
due | string? | The click step that is next and due (of those you give as remaining), by its name in the course (click <name> x,y), for you to click it… |
|---|
notes | { string } | Lines for your log, new since the last status(): the boost the lap started with, each heading click with the tick it showed, each trim an… |
|---|
steady | number | Ticks the boat's heading is held from now as the pilot steers it (0 while it turns): a facility worked at the helm that steering would canc… |
|---|
Field details
state: "idle" | "preparing" | "sailing" | "done" | "failed"
"idle" no lap since the last stop(), "preparing" it is taking the helm or opening the sail controls, "sailing" the lap is being sailed, "done" every objective is done (the pilot keeps the boat clear of the rocks, by its heading, until the game ends the lap), "failed" it gave up and un-set the sails, which stays so until the next start or stop().
reason: string?
Why it failed, in words.
- Returns
nil unless state is "failed".
due: string?
The click step that is next and due (of those you give as remaining), by its name in the course (click <name> x,y), for you to click its target. It is raised on every tick the boat is in reach, and from one move before (you read it a tick after the pilot's tick): click on every tick it is raised.
- Returns
nil while no click step is due.
notes: { string }
Lines for your log, new since the last status(): the boost the lap started with, each heading click with the tick it showed, each trim and each wind mote released.
steady: number
Ticks the boat's heading is held from now as the pilot steers it (0 while it turns): a facility worked at the helm that steering would cancel (a crystal extractor's harvest, 4 ticks) is worked in them, the pilot asked to hold.