java.lang.Object
- net.runelite.client.plugins.Plugin
- - net.runelite.client.plugins.herbiboars.HerbiboarPlugin

All Implemented Interfaces:: com.google.inject.Module

@PluginDescriptor(name="Herbiboar",
                  description="Highlight starting rocks, trails, and the objects to search at the end of each trail",
                  tags={"herblore","hunter","skilling","overlay"})
public class HerbiboarPlugin
extends Plugin

Field Summary
- Fields inherited from class net.runelite.client.plugins.Plugin
  injector

Constructor Summary

Constructors
Constructor Description

HerbiboarPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`net.runelite.api.Client`	`getClient()`
`ClientThread`	`getClientThread()`
`net.runelite.client.plugins.herbiboars.HerbiboarSearchSpot.Group`	`getCurrentGroup()`
`List<net.runelite.client.plugins.herbiboars.HerbiboarSearchSpot>`	`getCurrentPath()`	Sequence of herbiboar spots searched along the current trail
`int`	`getFinishId()`
`net.runelite.client.plugins.herbiboars.HerbiboarMinimapOverlay`	`getMinimapOverlay()`
`net.runelite.client.plugins.herbiboars.TrailToSpot`	`getNextTrail()`
`net.runelite.client.plugins.herbiboars.HerbiboarOverlay`	`getOverlay()`
`OverlayManager`	`getOverlayManager()`
`Set<Integer>`	`getShownTrails()`	Trail object IDs which should be highlighted
`net.runelite.api.coords.WorldPoint`	`getStartPoint()`
`Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject>`	`getStarts()`	Objects which appear at the beginning of Herbiboar hunting trails
`net.runelite.client.plugins.herbiboars.HerbiboarStart`	`getStartSpot()`
`Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject>`	`getTrailObjects()`	Objects which trigger next trail (mushrooms, mud, seaweed, etc)
`Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject>`	`getTrails()`	Herbiboar hunting "footstep" trail objects
`Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject>`	`getTunnels()`	Tunnel where the Herbiboar is hiding at the end of a trail
`boolean`	`isInHerbiboarArea()`
`boolean`	`isStarted()`
`void`	`onGameObjectDespawned(net.runelite.api.events.GameObjectDespawned event)`
`void`	`onGameObjectSpawned(net.runelite.api.events.GameObjectSpawned event)`
`void`	`onGameStateChanged(net.runelite.api.events.GameStateChanged event)`
`void`	`onGroundObjectDespawned(net.runelite.api.events.GroundObjectDespawned event)`
`void`	`onGroundObjectSpawned(net.runelite.api.events.GroundObjectSpawned event)`
`void`	`onMenuOptionClicked(net.runelite.api.events.MenuOptionClicked menuOpt)`
`void`	`onVarbitChanged(net.runelite.api.events.VarbitChanged event)`
`protected void`	`shutDown()`
`protected void`	`startUp()`

Methods inherited from class net.runelite.client.plugins.Plugin
configure, equals, getInjector, getName, hashCode, resetConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- HerbiboarPlugin
```
public HerbiboarPlugin()
```

Method Detail

startUp

protected void startUp()
                throws Exception

Overrides:: startUp in class Plugin
Throws:: Exception

shutDown

protected void shutDown()
                 throws Exception

Overrides:: shutDown in class Plugin
Throws:: Exception

onMenuOptionClicked

@Subscribe
public void onMenuOptionClicked(net.runelite.api.events.MenuOptionClicked menuOpt)

onGameStateChanged

@Subscribe
public void onGameStateChanged(net.runelite.api.events.GameStateChanged event)

onVarbitChanged

@Subscribe
public void onVarbitChanged(net.runelite.api.events.VarbitChanged event)

onGameObjectSpawned

@Subscribe
public void onGameObjectSpawned(net.runelite.api.events.GameObjectSpawned event)

onGameObjectDespawned

@Subscribe
public void onGameObjectDespawned(net.runelite.api.events.GameObjectDespawned event)

onGroundObjectSpawned

@Subscribe
public void onGroundObjectSpawned(net.runelite.api.events.GroundObjectSpawned event)

onGroundObjectDespawned

@Subscribe
public void onGroundObjectDespawned(net.runelite.api.events.GroundObjectDespawned event)

getClient

public net.runelite.api.Client getClient()

getClientThread
```
public ClientThread getClientThread()
```

getOverlayManager

public OverlayManager getOverlayManager()

getOverlay

public net.runelite.client.plugins.herbiboars.HerbiboarOverlay getOverlay()

getMinimapOverlay

public net.runelite.client.plugins.herbiboars.HerbiboarMinimapOverlay getMinimapOverlay()

getStarts

public Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject> getStarts()

Objects which appear at the beginning of Herbiboar hunting trails

getTrails

public Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject> getTrails()

Herbiboar hunting "footstep" trail objects

getTrailObjects

public Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject> getTrailObjects()

Objects which trigger next trail (mushrooms, mud, seaweed, etc)

getTunnels

public Map<net.runelite.api.coords.WorldPoint,net.runelite.api.TileObject> getTunnels()

Tunnel where the Herbiboar is hiding at the end of a trail

getShownTrails
```
public Set<Integer> getShownTrails()
```
Trail object IDs which should be highlighted

getCurrentPath

public List<net.runelite.client.plugins.herbiboars.HerbiboarSearchSpot> getCurrentPath()

Sequence of herbiboar spots searched along the current trail

isInHerbiboarArea
```
public boolean isInHerbiboarArea()
```

getNextTrail

public net.runelite.client.plugins.herbiboars.TrailToSpot getNextTrail()

getCurrentGroup

public net.runelite.client.plugins.herbiboars.HerbiboarSearchSpot.Group getCurrentGroup()

getFinishId
```
public int getFinishId()
```

isStarted
```
public boolean isStarted()
```

getStartPoint

public net.runelite.api.coords.WorldPoint getStartPoint()

getStartSpot

public net.runelite.client.plugins.herbiboars.HerbiboarStart getStartSpot()

Class HerbiboarPlugin

Field Summary

Fields inherited from class net.runelite.client.plugins.Plugin

Constructor Summary