SeaCostQuery

Methods
3
Fields
None

Getting one

PathQuery.seaCosts(…)

Methods

MethodReturnsDescription
isDone()booleanWhether the server has answered (or the request failed).
problem()string?Why there are no costs at all, or nil: the code of a request the path server refused ("BAD_MESSAGE" from one that predates sea costs, `…
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 (…

Returned by

MethodReturnsDescription
PathQueryClass.seaCostsSeaCostQueryFrom one place, for one boat, the cheapest sail to each of docks (their berths) and then each of tiles (any sea tile within `options.wi…

Method details

isDone

isDone: (SeaCostQuery) -> boolean

Whether the server has answered (or the request failed).

problem

problem: (SeaCostQuery) -> string?

Why there are no costs at all, or nil: the code of a request the path server refused ("BAD_MESSAGE" from one that predates sea costs, "NO_START" for a start aboard with the player ashore), else the failure in words. A target the boat cannot reach is its row's problem.

costs

costs: (SeaCostQuery) -> { 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 (no boarding, helm or landing); cost the route's cost as PathQuery:cost() counts it; landable whether the player may disembark at a dock now (its level, quest and gates); problem why a row is not reached ("NO_BOAT", "BOAT_UNREACHABLE", "CUTOFF_REACHED").