Login Namespace Reference

Typedefs
typedef enum Login::LOGIN_SCREEN_STATE	LOGIN_SCREEN_STATE

Enumerations
enum	LOGIN_SCREEN_STATE {   WELCOME_SCREEN , PVP_WORLD , ENTER_CREDENTIALS , INVALID_CREDENTIALS ,   AUTHENTICATOR , FORGOTTEN_PASSWORD , RUNESCAPE_UPDATED , ACCOUNT_LOCKED ,   MEMBERS_AREA , MEMBERS_REQUIRED , WORLD_SELECT , ACCOUNT_DISABLED ,   ACCOUNT_LOGGED_IN , TOTAL_SKILL_REQUIRED , DISCONNECTED , ERROR_CONNECTING ,   CONNECTION_TIMED_OUT , TOO_MANY_ATTEMPTS , CONNECTING , LOADING ,   LOBBY_SCREEN , LOGGED_IN }

Functions
LOGIN_SCREEN_STATE	GetLoginScreenState ()
bool	LoginPlayer (bool SwitchToProfileWorld=true)
bool	EnterCredentials ()
bool	IsWorldSelectOpen ()
bool	OpenWorldSelect ()
bool	CloseWorldSelect ()
bool	SelectWorld ()
bool	SelectWorld (const Internal::World &World)
bool	SelectWorld (std::int32_t WorldID)
std::int32_t	GetScreenX ()
std::int32_t	GetWindowX ()
std::int32_t	GetCaretState ()
std::vector< std::string >	GetLoginMessages ()
std::vector< Box >	GetButtonBoxes ()
bool	WaitLoginScreenState (std::uint32_t Duration, std::uint32_t Step, Login::LOGIN_SCREEN_STATE State, bool Result=true)

Typedef Documentation

LOGIN_SCREEN_STATE

typedef enum Login::LOGIN_SCREEN_STATE Login::LOGIN_SCREEN_STATE

Enumeration Type Documentation

LOGIN_SCREEN_STATE

enum Login::LOGIN_SCREEN_STATE

Enumerator
WELCOME_SCREEN
PVP_WORLD
ENTER_CREDENTIALS
INVALID_CREDENTIALS
AUTHENTICATOR
FORGOTTEN_PASSWORD
RUNESCAPE_UPDATED
ACCOUNT_LOCKED
MEMBERS_AREA
MEMBERS_REQUIRED
WORLD_SELECT
ACCOUNT_DISABLED
ACCOUNT_LOGGED_IN
TOTAL_SKILL_REQUIRED
DISCONNECTED
ERROR_CONNECTING
CONNECTION_TIMED_OUT
TOO_MANY_ATTEMPTS
CONNECTING
LOADING
LOBBY_SCREEN
LOGGED_IN

Definition at line 13 of file Login.hpp.

Function Documentation

CloseWorldSelect()

bool Login::CloseWorldSelect

(

)

EnterCredentials()

bool Login::EnterCredentials

(

)

GetButtonBoxes()

std::vector<Box> Login::GetButtonBoxes

(

)

Returns

a vector of button boxes on the login screen 0: Existing User; 1: Login; 2: Cancel; 3: Try Again; 4: World Select; 5: World Select Cancel;

GetCaretState()

std::int32_t Login::GetCaretState

(

)

Returns

current state of the login caret 0: Username line; 1: Password line;

GetLoginMessages()

std::vector<std::string> Login::GetLoginMessages

(

)

Returns

a vector of login messages 0: LoginMessage0; 1: LoginMessage1; 2: LoginMessage2;

GetLoginScreenState()

LOGIN_SCREEN_STATE Login::GetLoginScreenState

(

)

GetScreenX()

std::int32_t Login::GetScreenX

(

)

Returns

X of where the login screen starts

GetWindowX()

std::int32_t Login::GetWindowX

(

)

Returns

X of where the login window starts

IsWorldSelectOpen()

bool Login::IsWorldSelectOpen

(

)

LoginPlayer()

bool Login::LoginPlayer

(

bool

SwitchToProfileWorld = true

)

OpenWorldSelect()

bool Login::OpenWorldSelect

(

)

SelectWorld() [1/3]

bool Login::SelectWorld

(

)

SelectWorld() [2/3]

bool Login::SelectWorld

(

const Internal::World &

World

)

SelectWorld() [3/3]

bool Login::SelectWorld

(

std::int32_t

WorldID

)

WaitLoginScreenState()

bool Login::WaitLoginScreenState	(	std::uint32_t	Duration,
		std::uint32_t	Step,
		Login::LOGIN_SCREEN_STATE	State,
		bool	Result = true
	)