MethodProvider

java.lang.Object
- org.osbot.core.AbstractMethodProvider<Bot>
- - org.osbot.rs07.script.MethodProvider

Direct Known Subclasses:: API, Event, Script

public class MethodProvider
extends org.osbot.core.AbstractMethodProvider<Bot>

Field Summary

Fields
Modifier and Type	Field and Description
`Bank`	`bank` The `Bank` instance.
`Bot`	`bot` The `Bot` instance.
`Camera`	`camera` The `Camera` instance.
`Chatbox`	`chatbox` The `Chatbox` instance.
`Client`	`client` The `Client` instance.
`ColorPicker`	`colorPicker` The `ColorPicker` instance.
`Combat`	`combat` The `Combat` instance.
`Configs`	`configs` The `Configs` instance.
`DepositBox`	`depositBox` The `DepositBox` instance.
`Dialogues`	`dialogues` The `Dialogues` instance.
`Diaries`	`diaries` The `Diaries` instance.
`Display`	`display` The (@link org.osbot.rs07.api.Display) instance.
`DoorHandler`	`doorHandler` The `DoorHandler` instance.
`Equipment`	`equipment` The `Equipment` instance.
`ExperienceTracker`	`experienceTracker` The `ExperienceTracker` instance.
`Favour`	`favour` The `Favour` instance
`GrandExchange`	`grandExchange` The (@link org.osbot.rs07.api.GrandExchange) instance.
`GraphicObjects`	`graphicObjects` The `GraphicObjects` instance
`GroundItems`	`groundItems` The `GroundItems` instance.
`HintArrow`	`hintArrow` The `HintArrow` instance.
`Inventory`	`inventory` The `Inventory` instance.
`Keyboard`	`keyboard` The `Keyboard` instance.
`org.osbot.utility.Logger`	`logger` The `Logger` instance.
`LogoutTab`	`logoutTab` The `LogoutTab` instance.
`Magic`	`magic` The `Magic` instance.
`Map`	`map` The `Map` instance.
`Menu`	`menu` The `Menu` instance.
`Mouse`	`mouse` The `Mouse` instance.
`NPCS`	`npcs` The `NPCS` instance.
`Objects`	`objects` The `Objects` instance.
`Players`	`players` The `Players` instance.
`Prayer`	`prayer` The `Prayer` instance.
`Projectiles`	`projectiles` The (@link org.osbot.rs07.api.Projectiles) instance.
`Quests`	`quests` The `Quests` instance.
`Settings`	`settings` The `Settings` instance.
`Skills`	`skills` The `Skills` instance.
`Store`	`store` The `Store` instance.
`Tabs`	`tabs` The `Tabs` instance.
`Trade`	`trade` The `Trade` instance.
`Walking`	`walking` The `Walking` instance.
`Widgets`	`widgets` The `Widgets` instance.
`Worlds`	`worlds` The (@link org.osbot.rs07.api.Worlds) instance.

Constructor Summary

Constructors
Constructor and Description

MethodProvider()

