Package rsb.wrappers

Class RSLocalPath

java.lang.Object

rsb.methods.MethodProvider

rsb.wrappers.RSPath

rsb.wrappers.RSLocalPath

public class RSLocalPath
extends RSPath

Author:

GigiaJ

Nested Class Summary

Nested classes/interfaces inherited from class rsb.wrappers.RSPath

RSPath.TraversalOption

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BLOCKED
static final int	WALL_EAST
static final int	WALL_NORTH
static final int	WALL_NORTH_EAST
static final int	WALL_NORTH_WEST
static final int	WALL_SOUTH
static final int	WALL_SOUTH_EAST
static final int	WALL_SOUTH_WEST
static final int	WALL_WEST

Fields inherited from class rsb.methods.MethodProvider

methods

Constructor Summary

Constructors

Constructor	Description
RSLocalPath(MethodContext ctx, RSTile end)

Method Summary

Modifier and Type	Method	Description
RSTilePath	getCurrentTilePath()	Returns the calculated RSTilePath that is currently providing data to this RSLocalPath.
RSTile	getEnd()	Gets the end tile of this path.
RSTile	getNext()	Gets the next immediately available vertex in this path.
RSTile	getStart()	Gets the start tile of this path.
boolean	isValid()	Checks whether this path can be traversed by the player.
boolean	traverse(EnumSet<RSPath.TraversalOption> options)	Takes a step along this path if appropriate.

Methods inherited from class rsb.wrappers.RSPath

traverse

Methods inherited from class rsb.methods.MethodProvider

random, random, random, random, sleep

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

WALL_NORTH_WEST

public static final int WALL_NORTH_WEST

See Also:

• Constant Field Values

WALL_NORTH

public static final int WALL_NORTH

See Also:

• Constant Field Values

WALL_NORTH_EAST

public static final int WALL_NORTH_EAST

See Also:

• Constant Field Values

WALL_EAST

public static final int WALL_EAST

See Also:

• Constant Field Values

WALL_SOUTH_EAST

public static final int WALL_SOUTH_EAST

See Also:

• Constant Field Values

WALL_SOUTH

public static final int WALL_SOUTH

See Also:

• Constant Field Values

WALL_SOUTH_WEST

public static final int WALL_SOUTH_WEST

See Also:

• Constant Field Values

WALL_WEST

public static final int WALL_WEST

See Also:

• Constant Field Values

BLOCKED

public static final int BLOCKED

See Also:

• Constant Field Values

Constructor Details

RSLocalPath

public RSLocalPath(MethodContext ctx,
 RSTile end)

Method Details

traverse

public boolean traverse(EnumSet<RSPath.TraversalOption> options)

Takes a step along this path if appropriate. If the path cannot be traversed due to the player being too far from its vertices or already at the end vertex, false will be returned. In all other cases, true will be returned, but an action will not necessarily be performed (based on the given options).

Specified by:

traverse in class RSPath

Parameters:

options - Walking style options.

Returns:

true if this path is currently valid for the player; otherwise false.

isValid

public boolean isValid()

Checks whether this path can be traversed by the player. This will be the case provided that the player near to one of its vertices, but not already standing on the end vertex.

Specified by:

isValid in class RSPath

Returns:

true if the player can walk along this path; otherwise false.

getNext

public RSTile getNext()

Gets the next immediately available vertex in this path.

Specified by:

getNext in class RSPath

Returns:

The next walkable RSTile.

getStart

public RSTile getStart()

Gets the start tile of this path.

Specified by:

getStart in class RSPath

Returns:

The start RSTile.

getEnd

public RSTile getEnd()

Gets the end tile of this path.

Specified by:

getEnd in class RSPath

Returns:

The end RSTile.

getCurrentTilePath

public RSTilePath getCurrentTilePath()

Returns the calculated RSTilePath that is currently providing data to this RSLocalPath.

Returns:

The current RSTile path; or null.