Package org.dreambot.api.methods.walking.web.node

Class CustomWebPath

java.lang.Object

org.dreambot.api.methods.walking.web.node.CustomWebPath

public class CustomWebPath
extends java.lang.Object

CustomWebPath is a helper class that makes creating and attaching custom web nodes to our standard web nodes easier

Field Summary

Fields

Modifier and Type	Field	Description
int	endNode
int	startNode

Constructor Summary

Constructors

Constructor	Description
CustomWebPath(boolean connect, AbstractWebNode... nodes)	Adds each web node to this custom web node path If connect is true, each node will have a two way connection to the previous node
CustomWebPath(Tile... tiles)	Creates a new BasicWebNode for each Tile with two way connections between each node
CustomWebPath(AbstractWebNode... nodes)	see CustomWebPath(boolean, AbstractWebNode...) with a default boolean of True

Method Summary

Modifier and Type	Method	Description
void	addNode(Tile tile)	see addNode(Tile, boolean) with default of True
void	addNode(Tile tile, boolean twoWay)	Creates a BasicWebNode and adds it to this custom web path using addNode(AbstractWebNode, boolean)
void	addNode(AbstractWebNode node)	Adds a web node to this custom path using addNode(AbstractWebNode, boolean) with a default of True
void	addNode(AbstractWebNode node, boolean twoWay)	Adds a web node to the end of this path's list.
void	addNodes(Tile... tiles)	Adds each Tile using addNode(Tile, boolean) with a default of True
void	addNodes(AbstractWebNode... nodes)	Adds each node using addNode(AbstractWebNode, boolean) with a default of True
void	attachToWeb()	Attaches this custom web path into the global web
boolean	attachToWeb(boolean attachStart, boolean attachEnd)	Attaches this custom web path into the global web Will automatically call connectStartToClosestNode() and connectEndToClosestNode() based on the parameters passed
boolean	connectEndToClosestNode()	This will connect the end of this path to the nearest BasicWebNode when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called
boolean	connectStartToClosestNode()	This will connect the start of this path to the nearest BasicWebNode when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called for this path This will NOT cadd this path to the full global web.
void	connectToEnd(int nodeIndex)	This will connect the end of this path to the provided node index when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called for this path This will NOT connect this path to the full global web
void	connectToStart(int nodeIndex)	This will connect the start of this path to the provided node index when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called for this path This will NOT add this path to the full global web.
AbstractWebNode	getEnd()
java.util.ArrayList<AbstractWebNode>	getNodes()
AbstractWebNode	getStart()

Methods inherited from class java.lang.Object

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

Field Detail

startNode

public int startNode

endNode

public int endNode

Constructor Detail

CustomWebPath

public CustomWebPath(Tile... tiles)

Creates a new BasicWebNode for each Tile with two way connections between each node

Parameters:

tiles - Tiles to add to the custom web path

CustomWebPath

public CustomWebPath(AbstractWebNode... nodes)

see CustomWebPath(boolean, AbstractWebNode...) with a default boolean of True

CustomWebPath

public CustomWebPath(boolean connect,
                     AbstractWebNode... nodes)

Adds each web node to this custom web node path If connect is true, each node will have a two way connection to the previous node

Parameters:

connect - If True will add two way connections, if False the connection will be one way from previous to current

nodes - AbstractWebNode nodes to add to this path

Method Detail

addNode

public void addNode(Tile tile)

see addNode(Tile, boolean) with default of True

addNodes

public void addNodes(Tile... tiles)

Adds each Tile using addNode(Tile, boolean) with a default of True

addNodes

public void addNodes(AbstractWebNode... nodes)

Adds each node using addNode(AbstractWebNode, boolean) with a default of True

addNode

public void addNode(Tile tile,
                    boolean twoWay)

Creates a BasicWebNode and adds it to this custom web path using addNode(AbstractWebNode, boolean)

Parameters:

tile - Tile to add as a BasicWebNode

twoWay - whether the connection should be two way or not to the current last node

addNode

public void addNode(AbstractWebNode node)

Adds a web node to this custom path using addNode(AbstractWebNode, boolean) with a default of True

addNode

public void addNode(AbstractWebNode node,
                    boolean twoWay)

Adds a web node to the end of this path's list. If twoWay is true, it will do a two way connection to the previous node.

Parameters:

node - AbstractWebNode to add to the end of the list

twoWay - boolean whether the connection should be two way or one way

connectToStart

public void connectToStart(int nodeIndex)

This will connect the start of this path to the provided node index when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called for this path This will NOT add this path to the full global web.

Parameters:

nodeIndex - The index of the AbstractWebNode to attach this path to

connectStartToClosestNode

public boolean connectStartToClosestNode()

This will connect the start of this path to the nearest BasicWebNode when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called for this path This will NOT cadd this path to the full global web.

Returns:

true if there's a node within 32 tiles to attach it to, false otherwise

connectEndToClosestNode

public boolean connectEndToClosestNode()

This will connect the end of this path to the nearest BasicWebNode when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called

Note: This should only be called after all web nodes are added, otherwise it'll attach at the wrong point in your custom path This will NOT add this path to the full global web.

Returns:

true if there's a node within 32 tiles to attach it to, false otherwise

connectToEnd

public void connectToEnd(int nodeIndex)

This will connect the end of this path to the provided node index when attachToWeb() or WebFinder.addCustomWebPath(CustomWebPath) is called for this path This will NOT connect this path to the full global web

Parameters:

nodeIndex - The index of the AbstractWebNode to attach this path to

getStart

public AbstractWebNode getStart()

getEnd

public AbstractWebNode getEnd()

getNodes

public java.util.ArrayList<AbstractWebNode> getNodes()

attachToWeb

public void attachToWeb()

Attaches this custom web path into the global web

attachToWeb

public boolean attachToWeb(boolean attachStart,
                           boolean attachEnd)

Attaches this custom web path into the global web Will automatically call connectStartToClosestNode() and connectEndToClosestNode() based on the parameters passed

Parameters:

attachStart -

attachEnd -

Returns:

False if attach start is requested and fails, false if attach end is requested and fails, else true