ticks
ticks: number?Sailing ticks at the boat's pace: from rest, without boosts, boarding, the helm or landing.
- Returns
nilwhen notreached.
A value shape that methods take or return.
| Field | Type | Description |
|---|---|---|
reached | boolean | The boat sails there. |
ticks | number? | Sailing ticks at the boat's pace: from rest, without boosts, boarding, the helm or landing. |
cost | number? | The route's cost as PathQuery:cost() counts it (a tick a straight tile, more in danger). |
straight | number? | The route's sail moves along an axis. |
diagonal | number? | The route's diagonal sail moves. |
stopsAt | WorldPoint? | Where the boat stops: a dock's berth, or the sea tile near the one asked. |
landable | boolean | A dock the player may disembark at now: its Sailing level, quest and gates. false for a tile. |
problem | string? | Why it is not reached: "NO_BOAT", "BOAT_UNREACHABLE" or "CUTOFF_REACHED". |
| Method | Returns | Description |
|---|---|---|
SeaCostQuery.costs | { SeaCost }? | One row a target, in the order asked (the docks, then the tiles), or nil until answered. ticks is the sailing time at the boat's pace (… |
ticksticks: number?Sailing ticks at the boat's pace: from rest, without boosts, boarding, the helm or landing.
nil when not reached.costcost: number?The route's cost as PathQuery:cost() counts it (a tick a straight tile, more in danger).
nil when not reached.straightstraight: number?The route's sail moves along an axis.
nil when not reached.diagonaldiagonal: number?The route's diagonal sail moves.
nil when not reached.stopsAtstopsAt: WorldPoint?Where the boat stops: a dock's berth, or the sea tile near the one asked.
nil when not reached.problemproblem: string?Why it is not reached: "NO_BOAT", "BOAT_UNREACHABLE" or "CUTOFF_REACHED".
nil when reached.