Constructors
Constructor and Description
`MethodProvider()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MethodProvider`	`exchangeContext(Bot bot)` This class and method can be used to create extensions to the API with full direct access to the OSBot 2 API within your extensions.
`Event`	`execute(Event event)` Provides an event to the engine for execution.
`Bank`	`getBank()` Obtains the `Bank` instance.
`Bot`	`getBot()` Gets the `Bot` instance.
`Camera`	`getCamera()` Obtains the `Camera` instance.
`Chatbox`	`getChatbox()` Obtains the `Chatbox` instance.
`Client`	`getClient()` Gets the `Client` instance.
`ColorPicker`	`getColorPicker()` Obtains the `ColorPicker` instance.
`Combat`	`getCombat()` Obtains the `Combat` instance.
`Configs`	`getConfigs()` Obtains the `Configs` instance.
`DepositBox`	`getDepositBox()` Obtains the `DepositBox` instance.
`Dialogues`	`getDialogues()` Obtains the `Dialogues` instance.
`Diaries`	`getDiaries()` Obtains the `Diaries` instance.
`Display`	`getDisplay()` Obtains the `Display` instance.
`DoorHandler`	`getDoorHandler()` Obtains the `DoorHandler` instance.
`Equipment`	`getEquipment()` Obtains the `Equipment` instance.
`ExperienceTracker`	`getExperienceTracker()` Obtains the `ExperienceTracker` instance.
`Favour`	`getFavour()` Obtains the `Favour` instance.
`GrandExchange`	`getGrandExchange()` Obtains the `GrandExchange` instance.
`GraphicObjects`	`getGraphicObjects()` Obtains the `GraphicObjects` instance.
`GroundItems`	`getGroundItems()` Obtains the `NPCS` instance.
`HintArrow`	`getHintArrow()` Obtains the `HintArrow` instance.
`Inventory`	`getInventory()` Obtains the `Inventory` instance.
`Keyboard`	`getKeyboard()` Obtains the `Keyboard` instance.
`LogoutTab`	`getLogoutTab()` Obtains the `LogoutTab` instance.
`Magic`	`getMagic()` Obtains the `Magic` instance.
`Map`	`getMap()` Obtains the `Map` instance.
`Menu`	`getMenuAPI()` Obtains the `Menu` instance.
`Mouse`	`getMouse()` Obtains the `Mouse` instance.
`NPCS`	`getNpcs()` Obtains the `NPCS` instance.
`Objects`	`getObjects()` Obtains the `Objects` instance.
`Players`	`getPlayers()` Obtains the `Players` instance.
`Prayer`	`getPrayer()` Obtains the `Prayer` instance.
`Projectiles`	`getProjectiles()` Obtains the `Projectiles` instance.
`Quests`	`getQuests()` Obtains the `Quests` instance.
`Settings`	`getSettings()` Obtains the `Settings` instance.
`Skills`	`getSkills()` Obtains the `Skills` instance.
`Store`	`getStore()` Obtains the `Store` instance
`Tabs`	`getTabs()` Obtains the `Tabs` instance.
`Trade`	`getTrade()` Obtains the `Trade` instance.
`Walking`	`getWalking()` Obtains the `Walking` instance.
`Widgets`	`getWidgets()` Obtains the `RS2Widget` instance.
`Worlds`	`getWorlds()` Obtains the `Worlds` instance.
`static int`	`gRandom(int mean, double stdDeviation)` Deprecated.
`static int`	`gRandom(int mean, double stdDeviation, int min, int max)` Deprecated.
`static int`	`gRandom(int lowerBound, int upperBound, double stdDeviation)` Deprecated.
`MethodProvider`	`initializeContext(Bot bot)` Deprecated. For internal use only.
`void`	`log(java.lang.Object object)` Logs a message to the console.
`void`	`log(java.lang.String s)` Logs a message to the console.
`Player`	`myPlayer()` Obtains the `Player` instance.
`Position`	`myPosition()` Obtains the player's current position.
`static int`	`random(int v)` Generates a random integer between 0 and `v` (exclusive).
`static int`	`random(int min, int max)` Generates a random integer between `min` and `max` (both inclusive).
`static void`	`sleep(long ms)` Sleeps for the specified amount of milliseconds.
`static java.lang.String`	`stripFormatting(java.lang.String input)` Removes any html tags from the given string and returns the stripped version.
`void`	`warn(java.lang.String s)` Logs a message to the console.

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

- Field Detail
  - bot
```
public Bot bot
```
    The Bot instance.
  - client
```
public Client client
```
    The Client instance.
  - logger
```
public org.osbot.utility.Logger logger
```
    The Logger instance.
  - npcs
```
public NPCS npcs
```
    The NPCS instance.
  - players
```
public Players players
```
    The Players instance.
  - groundItems
```
public GroundItems groundItems
```
    The GroundItems instance.
  - objects
```
public Objects objects
```
    The Objects instance.
  - widgets
```
public Widgets widgets
```
    The Widgets instance.
  - tabs
```
public Tabs tabs
```
    The Tabs instance.
  - inventory
```
public Inventory inventory
```
    The Inventory instance.
  - bank
```
public Bank bank
```
    The Bank instance.
  - depositBox
```
public DepositBox depositBox
```
    The DepositBox instance.
  - store
```
public Store store
```
    The Store instance.
  - equipment
```
public Equipment equipment
```
    The Equipment instance.
  - map
```
public Map map
```
    The Map instance.
  - combat
```
public Combat combat
```
    The Combat instance.
  - magic
```
public Magic magic
```
    The Magic instance.
  - prayer
```
public Prayer prayer
```
    The Prayer instance.
  - settings
```
public Settings settings
```
    The Settings instance.
  - configs
```
public Configs configs
```
    The Configs instance.
  - skills
```
public Skills skills
```
    The Skills instance.
  - mouse
```
public Mouse mouse
```
    The Mouse instance.
  - keyboard
