VoyageStatus

A value shape that methods take or return.

Group
player
Methods
None
Fields
7

Getting one

player:sailing():voyage():status()

Fields

FieldTypeDescription
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…
failureVoyageFailure?Why it failed.
reasonstring?The failure in words.
clickednumber?The game tick the goal's click last went out.
inAreabooleanThe boat's tile is in the goal.
passednumberHow many of the areas to pass through are met.
notes{ string }Lines for your log, new since the last status().

Returned by

MethodReturnsDescription
Voyage.statusVoyageStatusHow the voyage stands, without advancing it. Its notes are handed over once.

Field details

state

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().

reason

reason: string?

The failure in words.

Returns
nil unless state is "failed".

clicked

clicked: number?

The game tick the goal's click last went out.

Returns
nil before the click, and after a missed().