Mainscreen Namespace Reference

A namespace containing various functions related to the Mainscreen. More...

Typedefs
typedef enum Mainscreen::SCREEN_STATE	SCREEN_STATE
typedef enum Mainscreen::CROSSHAIR_STATE	CROSSHAIR_STATE

Enumerations
enum	SCREEN_STATE {   LOGIN_SCREEN , LOBBY_SCREEN , CONNECTING , LOADING ,   HOPPING , PLAYING }
enum	CROSSHAIR_STATE { NONE , YELLOW , RED }

Functions
Mainscreen::SCREEN_STATE	GetState ()
Mainscreen::CROSSHAIR_STATE	GetCrosshairState ()
bool	IsLoggedIn ()
	Returns true if the Mainscreen SCREEN_STATE is PLAYING, LOADING, or HOPPING. More...
bool	IsMoving ()
	Returns true if the player is moving. More...
bool	IsAnimating ()
	Returns true if the player is animating. More...
std::string	GetUpText ()
bool	IsUpText (const std::string &UpText)
bool	IsUpText (const std::vector< std::string > &UpTexts)
bool	UpTextContains (const std::string &UpText)
bool	UpTextContains (const std::vector< std::string > &UpTexts)
bool	UpTextContains (const std::string &UpText, std::uint32_t CheckTime, std::uint32_t FailCheckTime)
bool	UpTextContains (const std::vector< std::string > &UpTexts, std::uint32_t CheckTime, std::uint32_t FailCheckTime)
bool	WaitIsUpText (std::uint32_t Duration, std::uint32_t Step, const std::string &UpText)
bool	WaitUpTextContains (std::uint32_t Duration, std::uint32_t Step, const std::string &UpText)
bool	WaitUpTextContains (std::uint32_t Duration, std::uint32_t Step, const std::vector< std::string > &UpTexts)
bool	IsTileOn (const Tile &T)
bool	ClickTile (const Tile &T)
bool	WalkPath (const std::vector< Tile > &Path, std::int32_t Distance)
bool	WalkPath (const std::vector< Tile > &Path, std::int32_t Distance, std::function< bool()> Func)
std::vector< Box >	GetBlockingWidgetBoxes ()

Detailed Description

A namespace containing various functions related to the Mainscreen.

Typedef Documentation

CROSSHAIR_STATE

typedef enum Mainscreen::CROSSHAIR_STATE Mainscreen::CROSSHAIR_STATE

SCREEN_STATE

typedef enum Mainscreen::SCREEN_STATE Mainscreen::SCREEN_STATE

Enumeration Type Documentation

CROSSHAIR_STATE

enum Mainscreen::CROSSHAIR_STATE

Enumerator
NONE
YELLOW
RED

Definition at line 27 of file Mainscreen.hpp.

SCREEN_STATE

enum Mainscreen::SCREEN_STATE

Enumerator
LOGIN_SCREEN
LOBBY_SCREEN
CONNECTING
LOADING
HOPPING
PLAYING

Definition at line 17 of file Mainscreen.hpp.

Function Documentation

ClickTile()

bool Mainscreen::ClickTile

(

const Tile &

T

)

GetBlockingWidgetBoxes()

std::vector<Box> Mainscreen::GetBlockingWidgetBoxes

(

)

GetCrosshairState()

Mainscreen::CROSSHAIR_STATE Mainscreen::GetCrosshairState

(

)

GetState()

Mainscreen::SCREEN_STATE Mainscreen::GetState

(

)

GetUpText()

std::string Mainscreen::GetUpText

(

)

IsAnimating()

bool Mainscreen::IsAnimating

(

)

Returns true if the player is animating.

Returns

True if the player is animating

P.GetAnimationID() != -1

IsLoggedIn()

bool Mainscreen::IsLoggedIn

(

)

Returns true if the Mainscreen SCREEN_STATE is PLAYING, LOADING, or HOPPING.

Returns

True if the Mainscreen SCREEN_STATE is PLAYING, LOADING, or HOPPING

IsMoving()

bool Mainscreen::IsMoving

(

)

Returns true if the player is moving.

Returns

True if the player is moving

P.GetPoseAnimationID() != P.GetSubPoseAnimationID()

IsTileOn()

bool Mainscreen::IsTileOn

(

const Tile &

T

)

IsUpText() [1/2]

bool Mainscreen::IsUpText

(

const std::string &

UpText

)

IsUpText() [2/2]

bool Mainscreen::IsUpText

(

const std::vector< std::string > &

UpTexts

)

UpTextContains() [1/4]

bool Mainscreen::UpTextContains

(

const std::string &

UpText

)

UpTextContains() [2/4]

bool Mainscreen::UpTextContains	(	const std::string &	UpText,
		std::uint32_t	CheckTime,
		std::uint32_t	FailCheckTime
	)

UpTextContains() [3/4]

bool Mainscreen::UpTextContains

(

const std::vector< std::string > &

UpTexts

)

UpTextContains() [4/4]

bool Mainscreen::UpTextContains	(	const std::vector< std::string > &	UpTexts,
		std::uint32_t	CheckTime,
		std::uint32_t	FailCheckTime
	)

WaitIsUpText()

bool Mainscreen::WaitIsUpText	(	std::uint32_t	Duration,
		std::uint32_t	Step,
		const std::string &	UpText
	)

WaitUpTextContains() [1/2]

bool Mainscreen::WaitUpTextContains	(	std::uint32_t	Duration,
		std::uint32_t	Step,
		const std::string &	UpText
	)

WaitUpTextContains() [2/2]

bool Mainscreen::WaitUpTextContains	(	std::uint32_t	Duration,
		std::uint32_t	Step,
		const std::vector< std::string > &	UpTexts
	)

WalkPath() [1/2]

bool Mainscreen::WalkPath	(	const std::vector< Tile > &	Path,
		std::int32_t	Distance
	)

WalkPath() [2/2]

bool Mainscreen::WalkPath	(	const std::vector< Tile > &	Path,
		std::int32_t	Distance,
		std::function< bool()>	Func
	)