```
public Keyboard keyboard
```
    The Keyboard instance.
  - camera
```
public Camera camera
```
    The Camera instance.
  - menu
```
public Menu menu
```
    The Menu instance.
  - dialogues
```
public Dialogues dialogues
```
    The Dialogues instance.
  - colorPicker
```
public ColorPicker colorPicker
```
    The ColorPicker instance.
  - logoutTab
```
public LogoutTab logoutTab
```
    The LogoutTab instance.
  - doorHandler
```
public DoorHandler doorHandler
```
    The DoorHandler instance.
  - experienceTracker
```
public ExperienceTracker experienceTracker
```
    The ExperienceTracker instance.
  - walking
```
public Walking walking
```
    The Walking instance.
  - trade
```
public Trade trade
```
    The Trade instance.
  - chatbox
```
public Chatbox chatbox
```
    The Chatbox instance.
  - quests
```
public Quests quests
```
    The Quests instance.
  - diaries
```
public Diaries diaries
```
    The Diaries instance.
  - hintArrow
```
public HintArrow hintArrow
```
    The HintArrow instance.
  - grandExchange
```
public GrandExchange grandExchange
```
    The (@link org.osbot.rs07.api.GrandExchange) instance.
  - worlds
```
public Worlds worlds
```
    The (@link org.osbot.rs07.api.Worlds) instance.
  - projectiles
```
public Projectiles projectiles
```
    The (@link org.osbot.rs07.api.Projectiles) instance.
  - display
```
public Display display
```
    The (@link org.osbot.rs07.api.Display) instance.
  - favour
```
public Favour favour
```
    The Favour instance
  - graphicObjects
```
public GraphicObjects graphicObjects
```
    The GraphicObjects instance
- Constructor Detail
  - MethodProvider
```
public MethodProvider()
```
- Method Detail
  - stripFormatting
```
public static java.lang.String stripFormatting(java.lang.String input)
```
    Removes any html tags from the given string and returns the stripped version.
    
    Parameters:
    
    input - The input string containing html tags.
    
    Returns:
    
    The stripped input string containing no html tags.
  - random
```
public static int random(int v)
```
    Generates a random integer between 0 and v (exclusive).
    
    Parameters:
    
    v - The upper bound (exclusive).
    
    Returns:
    
    A random integer between 0 and v (exclusive).
  - random
```
public static int random(int min,
                         int max)
```
    Generates a random integer between min and max (both inclusive).
    
    Parameters:
    
    min - The lower bound (inclusive).
    
    max - The upper bound (inclusive).
    
    Returns:
    
    A random integer between min and max (both inclusive).
  - gRandom
```
@Deprecated
public static int gRandom(int mean,
                                       double stdDeviation)
                                throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Generates a random integer based on a partial normal distribution to the right of the curve.
    
    This function is Deprecated because it does not adhere to the correct normal distribution formula.
    
    Parameters:
    
    mean - The mean (must be positive).
    
    stdDeviation - The standard deviation.
    
    Returns:
    
    A random integer based on a partial normal distribution
    
    Throws:
    
    java.lang.IllegalArgumentException - This will be thrown when you specify a mean lower than 0.
  - gRandom
```
@Deprecated
public static int gRandom(int lowerBound,
                                       int upperBound,
                                       double stdDeviation)
                                throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Generates a random integer based on a partial normal distribution to the right of the curve.
    
    This function is Deprecated because it does not adhere to the correct normal distribution formula.
    
    Parameters:
    
    lowerBound - The lower bound to define the mean.
    
    upperBound - The upper bound to define the mean.
    
    stdDeviation - The standard deviation.
    
    Returns:
    
    A random integer based on a partial normal distribution
    
    Throws:
    
    java.lang.IllegalArgumentException - This will be thrown when you specify an upper bound that's equal or lower than the lower bound.
  - gRandom
```
@Deprecated
public static int gRandom(int mean,
                                       double stdDeviation,
                                       int min,
                                       int max)
                                throws java.lang.IllegalArgumentException
```
    Deprecated.
    
    Throws:
    
    java.lang.IllegalArgumentException
  - sleep
```
public static void sleep(long ms)
                  throws java.lang.InterruptedException
```
    Sleeps for the specified amount of milliseconds.
    
    Parameters:
    
    ms - Number of milliseconds to sleep. Must be positive.
    
    Throws:
    
    java.lang.InterruptedException - Thrown when this thread is interrupted.
  - initializeContext
