org.osbot.rs07.api

Class HintArrow

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.HintArrow

public class HintArrow
extends API

This class represents the API functionality regarding hint arrows, the yellow hint icons in the game.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HintArrow.HintArrowType Represents a type of hint arrow.

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
HintArrow()

Method Summary

Modifier and Type	Method and Description
Entity	getEntity() Gets the entity related to the hint arrow.
NPC	getNPC() Gets the npc related to the hint arrow.
Player	getPlayer() Gets the player related to the hint arrow.
Position	getPosition() Gets the position of the hint arrow.
HintArrow.HintArrowType	getType() Returns the type of hint arrow that is active.
void	initializeModule()
boolean	isActive() Returns true if there is an active hint arrow in the game.

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

HintArrow

public HintArrow()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getType

public HintArrow.HintArrowType getType()

Returns the type of hint arrow that is active.

Returns:

Returns the type of hint arrow that is active.

getEntity

public Entity getEntity()

Gets the entity related to the hint arrow. Null if there is no entity hint arrow.

Returns:

The entity related to the hint arrow. Null if there is no entity hint arrow.

getPlayer

public Player getPlayer()

Gets the player related to the hint arrow. Null if there is no player hint arrow.

Returns:

The player related to the hint arrow. Null if there is no player hint arrow.

getNPC

public NPC getNPC()

Gets the npc related to the hint arrow. Null if there is no npc hint arrow.

Returns:

The npc related to the hint arrow. Null if there is no npc hint arrow.

isActive

public boolean isActive()

Returns true if there is an active hint arrow in the game.

Returns:

True if there is an active hint arrow in the game.

getPosition

public Position getPosition()

Gets the position of the hint arrow. Null if there is no hint arrow.

Returns:

Position of the hint arrow, null if there is no hint arrow.