HoverRace::Client::HoverScript::GamePeer Class Reference

Scripting peer for system-level control of the game. More...

#include <GamePeer.h>

Inheritance diagram for HoverRace::Client::HoverScript::GamePeer:

Public Member Functions
	GamePeer (Script::Core &scripting, GameDirector &director, RulebookLibrary &rulebookLibrary)
virtual	~GamePeer ()
void	LAddLocalPlayer ()
void	LAddLocalPlayer_N (const std::string &name)
void	LAnnounce (const std::string &label)
void	LAnnounce_T (const std::string &label, const std::string &text)
ConfigPeer *	LGetConfig ()
bool	LIsInitialized ()
void	LOnInit (const luabind::object &fn)
void	LOnInit_N (const std::string &name, const luabind::object &fn)
void	LOnSessionBegin (const luabind::object &fn)
void	LOnSessionBegin_N (const std::string &name, const luabind::object &fn)
void	LOnSessionEnd (const luabind::object &fn)
void	LOnSessionEnd_N (const std::string &name, const luabind::object &fn)
void	LOnShutdown (const luabind::object &fn)
void	LOnShutdown_N (const std::string &name, const luabind::object &fn)
void	LScreenshot ()
void	LShutdown ()
void	LStartMenuMenu ()
void	LStartPractice (const std::string &track)
void	LStartPractice_O (const std::string &track, const luabind::object &opts)
void	LStartPractice_RO (const std::string &track, const std::string &rulebookName, const luabind::object &opts)
bool	LToggleHud ()
void	OnInit ()
	Executes all "on_init" handlers. More...
void	OnSessionEnd (std::shared_ptr< SessionPeer > sessionPeer)
	Executes all "on_session_end" handlers. More...
void	OnSessionStart (std::shared_ptr< SessionPeer > sessionPeer)
	Executes all "on_session_start" handlers. More...
void	OnShutdown ()
	Executes all "on_shutdown" handlers. More...
void	SetDisplay (Display::Display *display)
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)

Protected Member Functions
void	VerifyInitialized () const

Private Types
using	SUPER = Script::Peer

Private Attributes
GameDirector &	director
Display::Display *	display
bool	initialized
Script::Handlers	onInit
Script::Handlers	onSessionEnd
Script::Handlers	onSessionStart
Script::Handlers	onShutdown
RulebookLibrary &	rulebookLibrary

Detailed Description

Scripting peer for system-level control of the game.

Author

Michael Imamura

Member Typedef Documentation

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

private

Constructor & Destructor Documentation

HoverRace::Client::HoverScript::GamePeer::GamePeer	(	Script::Core &	scripting,
		GameDirector &	director,
		RulebookLibrary &	rulebookLibrary
	)

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

inlinevirtual

Member Function Documentation

void HoverRace::Client::HoverScript::GamePeer::LAddLocalPlayer

(

)

void HoverRace::Client::HoverScript::GamePeer::LAddLocalPlayer_N

(

const std::string &

name

)

void HoverRace::Client::HoverScript::GamePeer::LAnnounce

(

const std::string &

label

)

void HoverRace::Client::HoverScript::GamePeer::LAnnounce_T	(	const std::string &	label,
		const std::string &	text
	)

ConfigPeer * HoverRace::Client::HoverScript::GamePeer::LGetConfig

(

)

bool HoverRace::Client::HoverScript::GamePeer::LIsInitialized

(

)

void HoverRace::Client::HoverScript::GamePeer::LOnInit

(

const luabind::object &

fn

)

void HoverRace::Client::HoverScript::GamePeer::LOnInit_N	(	const std::string &	name,
		const luabind::object &	fn
	)

void HoverRace::Client::HoverScript::GamePeer::LOnSessionBegin

(

const luabind::object &

fn

)

void HoverRace::Client::HoverScript::GamePeer::LOnSessionBegin_N	(	const std::string &	name,
		const luabind::object &	fn
	)

void HoverRace::Client::HoverScript::GamePeer::LOnSessionEnd

(

const luabind::object &

fn

)

void HoverRace::Client::HoverScript::GamePeer::LOnSessionEnd_N	(	const std::string &	name,
		const luabind::object &	fn
	)

void HoverRace::Client::HoverScript::GamePeer::LOnShutdown

(

const luabind::object &

fn

)

void HoverRace::Client::HoverScript::GamePeer::LOnShutdown_N	(	const std::string &	name,
		const luabind::object &	fn
	)

void HoverRace::Client::HoverScript::GamePeer::LScreenshot

(

)

void HoverRace::Client::HoverScript::GamePeer::LShutdown

(

)

void HoverRace::Client::HoverScript::GamePeer::LStartMenuMenu

(

)

void HoverRace::Client::HoverScript::GamePeer::LStartPractice

(

const std::string &

track

)

void HoverRace::Client::HoverScript::GamePeer::LStartPractice_O	(	const std::string &	track,
		const luabind::object &	opts
	)

void HoverRace::Client::HoverScript::GamePeer::LStartPractice_RO	(	const std::string &	track,
		const std::string &	rulebookName,
		const luabind::object &	opts
	)

bool HoverRace::Client::HoverScript::GamePeer::LToggleHud

(

)

void HoverRace::Client::HoverScript::GamePeer::OnInit

(

)

Executes all "on_init" handlers.

This should be called just after the main game window is visible.

void HoverRace::Client::HoverScript::GamePeer::OnSessionEnd

(

std::shared_ptr< SessionPeer >

sessionPeer

)

Executes all "on_session_end" handlers.

This is called at the end of every session, before the game thread is shut down.

Parameters

sessionPeer

The session peer.

void HoverRace::Client::HoverScript::GamePeer::OnSessionStart

(

std::shared_ptr< SessionPeer >

sessionPeer

)

Executes all "on_session_start" handlers.

This should be called at the start of every session, after the track script has been executed.

Parameters

sessionPeer

The session peer.

void HoverRace::Client::HoverScript::GamePeer::OnShutdown

(

)

Executes all "on_shutdown" handlers.

This is called just before the game window closes.

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

static

Register this peer in an environment.

Parameters

scripting

The target environment.

void HoverRace::Client::HoverScript::GamePeer::SetDisplay ( Display::Display *  display )

inline

void HoverRace::Client::HoverScript::GamePeer::VerifyInitialized ( ) const

protected

Member Data Documentation

GameDirector& HoverRace::Client::HoverScript::GamePeer::director

private

Display::Display* HoverRace::Client::HoverScript::GamePeer::display

private

bool HoverRace::Client::HoverScript::GamePeer::initialized

private

Script::Handlers HoverRace::Client::HoverScript::GamePeer::onInit

private

Script::Handlers HoverRace::Client::HoverScript::GamePeer::onSessionEnd

private

Script::Handlers HoverRace::Client::HoverScript::GamePeer::onSessionStart

private

Script::Handlers HoverRace::Client::HoverScript::GamePeer::onShutdown

private

RulebookLibrary& HoverRace::Client::HoverScript::GamePeer::rulebookLibrary

private

---

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

• GamePeer.h
• GamePeer.cpp