TreeScript (DreamBot Javadocs)

java.lang.Object
- org.dreambot.api.methods.MethodProvider
- - org.dreambot.api.script.AbstractScript
  - - org.dreambot.api.script.frameworks.treebranch.TreeScript

All Implemented Interfaces:

java.lang.Runnable, java.util.EventListener, Loggable, Sleepable, PaintListener
```
public abstract class TreeScript
extends AbstractScript
```
Framework implementation of AbstractScript based on the Tree Branch Leaf framework created by LostVirt https://github.com/LostVirt/Dreambot-Tree-Branch-Framework Creates a Root node, which has a linked list of Branch, each of which has a linked list of Leaf

Constructor Summary

Constructors
Constructor Description

TreeScript()
Creates a default root node, setting the root's parent to this tree

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Root`	`addBranches(Leaf... leaves)`	Add `Branch`s or `Leaf` nodes to the root Returns the root node to allow chained adds if desired.
`void`	`clear()`	Clears the root's children See `Branch.clear()`
`java.lang.String`	`getCurrentBranchName()`
`java.lang.String`	`getCurrentLeafName()`
`Root`	`getRoot()`
`int`	`onLoop()`	Primary execution loop of the script See `Branch.onLoop()`
`void`	`setCurrentBranchName(java.lang.String currentBranchName)`
`void`	`setCurrentLeafName(java.lang.String currentLeafName)`

Methods inherited from class org.dreambot.api.script.AbstractScript
buildRandomManager, getCurrentState, getManifest, getRandomManager, getRandomThread, getScriptId, getScriptManager, getScriptTimer, getSDNName, getSDNParameters, getStoreId, getThreadURL, getVersion, isPaused, isUserSponsor, isUserVIP, onExit, onPaint, onPaint, onPause, onResume, onScheduledStop, onSolverEnd, onSolverStart, onStart, onStart, run, setState, stop

Methods inherited from class org.dreambot.api.methods.MethodProvider
debug, error, info, log, print, sleep, sleep, sleepUntil, sleepUntil, sleepWhile, sleepWhile

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dreambot.api.script.frameworks.utility.Loggable
debug, debug, error, error, error, info, info, log, log, log, print, warn

Methods inherited from interface org.dreambot.api.script.frameworks.utility.Sleepable
sleep, sleep, sleepUntil, sleepUntil, sleepWhile, sleepWhile

- Constructor Detail
  - TreeScript
```
public TreeScript()
```
    Creates a default root node, setting the root's parent to this tree
- Method Detail
  - addBranches
```
public final Root addBranches(Leaf... leaves)
```
    Add Branchs or Leaf nodes to the root Returns the root node to allow chained adds if desired.
    
    Parameters:
    
    leaves - can be Branch or Leaf nodes
    
    Returns:
    
    this tree's root node
  - clear
```
public final void clear()
```
    Clears the root's children See Branch.clear()
  - onLoop
```
public int onLoop()
```
    Primary execution loop of the script See Branch.onLoop()
    
    Specified by:
    
    onLoop in class AbstractScript
    
    Returns:
    
    root's onLoop return, < 0 stops script, else script sleeps for return amount
  - getRoot
```
public Root getRoot()
```
  - getCurrentBranchName
```
public java.lang.String getCurrentBranchName()
```
  - setCurrentBranchName
```
public void setCurrentBranchName(java.lang.String currentBranchName)
```
  - getCurrentLeafName
```
public java.lang.String getCurrentLeafName()
```
  - setCurrentLeafName
```
public void setCurrentLeafName(java.lang.String currentLeafName)
```