Terminus
Public Member Functions | Protected Attributes | List of all members
terminus::PauseCommand Class Reference

The PauseCommand pauses or unpauses the local game due to the remote game being paused. More...

#include <pausecommand.h>

Inheritance diagram for terminus::PauseCommand:
terminus::AbstractCommand

Public Member Functions

 PauseCommand (Timer::TimerMSec timeStamp, bool pause)
 
 PauseCommand (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 pause () 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_pause
 
- Protected Attributes inherited from terminus::AbstractCommand
Gamem_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 PauseCommand pauses or unpauses the local game due to the remote game being paused.

Constructor & Destructor Documentation

terminus::PauseCommand::PauseCommand ( Timer::TimerMSec  timeStamp,
bool  pause 
)
terminus::PauseCommand::PauseCommand ( Timer::TimerMSec  timeStamp,
QJsonObject  jsonObject 
)

Member Function Documentation

virtual Commands terminus::PauseCommand::commandType ( ) const
inlineoverridevirtual

Every Command must specify its type.

Returns
enum constant from Commands
See also
Commands

Implements terminus::AbstractCommand.

void terminus::PauseCommand::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::PauseCommand::pause ( ) const
inline
QJsonObject terminus::PauseCommand::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::PauseCommand::m_pause
protected

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