WebwalkStatus

A value shape that methods take or return.

Group
player
Methods
None
Fields
5

Getting one

player:webwalk():status()

Fields

FieldTypeDescription
state"idle" | "running" | "arrived" | "closest" | "failed"How the walk stands: "idle" no walk since the last stop(), "running" the route is being walked, "arrived" the destination was reach…
failureWebwalkFailureCode?Why it failed.
reasonstring?The failure in words, or what the walk has to say on ending: why it stopped short, or what putting the old gear back said.
stepstring?What the walk is doing now, such as "Configure Fairy ring 29495 at 3202,3200,0".
destinationWorldPoint?The tile the walk is going to. A walk to several candidates, or to the nearest bank, picks one with its first route and keeps it through ev…

Returned by

MethodReturnsDescription
Webwalk.statusWebwalkStatusWhere a started walk stands, without advancing it: "idle" when there has been none since the last stop(), else how it is going or how i…

Field details

state

state: "idle" | "running" | "arrived" | "closest" | "failed"

How the walk stands: "idle" no walk since the last stop(), "running" the route is being walked, "arrived" the destination was reached, "closest" the walk ended as near as any route goes, because nothing reaches the destination (only within 10 tiles of it and on its plane: a nearest tile farther off fails the walk "NO_ROUTE"), and "failed" it gave up, which stays so until stop() or the next start.

reason

reason: string?

The failure in words, or what the walk has to say on ending: why it stopped short, or what putting the old gear back said.

Returns
nil when there is nothing to say.

step

step: string?

What the walk is doing now, such as "Configure Fairy ring 29495 at 3202,3200,0".

Returns
nil unless a route is being walked.

destination

destination: WorldPoint?

The tile the walk is going to. A walk to several candidates, or to the nearest bank, picks one with its first route and keeps it through every replan.

Returns
nil until a route has picked it.