terminus::GameEndedCommand Class Reference

The GameEndedCommand signals that the remote game detected a winning or losing condition. It will display a victory or defeat screen accordingly. More...

#include <gameendedcommand.h>

Inheritance diagram for terminus::GameEndedCommand:

Public Member Functions
	GameEndedCommand (Timer::TimerMSec timeStamp, bool youWin)
	GameEndedCommand (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	youWin () 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_youWin
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 GameEndedCommand signals that the remote game detected a winning or losing condition. It will display a victory or defeat screen accordingly.

Constructor & Destructor Documentation

terminus::GameEndedCommand::GameEndedCommand	(	Timer::TimerMSec	timeStamp,
		bool	youWin
	)

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

Member Function Documentation

virtual Commands terminus::GameEndedCommand::commandType ( ) const

inlineoverridevirtual

Every Command must specify its type.

Returns

enum constant from Commands

See also

Commands

Implements terminus::AbstractCommand.

void terminus::GameEndedCommand::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.

QJsonObject terminus::GameEndedCommand::toJson ( ) const

overridevirtual

Every command must define how its members can be serialized.

Returns

A QJsonObject containing the parameters / members

Implements terminus::AbstractCommand.

bool terminus::GameEndedCommand::youWin ( ) const

inline

Member Data Documentation

bool terminus::GameEndedCommand::m_youWin

protected

---

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

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