HoverRace::Client::HoverScript::HudPeer Class Reference

Scripting peer for access to the HUD for a player. More...

#include <HudPeer.h>

Inheritance diagram for HoverRace::Client::HoverScript::HudPeer:

Public Member Functions
	HudPeer (Script::Core &scripting, Display::Display &display, std::weak_ptr< Display::Hud > hud)
virtual	~HudPeer ()
std::shared_ptr< Display::Chronometer >	LAddChronometer (int align, const std::string &title, std::shared_ptr< Util::Clock > clock)
std::shared_ptr< Display::Counter >	LAddCounter_V (int align, const std::string &title, double initValue)
std::shared_ptr< Display::Counter >	LAddCounter_VT (int align, const std::string &title, double initValue, double total)
template<class T >
std::shared_ptr< T >	LAddDecor (int align)
std::shared_ptr< Display::HudText >	LAddText (int align, const std::string &text)
void	LClear ()
void	LUseRaceDefault ()
Public Member Functions inherited from HoverRace::Script::Peer
	Peer (Core &scripting, const std::string &name)
	Peer (const Peer &)=delete
virtual	~Peer ()
Core &	GetScripting () const
void	LHelp ()
void	LHelp_M (const std::string &methodName)
Peer &	operator= (const Peer &)=delete

Static Public Member Functions
static void	Register (Script::Core &scripting)
	Register this peer in an environment. More...
Static Public Member Functions inherited from HoverRace::Script::Peer
static void	Register (Core &scripting)

Private Types
using	HudAlignment = Display::Hud::HudAlignment
using	SUPER = Script::Peer

Private Member Functions
HudAlignment::type	ValidateAlignment (int align)
	Convert an int into an alignment value, raising a Lua error if the the value is out of range. More...

Private Attributes
Display::Display &	display
std::weak_ptr< Display::Hud >	hud

Detailed Description

Scripting peer for access to the HUD for a player.

Author

Michael Imamura

Member Typedef Documentation

using HoverRace::Client::HoverScript::HudPeer::HudAlignment = Display::Hud::HudAlignment

private

using HoverRace::Client::HoverScript::HudPeer::SUPER = Script::Peer

private

Constructor & Destructor Documentation

HoverRace::Client::HoverScript::HudPeer::HudPeer	(	Script::Core &	scripting,
		Display::Display &	display,
		std::weak_ptr< Display::Hud >	hud
	)

virtual HoverRace::Client::HoverScript::HudPeer::~HudPeer ( )

inlinevirtual

Member Function Documentation

std::shared_ptr< Display::Chronometer > HoverRace::Client::HoverScript::HudPeer::LAddChronometer	(	int	align,
		const std::string &	title,
		std::shared_ptr< Util::Clock >	clock
	)

std::shared_ptr< Display::Counter > HoverRace::Client::HoverScript::HudPeer::LAddCounter_V	(	int	align,
		const std::string &	title,
		double	initValue
	)

std::shared_ptr< Display::Counter > HoverRace::Client::HoverScript::HudPeer::LAddCounter_VT	(	int	align,
		const std::string &	title,
		double	initValue,
		double	total
	)

template<class T >

std::shared_ptr<T> HoverRace::Client::HoverScript::HudPeer::LAddDecor ( int  align )

inline

std::shared_ptr< Display::HudText > HoverRace::Client::HoverScript::HudPeer::LAddText	(	int	align,
		const std::string &	text
	)

void HoverRace::Client::HoverScript::HudPeer::LClear

(

)

void HoverRace::Client::HoverScript::HudPeer::LUseRaceDefault

(

)

void HoverRace::Client::HoverScript::HudPeer::Register ( Script::Core &  scripting )

static

Register this peer in an environment.

Parameters

scripting

The target environment.

HudAlignment::type HoverRace::Client::HoverScript::HudPeer::ValidateAlignment ( int  align )

inlineprivate

Convert an int into an alignment value, raising a Lua error if the the value is out of range.

Parameters

align

The alignment value passed from Lua.

Returns

The HUD alignment.

Member Data Documentation

Display::Display& HoverRace::Client::HoverScript::HudPeer::display

private

std::weak_ptr<Display::Hud> HoverRace::Client::HoverScript::HudPeer::hud

private

---

The documentation for this class was generated from the following files:

• HudPeer.h
• HudPeer.cpp