Class WebPath
- java.lang.Object
-
- com.runemate.game.api.hybrid.location.navigation.Path
-
- com.runemate.game.api.hybrid.location.navigation.web.WebPath
-
- All Implemented Interfaces:
Renderable
public class WebPath extends Path
A path that is generated from a Web instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebPath.PseudoCoordinateVertex
static class
WebPath.VertexSearchAction
-
Nested classes/interfaces inherited from class com.runemate.game.api.hybrid.location.navigation.Path
Path.TraversalOption
-
-
Field Summary
-
Fields inherited from class com.runemate.game.api.hybrid.location.navigation.Path
DEFAULT_TRAVERSAL_OPTIONS
-
-
Constructor Summary
Constructors Constructor Description WebPath(java.util.List<WebVertex> vertices, double traversalCost)
WebPath(java.util.List<WebVertex> vertices, java.util.Set<WebRequirement> requirements, double traversalCost)
WebPath(java.util.List<WebVertex> vertices, java.util.Set<WebRequirement> requirements, java.util.Set<WebRequirement> blockingConditions, double traversalCost)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
areRequirementsMet()
@NonNull java.util.Set<WebRequirement>
getBlockingConditions()
Deprecated.Locatable
getDestination()
WebVertex
getNext()
WebVertex
getNext(boolean preferViewportTraversal)
@NonNull java.util.Set<WebRequirement>
getRequirements()
Locatable
getStart()
double
getTraversalCost()
java.util.List<WebVertex>
getVertices()
Gets a list of the vertices in this pathvoid
reset()
Resets the last successful step counterboolean
step(@NonNull Path.TraversalOption... options)
java.lang.String
toString()
-
-
-
Constructor Detail
-
WebPath
public WebPath(java.util.List<WebVertex> vertices, double traversalCost)
-
WebPath
public WebPath(java.util.List<WebVertex> vertices, java.util.Set<WebRequirement> requirements, double traversalCost)
-
WebPath
public WebPath(java.util.List<WebVertex> vertices, java.util.Set<WebRequirement> requirements, java.util.Set<WebRequirement> blockingConditions, double traversalCost)
-
-
Method Detail
-
areRequirementsMet
public boolean areRequirementsMet()
-
getDestination
@Nullable public Locatable getDestination()
-
getRequirements
@NonNull public @NonNull java.util.Set<WebRequirement> getRequirements()
-
getBlockingConditions
@Deprecated @NonNull public @NonNull java.util.Set<WebRequirement> getBlockingConditions()
Deprecated.
-
getStart
@Nullable public Locatable getStart()
-
getTraversalCost
public double getTraversalCost()
-
step
public boolean step(@NonNull @NonNull Path.TraversalOption... options)
-
getVertices
public java.util.List<WebVertex> getVertices()
Description copied from class:Path
Gets a list of the vertices in this path- Specified by:
getVertices
in classPath
- Returns:
- A List
-
getNext
public WebVertex getNext()
-
getNext
public WebVertex getNext(boolean preferViewportTraversal)
-
reset
public void reset()
Resets the last successful step counter
-
-