script-sdk/org.tribot.script.sdk/GameState

GameState

open class GameState

Utilities for inspecting the client game state

Constructors

GameState

constructor()

Types

State

enum State

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

Functions

getFps

open fun getFps(): Int

Gets the current fps.

getHintArrowPosition

open fun getHintArrowPosition(): Optional<Tile>

Gets the tile that the hint arrow is pointing to.

getLoopCycle

open fun getLoopCycle(): Int

Gets the runescape client's current loop cycle.

getMinimapRotation

open fun getMinimapRotation(): Int

Gets the rotation of the minimap

getSelectedItemName

open fun getSelectedItemName(): String

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

getSetting

open fun getSetting(index: Int): Int

Pulls Setting value from the client with the given index.

getState

open fun getState(): GameState.State

Gets the current state of the game

getUpText

open fun getUpText(): String

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

getVarbit

open fun getVarbit(id: Int): Int

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

getVarc

open fun getVarc(index: Int): Optional<Any>

Gets the client-side variable at the specified index

getVarcInt

open fun getVarcInt(index: Int): Optional<Integer>

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

getVarcString

open fun getVarcString(index: Int): Optional<String>

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

getViewportHeight

open fun getViewportHeight(): Int

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

getViewportWidth

open fun getViewportWidth(): Int

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

isAnyItemSelected

open fun isAnyItemSelected(): Boolean

Determines if an inventory item is selected (highlighted).

isGravestoneActive

open fun isGravestoneActive(): Boolean

Checks if a gravestone is active

isInBuildingMode

open fun isInBuildingMode(): Boolean

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

isInInstance

open fun isInInstance(): Boolean

Checks if we are in an instance

isLoading

open fun isLoading(): Boolean

Checks if the game is loading the current player.