simple.robot.api

Class ClientContext

java.lang.Object

simple.robot.api.ClientContext

public class ClientContext
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
AntiBan	antiBan
SimpleBank	bank
Combat	combat
Definitions	definitions
Dialogue	dialogue
SimpleEquipment	equipment
FairyRing	fairyRing
Game	game
SimpleGroundItems	groundItems
SimpleWidgets	interfaces Deprecated.
SimpleInventory	inventory
Keyboard	keyboard
Magic	magic
SimpleMouse	mouse
SimpleNpcs	npcs
SimpleObjects	objects
ScriptPaint	paint
Pathing	pathing
SimplePlayers	players
PortalTeleports	portalTeleports
SimplePrayers	prayers
Projectiles	projectiles
SimpleShop	shop
SimpleSkills	skills
Trade	trade
ClientUser	user
Varpbits	varpbits
Viewport	viewport
SimpleWidgets	widgets

Constructor Summary

Constructors

Constructor and Description
ClientContext(net.runelite.api.Client client)

Method Summary

Modifier and Type	Method and Description
boolean	bobSolver()
boolean	bobSolver(boolean state)
SimpleBank	getBank() Deprecated.
net.runelite.api.Client	getClient()
Combat	getCombat() Deprecated.
Definitions	getDefinitions() Deprecated.
Dialogue	getDialogue() Deprecated.
SimpleEquipment	getEquipment() Deprecated.
FairyRing	getFairyRing() Deprecated.
SimpleGroundItems	getGroundItems() Deprecated.
SimpleWidgets	getInterfaces() Deprecated.
SimpleInventory	getInventory() Deprecated.
Keyboard	getKeyboard() Deprecated.
Magic	getMagic() Deprecated.
SimpleMouse	getMouse() Deprecated.
SimpleNpcs	getNpcs() Deprecated.
SimpleObjects	getObjects() Deprecated.
Pathing	getPathing() Deprecated.
SimplePlayers	getPlayers() Deprecated.
PortalTeleports	getPortalTeleports() Deprecated.
SimplePrayers	getPrayer() Deprecated.
Projectiles	getProjectiles() Deprecated.
SimpleShop	getShop() Deprecated.
Trade	getTrade() Deprecated.
Viewport	getViewport() Deprecated.
boolean	inFixedScreen()
static ClientContext	instance()
void	log(java.lang.String log, java.lang.Object... objects) Will print specified formatted string {log} to console and script log inside of the bot panel
boolean	onCondition(java.util.function.BooleanSupplier condition) Will sleep the current thread for a maximum of 5 seconds whilst checking if the {condition} has been met every 500ms's
boolean	onCondition(java.util.function.BooleanSupplier condition, int timeout) Will sleep the current thread for a maximum of {timeout}ms's whilst checking if the {condition} has been met every 500ms's
boolean	onCondition(java.util.function.BooleanSupplier condition, int timeout, int amount) Will sleep the current thread for the specified {timeout} * {amount} or until the {condition} is met.
boolean	sendLogout() Will log you out if you're currently logged in
void	sleep(int ms) Will sleep the current thread for {ms}ms's
void	sleep(int min, int max) Will sleep the current thread for a random amount of time between {min} and {max}
boolean	sleepCondition(java.util.function.BooleanSupplier condition) Refer to {onCondition(BooleanSupplier condition)}
boolean	sleepCondition(java.util.function.BooleanSupplier condition, int timeout) Refer to {onCondition(BooleanSupplier condition, int timeout)}
boolean	stopScript() Will stop the currently running script, returns {true} if it has been stopped {false} otherwise
void	submitLogCapture(java.lang.String log) Will print {log} to script log inside of the bot panel
void	updateStatus(java.lang.String status)

Methods inherited from class java.lang.Object

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

Field Detail

varpbits

public final Varpbits varpbits

groundItems

public final SimpleGroundItems groundItems

inventory

public final SimpleInventory inventory

npcs

public final SimpleNpcs npcs

objects

public final SimpleObjects objects

bank

public final SimpleBank bank

shop

public final SimpleShop shop

players

public final SimplePlayers players

prayers

public final SimplePrayers prayers

mouse

public final SimpleMouse mouse

interfaces

@Deprecated
public final SimpleWidgets interfaces

Deprecated.

widgets

public final SimpleWidgets widgets

keyboard

public final Keyboard keyboard

magic

public final Magic magic

definitions

public final Definitions definitions

pathing

public final Pathing pathing

portalTeleports

public final PortalTeleports portalTeleports

viewport

public final Viewport viewport

dialogue

public final Dialogue dialogue

combat

public final Combat combat

trade

public final Trade trade

fairyRing

public final FairyRing fairyRing

projectiles

public final Projectiles projectiles

skills

public final SimpleSkills skills

game

public final Game game

equipment

public final SimpleEquipment equipment

user

public final ClientUser user

