org.osbot.rs07.api

Class Menu

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Menu

public class Menu
extends API

Represents the API regarding menu functionality.

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
Menu()

Method Summary

Modifier and Type	Method and Description
int	getHeight() Gets the current menu's height.
java.util.List<Option>	getMenu() Gets a list of all the options in the menu in the correct order.
int	getMenuCount() The amount of options in the menu.
int	getMenuIndex(Entity entity, java.lang.String[] names, java.lang.String[] actions)
int	getMenuIndex(java.lang.String[] names, java.lang.String[] actions) Returns the menu index of the first action found using the entity name.
java.awt.Rectangle	getOptionRectangle(int index)
java.awt.Rectangle	getRectangle()
java.lang.String	getTooltip()
int	getWidth() Gets the current menu's width.
int	getX() Gets the current X position of the menu.
int	getY() Gets the current Y position of the menu.
void	initializeModule()
boolean	isOpen() Returns if a menu is open.
boolean	onlyContainsCancel()
boolean	selectAction(java.lang.String action) Selects an action from the available menu.

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

Menu

public Menu()

Method Detail

isOpen

public boolean isOpen()

Returns if a menu is open.

Returns:

If a menu is open.

getMenuCount

public int getMenuCount()

The amount of options in the menu.

Returns:

The amount of options in the menu.

getMenu

public java.util.List<Option> getMenu()

Gets a list of all the options in the menu in the correct order.

Returns:

The list of all menu options.

getTooltip

public java.lang.String getTooltip()

Returns:

The client's tooltip text on the top-left corner.

getX

public int getX()

Gets the current X position of the menu.

Returns:

The current X position of the menu.

getY

public int getY()

Gets the current Y position of the menu.

Returns:

The current Y position of the menu.

getWidth

public int getWidth()

Gets the current menu's width.

Returns:

The current menu's width.

getHeight

public int getHeight()

Gets the current menu's height.

Returns:

The current menu's height.

getMenuIndex

public int getMenuIndex(java.lang.String[] names,
                        java.lang.String[] actions)

Returns the menu index of the first action found using the entity name.

Parameters:

names - The name of the entity you wish to look for ("Maple tree", null)

actions - The possible actions you wish to search for.

Returns:

The menu index of an action.

selectAction

public boolean selectAction(java.lang.String action)

Selects an action from the available menu.

Parameters:

action - The action you wish you to select.

Returns:

True if the action exists and the mouse events were successful.

getMenuIndex

public int getMenuIndex(Entity entity,
                        java.lang.String[] names,
                        java.lang.String[] actions)

getOptionRectangle

public java.awt.Rectangle getOptionRectangle(int index)

onlyContainsCancel

public boolean onlyContainsCancel()

getRectangle

public java.awt.Rectangle getRectangle()

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API