Planeshift
psMGUpdateMessage Class Reference

Message from the client with a minigame board update. More...

#include <messages.h>

Public Member Functions

bool IsNewerThan (uint8_t oldCounter)
 Returns true if this message is newer than the passed sequence value. More...
 
 PSF_DECLARE_MSG_FACTORY ()
 
 psMGUpdateMessage (uint32_t client, uint8_t counter, uint32_t gameID, uint8_t numUpdates, uint8_t *updates)
 
 psMGUpdateMessage (MsgEntry *me)
 
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string. More...
 
- Public Member Functions inherited from psMessageCracker
void FireEvent ()
 Publishes the message to the local program. More...
 
virtual csString GetMessageTypeName () const =0
 Gets the name of the message type. More...
 
void Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
 Multicasts the message to all current connections. More...
 
 psMessageCracker ()
 
void SendMessage ()
 Sends the message to the client/server. More...
 
virtual ~psMessageCracker ()
 

Public Attributes

uint8_t msgCounter
 Message counter for versioning. More...
 
uint32_t msgGameID
 Game ID (from the action location ID) More...
 
uint8_t msgNumUpdates
 Number of updates in this message. More...
 
uint8_t * msgUpdates
 Array with updates for the game board. More...
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Message from the client with a minigame board update.

Definition at line 5690 of file messages.h.

Constructor & Destructor Documentation

psMGUpdateMessage::psMGUpdateMessage ( uint32_t  client,
uint8_t  counter,
uint32_t  gameID,
uint8_t  numUpdates,
uint8_t *  updates 
)
psMGUpdateMessage::psMGUpdateMessage ( MsgEntry me)

Member Function Documentation

bool psMGUpdateMessage::IsNewerThan ( uint8_t  oldCounter)

Returns true if this message is newer than the passed sequence value.

psMGUpdateMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psMGUpdateMessage::ToString ( NetBase::AccessPointers accessPointers)
virtual

Converts the message into human readable string.

Parameters
accessPointersA struct to a number of access pointers
Returns
A human readable string for the message

Implements psMessageCracker.

Member Data Documentation

uint8_t psMGUpdateMessage::msgCounter

Message counter for versioning.

Definition at line 5713 of file messages.h.

uint32_t psMGUpdateMessage::msgGameID

Game ID (from the action location ID)

Definition at line 5716 of file messages.h.

uint8_t psMGUpdateMessage::msgNumUpdates

Number of updates in this message.

Definition at line 5719 of file messages.h.

uint8_t* psMGUpdateMessage::msgUpdates

Array with updates for the game board.

Updates are packed into two sequential bytes. The first byte defines the column and row, the second byte defines the game tile.

Definition at line 5727 of file messages.h.


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