```
public MethodProvider initializeContext(Bot bot)
```
    Deprecated. For internal use only.
    
    Used only once internally to initialize the bot context for the main API entrance. Uses reflection so therefore should only be used once, at the initialization of the Bot instance. As a scripter ignore the existence of this method.
    
    Parameters:
    
    bot - The Bot instance.
    
    Returns:
    
    The instance of this MethodProvider contained in the Bot instance under getMethods(), which is the main API entrance for the entire OSBot 2 API.
  - exchangeContext
```
public MethodProvider exchangeContext(Bot bot)
```
    This class and method can be used to create extensions to the API with full direct access to the OSBot 2 API within your extensions. If you create your own extensions you extend the API class or MethodProvider and if you want to provide the existing API components to your own extensions you override this method with a call to this method first by calling super.exchangeContext(bot) followed by the initialization of your own components on which you call this method on.
    
    Specified by:
    
    exchangeContext in class org.osbot.core.AbstractMethodProvider<Bot>
    
    Parameters:
    
    bot - The Bot instance.
    
    Returns:
    
    The instance of this API extension.
  - getBot
```
public Bot getBot()
```
    Gets the Bot instance.
    
    Specified by:
    
    getBot in class org.osbot.core.AbstractMethodProvider<Bot>
    
    Returns:
    
    The Bot instance.
  - execute
```
public final Event execute(Event event)
```
    Provides an event to the engine for execution.
    
    Parameters:
    
    event - The event to provide to the engine.
    
    Returns:
    
    The event.
  - getClient
```
public Client getClient()
```
    Gets the Client instance.
    
    Returns:
    
    The Client instance.
  - getNpcs
```
public NPCS getNpcs()
```
    Obtains the NPCS instance.
    
    Returns:
    
    The NPCS instance.
  - getPlayers
```
public Players getPlayers()
```
    Obtains the Players instance.
    
    Returns:
    
    The Players instance.
  - getGroundItems
```
public GroundItems getGroundItems()
```
    Obtains the NPCS instance.
    
    Returns:
    
    The NPCS instance.
  - getObjects
```
public Objects getObjects()
```
    Obtains the Objects instance.
    
    Returns:
    
    The Objects instance.
  - getWidgets
```
public Widgets getWidgets()
```
    Obtains the RS2Widget instance.
    
    Returns:
    
    The RS2Widget instance.
  - getTabs
```
public Tabs getTabs()
```
    Obtains the Tabs instance.
    
    Returns:
    
    The Tabs instance.
  - getInventory
```
public Inventory getInventory()
```
    Obtains the Inventory instance.
    
    Returns:
    
    The Inventory instance.
  - getBank
```
public Bank getBank()
```
    Obtains the Bank instance.
    
    Returns:
    
    The Bank instance.
  - getDepositBox
```
public DepositBox getDepositBox()
```
    Obtains the DepositBox instance.
    
    Returns:
    
    The DepositBox instance.
  - getStore
```
public Store getStore()
```
    Obtains the Store instance
    
    Returns:
    
    The Store instance
  - getEquipment
```
public Equipment getEquipment()
```
    Obtains the Equipment instance.
    
    Returns:
    
    The Equipment instance.
  - getMap
```
public Map getMap()
```
    Obtains the Map instance.
    
    Returns:
    
    The Map instance.
  - getConfigs
```
public Configs getConfigs()
```
    Obtains the Configs instance.
    
    Returns:
    
    The Configs instance.
  - getMouse
```
public Mouse getMouse()
```
    Obtains the Mouse instance.
    
    Returns:
    
    The Mouse instance.
  - getKeyboard
```
public Keyboard getKeyboard()
```
    Obtains the Keyboard instance.
    
    Returns:
    
    The Keyboard instance.
  - getCamera
```
public Camera getCamera()
```
    Obtains the Camera instance.
    
    Returns:
    
    The Camera instance.
  - getMenuAPI
```
public Menu getMenuAPI()
```
    Obtains the Menu instance.
    
    Returns:
    
    The Menu instance.
  - getColorPicker
```
public ColorPicker getColorPicker()
```
    Obtains the ColorPicker instance.
    
    Returns:
    
    The ColorPicker instance.
  - getGrandExchange
```
public GrandExchange getGrandExchange()
```
    Obtains the GrandExchange instance.
    
    Returns:
    
    The GrandExchange instance.
  - getQuests
