VoyageOptions

A value shape that methods take or return.

Group
player
Methods
None
Fields
6

Fields

FieldTypeDescription
goalVoyageAreaWhere the voyage ends: the area its click is made in, or the boat comes to rest in.
through{ VoyageArea }?Areas to pass through on the way, in order (each met when a tick ends with the boat's tile in it); at most 64. nil: none.
clickVoyageClick?The click made in the goal. nil: none.
arrivalVoyageArrival?How it ends; nil for "halt".
route{ WorldPoint }?The way to the goal past the loaded scene, the boat's end first (a webwalk's tiles); at most 4096. nil: the scene's own sea.
holdMotesboolean?Keep the wind motes for you to release; nil or false: the pilot keeps them for the fetid pools, releasing one as its way runs onto a po…

Field details

holdMotes

holdMotes: boolean?

Keep the wind motes for you to release; nil or false: the pilot keeps them for the fetid pools, releasing one as its way runs onto a pool unprotected, and one at once whenever a catcher is full (a full one holds the wind).