Emergency 20 Dokumentation  4.2.0
em5::multiplayer::MinimapPingHandler Class Reference

EMERGENCY 5 handler for the MINIMAP_PING operation message. More...

#include <MinimapPingHandler.h>

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

Public Member Functions

 MinimapPingHandler ()
 OperationMessage::MINIMAP_PING. More...
 
virtual ~MinimapPingHandler ()
 Destructor. More...
 
void onNewPing (const glm::vec3 &position)
 Add data about a new minimap ping to the handler. More...
 
virtual void writeData (int32 currentTick, qsf::game::BitStream &bitStream) override
 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) override
 Gets called when a operation message (handled by this handler) is received. More...
 
virtual void applyData (int32 currentTick) override
 Gets called when the received data should by applied. More...
 
- Public Member Functions inherited from em5::multiplayer::OperationMessageHandler
 OperationMessageHandler ()
 Constructor. More...
 
virtual ~OperationMessageHandler ()
 Destructor. More...
 

Static Public Attributes

static const OperationMessage HANDLER_ID
 

Detailed Description

EMERGENCY 5 handler for the MINIMAP_PING operation message.

Constructor & Destructor Documentation

em5::multiplayer::MinimapPingHandler::MinimapPingHandler ( )
virtual em5::multiplayer::MinimapPingHandler::~MinimapPingHandler ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::multiplayer::MinimapPingHandler::applyData ( int32  currentTick)
overridevirtual

Gets called when the received data should by applied.

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

Implements em5::multiplayer::OperationMessageHandler.

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

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"

Implements em5::multiplayer::OperationMessageHandler.

void em5::multiplayer::MinimapPingHandler::onNewPing ( const glm::vec3 &  position)

Add data about a new minimap ping to the handler.

virtual void em5::multiplayer::MinimapPingHandler::writeData ( int32  currentTick,
qsf::game::BitStream bitStream 
)
overridevirtual

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

Implements em5::multiplayer::OperationMessageHandler.

Member Data Documentation

const OperationMessage em5::multiplayer::MinimapPingHandler::HANDLER_ID
static

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