```
public Quests getQuests()
```
    Obtains the Quests instance.
    
    Returns:
    
    The Quests instance.
  - getDiaries
```
public Diaries getDiaries()
```
    Obtains the Diaries instance.
    
    Returns:
    
    The Diaries instance.
  - getChatbox
```
public Chatbox getChatbox()
```
    Obtains the Chatbox instance.
    
    Returns:
    
    The Chatbox instance.
  - getWalking
```
public Walking getWalking()
```
    Obtains the Walking instance.
    
    Returns:
    
    The Walking instance.
  - getExperienceTracker
```
public ExperienceTracker getExperienceTracker()
```
    Obtains the ExperienceTracker instance.
    
    Returns:
    
    The ExperienceTracker instance.
  - getLogoutTab
```
public LogoutTab getLogoutTab()
```
    Obtains the LogoutTab instance.
    
    Returns:
    
    The LogoutTab instance.
  - getCombat
```
public Combat getCombat()
```
    Obtains the Combat instance.
    
    Returns:
    
    The Combat instance.
  - getMagic
```
public Magic getMagic()
```
    Obtains the Magic instance.
    
    Returns:
    
    The Magic instance.
  - getPrayer
```
public Prayer getPrayer()
```
    Obtains the Prayer instance.
    
    Returns:
    
    The Prayer instance.
  - getSettings
```
public Settings getSettings()
```
    Obtains the Settings instance.
    
    Returns:
    
    The Settings instance.
  - getSkills
```
public Skills getSkills()
```
    Obtains the Skills instance.
    
    Returns:
    
    The Skills instance.
  - getDialogues
```
public Dialogues getDialogues()
```
    Obtains the Dialogues instance.
    
    Returns:
    
    The Dialogues instance.
  - getDoorHandler
```
public DoorHandler getDoorHandler()
```
    Obtains the DoorHandler instance.
    
    Returns:
    
    The DoorHandler instance.
  - getTrade
```
public Trade getTrade()
```
    Obtains the Trade instance.
    
    Returns:
    
    The Trade instance.
  - getHintArrow
```
public HintArrow getHintArrow()
```
    Obtains the HintArrow instance.
    
    Returns:
    
    The HintArrow instance.
  - getWorlds
```
public Worlds getWorlds()
```
    Obtains the Worlds instance.
    
    Returns:
    
    The Worlds instance.
  - getProjectiles
```
public Projectiles getProjectiles()
```
    Obtains the Projectiles instance.
    
    Returns:
    
    The Projectiles instance.
  - getDisplay
```
public Display getDisplay()
```
    Obtains the Display instance.
    
    Returns:
    
    The Display instance.
  - getFavour
```
public Favour getFavour()
```
    Obtains the Favour instance.
    
    Returns:
    
    The Favour instance.
  - getGraphicObjects
```
public GraphicObjects getGraphicObjects()
```
    Obtains the GraphicObjects instance.
    
    Returns:
    
    The GraphicObjects instance.
  - myPlayer
```
public Player myPlayer()
```
    Obtains the Player instance.
    
    Returns:
    
    The Player instance.
  - myPosition
```
public Position myPosition()
```
    Obtains the player's current position.
    
    Returns:
    
    The current position of the player.
  - log
```
public void log(java.lang.Object object)
```
    Logs a message to the console. Object.toString will be logged
    
    Parameters:
    
    object - The object to log
  - log
```
public void log(java.lang.String s)
```
    Logs a message to the console.
    
    Parameters:
    
    s - The message to log
  - warn
```
public void warn(java.lang.String s)
```
    Logs a message to the console.
    
    Parameters:
    
    s - The message to log.

Class MethodProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

bot

client

logger

npcs

players

groundItems

objects

widgets

tabs

inventory

bank

depositBox

store

equipment

map

combat

magic

prayer

settings

configs

skills

mouse

keyboard

camera

menu

dialogues

colorPicker

logoutTab

doorHandler

experienceTracker

walking

trade

chatbox

quests

diaries

hintArrow

grandExchange

worlds

projectiles

display

favour

graphicObjects

Constructor Detail

MethodProvider

Method Detail

stripFormatting

random

random

gRandom

gRandom

gRandom

sleep

initializeContext

exchangeContext

getBot

execute

getClient

getNpcs

getPlayers

getGroundItems

getObjects

getWidgets

getTabs

getInventory

getBank

getDepositBox

getStore

getEquipment

getMap

getConfigs

getMouse

getKeyboard

getCamera

getMenuAPI