GameState

public class GameState

Utilities for inspecting the client game state

Types

State

public enum State

A current state of the game, such as loading, at login screen, or logged in.

Functions

getFps

static int getFps()

Gets the current fps.

getHintArrowPosition

static Optional<LocalTile> getHintArrowPosition()

Gets the tile that the hint arrow is pointing to.

getLoopCycle

static int getLoopCycle()

Gets the runescape client's current loop cycle.

getMinimapRotation

static int getMinimapRotation()

Gets the rotation of the minimap

getSelectedItemName

static String getSelectedItemName()

Gets the name of the selected item if there is one.

getSetting

static int getSetting(int index)

Pulls Setting value from the client with the given index.

getState

static GameState.State getState()

Gets the current state of the game

getUpText

static String getUpText()

Gets the game's "uptext" that appears in the top left corner of the screen.

getVarbit

static int getVarbit(int id)

Pulls org.tribot.script.sdk.VarBit value from the client with the given varbit ID.

getVarc

static Optional<Object> getVarc(int index)

Gets the client-side variable at the specified index

getVarcInt

static Optional<Integer> getVarcInt(int index)

Gets the client-side variable at the specified index as an int

getVarcString

static Optional<String> getVarcString(int index)

Gets the client-side variable at the specified index as a string

getViewportHeight

static int getViewportHeight()

Determines the height of the viewport (OSRS scene render).

getViewportWidth

static int getViewportWidth()

Determines the width of the viewport (OSRS scene render).

isAnyItemSelected

static boolean isAnyItemSelected()

Determines if an inventory item is selected (highlighted).

isGravestoneActive

static boolean isGravestoneActive()

Checks if a gravestone is active

isInBuildingMode

static boolean isInBuildingMode()

Determines if the game is in "building mode", which can be toggled when in your own Player Owned House.

isInInstance

static boolean isInInstance()

Checks if we are in an instance

isLoading

static boolean isLoading()

Checks if the game is loading the current player.