terminus::PrepareNewGameCommand Class Reference

The PrepareNewGameCommand is sent to the client when a multiplayer session begins to synchronize the game timer, terrain seed and client player position (left or right track) More...

#include <preparenewgamecommand.h>

Inheritance diagram for terminus::PrepareNewGameCommand:

Public Member Functions
	PrepareNewGameCommand (Timer::TimerMSec timeStamp, bool isPlayerOne, unsigned int terrainSeed)
	PrepareNewGameCommand (Timer::TimerMSec timeStamp, QJsonObject jsonObject)
virtual QJsonObject	toJson () const override
	Every command must define how its members can be serialized. More...
virtual void	doWork () override
	Every Commands must define its effects on the receiving game. More...
virtual Commands	commandType () const override
	Every Command must specify its type. More...
bool	isPlayerOne () const
unsigned int	terrainSeed () const
Public Member Functions inherited from terminus::AbstractCommand
	AbstractCommand (Timer::TimerMSec timeStamp)
virtual	~AbstractCommand ()
void	setGame (Game *game)
	set the game instance this command should operate on More...
Timer::TimerMSec	timeStamp () const
	get the time as counted by the sending game that this command was created and sent More...

Protected Attributes
bool	m_isPlayerOne
unsigned int	m_terrainSeed
Protected Attributes inherited from terminus::AbstractCommand
Game *	m_game
Timer::TimerMSec	m_timeStamp

Additional Inherited Members
Static Protected Member Functions inherited from terminus::AbstractCommand
static QJsonObject	VectorToJsonObject (QVector3D vector)
static QVector3D	VectorFromJsonObject (QJsonObject jsonObject)

Detailed Description

The PrepareNewGameCommand is sent to the client when a multiplayer session begins to synchronize the game timer, terrain seed and client player position (left or right track)

Constructor & Destructor Documentation

terminus::PrepareNewGameCommand::PrepareNewGameCommand	(	Timer::TimerMSec	timeStamp,
		bool	isPlayerOne,
		unsigned int	terrainSeed
	)

terminus::PrepareNewGameCommand::PrepareNewGameCommand	(	Timer::TimerMSec	timeStamp,
		QJsonObject	jsonObject
	)

Member Function Documentation

Commands terminus::PrepareNewGameCommand::commandType ( ) const

overridevirtual

Every Command must specify its type.

Returns

enum constant from Commands

See also

Commands

Implements terminus::AbstractCommand.

void terminus::PrepareNewGameCommand::doWork ( )

overridevirtual

Every Commands must define its effects on the receiving game.

This Method is guaranteed to be executed in the receiving game's frame update context with a valid Game instance in m_game

Implements terminus::AbstractCommand.

bool terminus::PrepareNewGameCommand::isPlayerOne

(

)

const

unsigned int terminus::PrepareNewGameCommand::terrainSeed

(

)

const

QJsonObject terminus::PrepareNewGameCommand::toJson ( ) const

overridevirtual

Every command must define how its members can be serialized.

Returns

A QJsonObject containing the parameters / members

Implements terminus::AbstractCommand.

Member Data Documentation

bool terminus::PrepareNewGameCommand::m_isPlayerOne

protected

unsigned int terminus::PrepareNewGameCommand::m_terrainSeed

protected

---

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

• source/network/commands/preparenewgamecommand.h
• source/network/commands/preparenewgamecommand.cpp