Package com.valhalla.sdk.api.pathing

Class MoveTask

java.lang.Object

com.valhalla.sdk.api.pathing.MoveTask

public final class MoveTask
extends Object

Immutable result of analyzing the next locally executable portion of a route.

Method Summary

Modifier and Type	Method	Description
boolean	canIssueWalk()	Returns whether this task contains a normal walk destination.
Optional<Tile>	getDestination()	Returns the farthest locally executable route tile, when available.
Optional<Tile>	getNext()	Returns the immediate route tile after the current cursor, when available.
int	getRouteIndex()	Returns the analyzed index in the original route.
MoveSituation	getSituation()	Returns the condition found while analyzing the route.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getSituation

public MoveSituation getSituation()

Returns the condition found while analyzing the route.

Returns:

the condition found while analyzing the route

getDestination

public Optional<Tile> getDestination()

Returns the farthest locally executable route tile, when available.

Returns:

the farthest locally executable route tile, when available

getNext

public Optional<Tile> getNext()

Returns the immediate route tile after the current cursor, when available.

Returns:

the immediate route tile after the current cursor, when available

getRouteIndex

public int getRouteIndex()

Returns the analyzed index in the original route.

Returns:

the analyzed index in the original route

canIssueWalk

public boolean canIssueWalk()

Returns whether this task contains a normal walk destination.

Returns:

whether this task contains a normal walk destination

toString

public String toString()

Overrides:

toString in class Object