Planeshift
Public Member Functions | Public Attributes

psMGUpdateMessage Class Reference

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

#include <messages.h>

List of all members.

Public Member Functions

bool IsNewerThan (uint8_t oldCounter)
 Returns true if this message is newer than the passed sequence value.
 PSF_DECLARE_MSG_FACTORY ()
 psMGUpdateMessage (MsgEntry *me)
 psMGUpdateMessage (uint32_t client, uint8_t counter, uint32_t gameID, uint8_t numUpdates, uint8_t *updates)
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string.

Public Attributes

uint8_t msgCounter
 Message counter for versioning.
uint32_t msgGameID
 Game ID (from the action location ID)
uint8_t msgNumUpdates
 Number of updates in this message.
uint8_t * msgUpdates
 Array with updates for the game board.

Detailed Description

Message from the client with a minigame board update.

Definition at line 5683 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

Message counter for versioning.

Definition at line 5706 of file messages.h.

Game ID (from the action location ID)

Definition at line 5709 of file messages.h.

Number of updates in this message.

Definition at line 5712 of file messages.h.

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 5720 of file messages.h.


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