RSClient¶

Methods relating to targeting the RS client and detecting client states.

ERSClient¶

ERSClient = enum(UNKNOWN, LEGACY, RUNELITE, OFFICIAL);

Enum that represent the client type.

ERSMode = enum(UNKNOWN, FIXED, RESIZABLE_CLASSIC, RESIZABLE_MODERN);

Enum that represent the client mode.

ERSPopoutPanel = enum(UNKNOWN, DISABLED, ENABLED);

Enum that represent the state of the popout panel on the official client.

Record representing the RuneScape client (RSClient.

function TRSClient.GetClient(): ERSClient;

Returns the client type being used.

Example:

WriteLn RSClient.GetClient();

function TRSClient._Bounds(img: TImage): TBox;
function TRSClient._Bounds(): TBox; overload;

Internal helper methods to figure out the client bounds when we are on the ERSClient.OFFICIAL client.

You should never have to use this directly.

Example:

ShowOnTarget(RSClient._Bounds());

function TRSClient.GetPopoutPanelState(img: TImage): ERSPopoutPanel;
function TRSClient.GetPopoutPanelState(): ERSPopoutPanel; overload;

Internal helper methods to figure out if the “Popout” panel is open or not when we are on the ERSClient.OFFICIAL client.

You should never have to use this directly.

Example:

WriteLn RSClient.GetPopoutPanelState();

property TRSClient.Bounds: TBox;

Dynamic client bounds to handle different client quirks.

Example:

ShowOnTarget(RSClient.Bounds);

function TRSClient.GetMode(): ERSMode;

Returns the client mode.

Example:

WriteLn RSClient.GetMode();

function TRSClient.ModeChanged(): Boolean;

Returns true if the client mode changed.

function TRSClient.WaitModeChange(time: Integer = 600; interval: Integer = -1): Boolean;

Waits time milliseconds for the client mode to change

function TRSClient.IsLoggedIn(): Boolean;

Returns true/false whether there’s a player logged in or not.

Example:

WriteLn RSClient.IsLoggedIn();

function TRSClient.WaitLoggedIn(time: Integer = 2000; interval: Integer = -1): Boolean;

Waits time milliseconds for the players to be logged in.

Example:

WriteLn RSClient.WaitLoggedIn();

Global TRSClient variable.