Getting one
player:sailing():voyage():status()
Fields
| Field | Type | Description |
|---|
state | "idle" | "preparing" | "sailing" | "arrived" | "failed" | "idle" no voyage since the last stop(), "preparing" it is taking the helm or opening the sail controls, "sailing" under way, `"arri… |
|---|
failure | VoyageFailure? | Why it failed. |
|---|
reason | string? | The failure in words. |
|---|
clicked | number? | The game tick the goal's click last went out. |
|---|
inArea | boolean | The boat's tile is in the goal. |
|---|
passed | number | How many of the areas to pass through are met. |
|---|
notes | { string } | Lines for your log, new since the last status(). |
|---|
Returned by
| Method | Returns | Description |
|---|
Voyage.status | VoyageStatus | How the voyage stands, without advancing it. Its notes are handed over once. |
|---|
Field details
state: "idle" | "preparing" | "sailing" | "arrived" | "failed"
"idle" no voyage since the last stop(), "preparing" it is taking the helm or opening the sail controls, "sailing" under way, "arrived" there as its arrival says, "failed" it gave up and un-set the sails, which stays so until the next start or stop().
failure: VoyageFailure?
Why it failed.
- Returns
nil unless state is "failed".
reason: string?
The failure in words.
- Returns
nil unless state is "failed".
clicked: number?
The game tick the goal's click last went out.
- Returns
nil before the click, and after a missed().