Client¶

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

EClient¶

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

Enum that represent the client type.

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

Enum that represent the client mode.

EPopoutPanel = enum(UNKNOWN, DISABLED, ENABLED);

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

Record representing the RuneScape client (Client.

function TClient.GetClient(): EClient;

Returns the client type being used.

Example:

WriteLn Client.GetClient();

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

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

You should never have to use this directly.

Example:

ShowOnTarget(Client._Bounds());

function TClient.GetPopoutPanelState(img: TImage): EPopoutPanel;
function TClient.GetPopoutPanelState(): EPopoutPanel; overload;

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

You should never have to use this directly.

Example:

WriteLn Client.GetPopoutPanelState();

property TClient.Bounds: TBox;

Dynamic client bounds to handle different client quirks.

Example:

ShowOnTarget(Client.Bounds);

function TClient.GetMode(): EMode;

Returns the client mode.

Example:

WriteLn Client.GetMode();

function TClient.ModeChanged(): Boolean;

Returns true if the client mode changed.

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

Waits time milliseconds for the client mode to change

function TClient.IsLoggedIn(): Boolean;

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

Example:

WriteLn Client.IsLoggedIn();

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

Waits time milliseconds for the players to be logged in.

Example:

WriteLn Client.WaitLoggedIn();

function TClient.ReadTooltip(): String;

Attempts to read the client tooltip if it’s present.

Example:

WriteLn Client.ReadTooltip();

Global TClient variable.