paint

public final ScriptPaint paint

antiBan

public final AntiBan antiBan

Constructor Detail

ClientContext

public ClientContext(net.runelite.api.Client client)

Method Detail

instance

public static ClientContext instance()

sleepCondition

public boolean sleepCondition(java.util.function.BooleanSupplier condition)

Refer to {onCondition(BooleanSupplier condition)}

sleepCondition

public boolean sleepCondition(java.util.function.BooleanSupplier condition,
                              int timeout)

Refer to {onCondition(BooleanSupplier condition, int timeout)}

onCondition

public boolean onCondition(java.util.function.BooleanSupplier condition)

Will sleep the current thread for a maximum of 5 seconds whilst checking if the {condition} has been met every 500ms's

Parameters:

condition - the condition to sleep for until it is met

Returns:

returns if the specified {condition} has been met or not within the given time constraint of 5 seconds

onCondition

public boolean onCondition(java.util.function.BooleanSupplier condition,
                           int timeout)

Will sleep the current thread for a maximum of {timeout}ms's whilst checking if the {condition} has been met every 500ms's

Parameters:

condition - the condition to sleep for until it is met

timeout - the max amount of milliseconds to wait for checking the {condition}

Returns:

returns if the specified {condition} has been met or not

onCondition

public boolean onCondition(java.util.function.BooleanSupplier condition,
                           int timeout,
                           int amount)

Will sleep the current thread for the specified {timeout} * {amount} or until the {condition} is met. This method will check if {condition} is met {amount} times every {timeout} ms's. Time bounds: Min: {timeout} Max: {timeout} * {amount}

Parameters:

condition - the condition to sleep for until it is met

timeout - the amount of milliseconds to wait before checking the {condition} again

amount - the amount of times to check if the {condition} has been met

Returns:

returns if the specified {condition} has been met or not

sleep

public void sleep(int ms)

Will sleep the current thread for {ms}ms's

Parameters:

ms - how long in milliseconds to sleep the current thread for

sleep

public void sleep(int min,
                  int max)

Will sleep the current thread for a random amount of time between {min} and {max}

Parameters:

min - minimum ms's to sleep for

max - maximum ms's to sleep for

sendLogout

public boolean sendLogout()

Will log you out if you're currently logged in

Returns:

returns if the logout is successfully or if you're already logged out

stopScript

public boolean stopScript()

Will stop the currently running script, returns {true} if it has been stopped {false} otherwise

Returns:

updateStatus

public void updateStatus(java.lang.String status)

log

public void log(java.lang.String log,
                java.lang.Object... objects)

Will print specified formatted string {log} to console and script log inside of the bot panel

Parameters:

log -

objects -

submitLogCapture

public void submitLogCapture(java.lang.String log)

Will print {log} to script log inside of the bot panel

Parameters:

log -

inFixedScreen

public boolean inFixedScreen()

bobSolver

public boolean bobSolver()

bobSolver

public boolean bobSolver(boolean state)

getPlayers

@Deprecated
public SimplePlayers getPlayers()

Deprecated.

getInventory

@Deprecated
public SimpleInventory getInventory()

Deprecated.

getNpcs

@Deprecated
public SimpleNpcs getNpcs()

Deprecated.

getObjects

@Deprecated
public SimpleObjects getObjects()

Deprecated.

getClient

public net.runelite.api.Client getClient()

getGroundItems

@Deprecated
public SimpleGroundItems getGroundItems()

Deprecated.

getMouse

@Deprecated
public SimpleMouse getMouse()

Deprecated.

getMagic

@Deprecated
public Magic getMagic()

Deprecated.

getDefinitions

@Deprecated
public Definitions getDefinitions()

Deprecated.

getBank

@Deprecated
public SimpleBank getBank()

Deprecated.

getEquipment

@Deprecated
public SimpleEquipment getEquipment()

Deprecated.

getPathing

@Deprecated
public Pathing getPathing()

Deprecated.

getPortalTeleports

@Deprecated
public PortalTeleports getPortalTeleports()

Deprecated.

getPrayer

@Deprecated
public SimplePrayers getPrayer()

Deprecated.

getInterfaces

@Deprecated
public SimpleWidgets getInterfaces()

Deprecated.

getKeyboard

@Deprecated
public Keyboard getKeyboard()

Deprecated.

getViewport

@Deprecated
public Viewport getViewport()

Deprecated.

getShop

@Deprecated
public SimpleShop getShop()

Deprecated.

getDialogue

@Deprecated
public Dialogue getDialogue()

Deprecated.

getCombat

@Deprecated
public Combat getCombat()

Deprecated.

getTrade

@Deprecated
public Trade getTrade()

Deprecated.

getFairyRing

@Deprecated
public FairyRing getFairyRing()

Deprecated.

getProjectiles

@Deprecated
public Projectiles getProjectiles()

Deprecated.