org.osbot.rs07.api

Class Client

java.lang.Object

org.osbot.core.api.Wrapper<Bot,C>

org.osbot.rs07.api.RS07Wrapper<org.osbot.rs07.accessor.XClient>

org.osbot.rs07.api.Client

public class Client
extends RS07Wrapper<org.osbot.rs07.accessor.XClient>

Represents the RS2-client's main context.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.AccountType
static class	Client.GameState Represents the game state of the client.
static class	Client.LoginState Represents stages in the client's login protocol.

Field Summary

Fields inherited from class org.osbot.core.api.Wrapper

accessor

Constructor Summary

Constructors

Constructor and Description
Client(org.osbot.rs07.accessor.XClient instance)

Method Summary

Modifier and Type	Method and Description
void	cleanup() Deprecated. For internal use only
long	gameClockMs() Milliseconds elapsed since the client has started.
Client.AccountType	getAccountType() Gets the AccountType of the account
int	getCurrentTick() Gets the client's internal tick counter value.
Client.GameState	getGameState() Gets the current Client.GameState.
java.util.List<HeadMessage>	getHeadMessages(Character<?> c) Deprecated.
int[][][]	getInstanceTemplate() Gets the instance map templates
Client.LoginState	getLoginState() Gets the Client.LoginState.
int	getLoginUIState() Returns the current menu state for the login screen.
int	getMyPlayerIndex() Gets the remote index of our player context.
java.lang.String	getUsername()
java.lang.String	getVersion()
boolean	hasFocus() If the client is focused.
boolean	isHumanInputEnabled()
boolean	isLoading() Checks if the game is loading
boolean	isLoggedIn() Returns if you are currently logged in.
boolean	isMember() Checks if the logged in account is member
boolean	isResized()
boolean	isWelcomeScreenVisible()
void	onHeadMessage(Character<?> c) Deprecated.
void	wait(int ticks) Waits the specified amount of client iteration ticks .

Methods inherited from class org.osbot.rs07.api.RS07Wrapper

getClient, getMethods

Methods inherited from class org.osbot.core.api.Wrapper

equals, getBot, supplyWrappers, wrap, wrapArray

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(org.osbot.rs07.accessor.XClient instance)

Method Detail

getUsername

public java.lang.String getUsername()
                             throws java.lang.SecurityException

Returns:

The OSBot username of the currently logged-in client.

Throws:

java.lang.SecurityException

getVersion

public java.lang.String getVersion()

Returns:

The OSBot client version in format X.X.X

isHumanInputEnabled

public boolean isHumanInputEnabled()

isWelcomeScreenVisible

public boolean isWelcomeScreenVisible()

isMember

public boolean isMember()

Checks if the logged in account is member

Returns:

True if the logged in account is member

getCurrentTick

public int getCurrentTick()

Gets the client's internal tick counter value. Every cycle (tick) the client performs, this value is increased.

Returns:

The current tick counter value.

gameClockMs

public long gameClockMs()

Milliseconds elapsed since the client has started. If there is any client side lag - the clock will slow down.

isResized

public boolean isResized()

Returns:

Whether the game client is currently resized.

getInstanceTemplate

public int[][][] getInstanceTemplate()

Gets the instance map templates

Returns:

The instance map templates

getLoginState

public Client.LoginState getLoginState()

Gets the Client.LoginState.

Returns:

The Client.LoginState.

getGameState

public Client.GameState getGameState()

Gets the current Client.GameState.

Returns:

The current Client.GameState.

isLoggedIn

public boolean isLoggedIn()

Returns if you are currently logged in.

Returns:

True if logged in and not logged out or 'loading please wait...'.

isLoading

public boolean isLoading()

Checks if the game is loading

Returns:

True if the game is loading

getLoginUIState

public int getLoginUIState()

Returns the current menu state for the login screen.

Returns:

The current menu state for the login screen.

getMyPlayerIndex

public int getMyPlayerIndex()

Gets the remote index of our player context.

hasFocus

public boolean hasFocus()

If the client is focused.

Returns:

If the client is focused.

onHeadMessage

@Deprecated
public void onHeadMessage(Character<?> c)

Deprecated.

Deprecated for internal use only

getHeadMessages

@Deprecated
public java.util.List<HeadMessage> getHeadMessages(Character<?> c)

Deprecated.

Deprecated for internal use only

cleanup

@Deprecated
public void cleanup()

Deprecated. For internal use only

wait

public void wait(int ticks)
          throws java.lang.InterruptedException

Waits the specified amount of client iteration ticks .

Parameters:

ticks - The ticks to wait @see Client#getCurrentTick()

Throws:

java.lang.InterruptedException

getAccountType

public Client.AccountType getAccountType()

Gets the AccountType of the account

Returns:

The AccountType of the account