Emergency 20 Dokumentation  4.2.0
em5::multiplayer::OperationMessageHandler Class Referenceabstract

EMERGENCY 5 base class for operation message handler. More...

#include <OperationMessageHandler.h>

Inheritance diagram for em5::multiplayer::OperationMessageHandler:
em5::multiplayer::FadeEntityHandler em5::multiplayer::MinimapPingHandler

Public Member Functions

 OperationMessageHandler ()
 Constructor. More...
 
virtual ~OperationMessageHandler ()
 Destructor. More...
 
virtual void writeData (int32 currentTick, qsf::game::BitStream &bitStream)=0
 Writes the stored data for the given tick into the bit stream. More...
 
virtual bool onHandleMessage (uint32 playerId, uint64 dataSize, const qsf::game::BitStream &bitStream)=0
 Gets called when a operation message (handled by this handler) is received. More...
 
virtual void applyData (int32 currentTick)=0
 Gets called when the received data should by applied. More...
 

Detailed Description

EMERGENCY 5 base class for operation message handler.

Constructor & Destructor Documentation

em5::multiplayer::OperationMessageHandler::OperationMessageHandler ( )

Constructor.

virtual em5::multiplayer::OperationMessageHandler::~OperationMessageHandler ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::multiplayer::OperationMessageHandler::applyData ( int32  currentTick)
pure virtual

Gets called when the received data should by applied.

Parameters
[in]currentTickThe tick count for which any received data should be applied

Implemented in em5::multiplayer::FadeEntityHandler, and em5::multiplayer::MinimapPingHandler.

virtual bool em5::multiplayer::OperationMessageHandler::onHandleMessage ( uint32  playerId,
uint64  dataSize,
const qsf::game::BitStream bitStream 
)
pure virtual

Gets called when a operation message (handled by this handler) is received.

Parameters
[in]playerIdThe ID of the player which has send the message
[in]dataSizeThe size (bitcount) of the message payload (content)
[in]bitStreamThe stream containing the data (the current read position of the stream points to the start of the message payload)
Returns
"true" if all went fine, else "false"

Implemented in em5::multiplayer::FadeEntityHandler, and em5::multiplayer::MinimapPingHandler.

virtual void em5::multiplayer::OperationMessageHandler::writeData ( int32  currentTick,
qsf::game::BitStream bitStream 
)
pure virtual

Writes the stored data for the given tick into the bit stream.

Parameters
[in]currentTickThe tick count for which data should be written to the bit stream
[in]bitStreamThe stream to which any changed data will be written to

Implemented in em5::multiplayer::FadeEntityHandler, and em5::multiplayer::MinimapPingHandler.


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