Planeshift
psMGBoardMessage Class Reference

Message from the server to setup/update the minigame board on the client side. More...

#include <messages.h>

Public Member Functions

bool IsNewerThan (uint8_t oldCounter)
 Returns true if this message recent compared to the passed sequence value. More...
 
 PSF_DECLARE_MSG_FACTORY ()
 
 psMGBoardMessage (uint32_t client, uint8_t counter, uint32_t gameID, uint16_t options, int8_t cols, int8_t rows, uint8_t *layout, uint8_t numOfPieces, uint8_t piecesSize, uint8_t *pieces)
 
 psMGBoardMessage (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

int8_t msgCols
 Number of columns. More...
 
uint8_t msgCounter
 Message counter for versioning. More...
 
uint32_t msgGameID
 Game ID (from action location ID). More...
 
uint8_t * msgLayout
 Array with the game board layout. More...
 
uint8_t msgNumOfPieces
 Number of available pieces. More...
 
uint16_t msgOptions
 Game options. More...
 
uint8_t * msgPieces
 Available pieces (both white and black). More...
 
int8_t msgRows
 Number of rows. 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 server to setup/update the minigame board on the client side.

Definition at line 5631 of file messages.h.

Constructor & Destructor Documentation

psMGBoardMessage::psMGBoardMessage ( uint32_t  client,
uint8_t  counter,
uint32_t  gameID,
uint16_t  options,
int8_t  cols,
int8_t  rows,
uint8_t *  layout,
uint8_t  numOfPieces,
uint8_t  piecesSize,
uint8_t *  pieces 
)
psMGBoardMessage::psMGBoardMessage ( MsgEntry me)

Member Function Documentation

bool psMGBoardMessage::IsNewerThan ( uint8_t  oldCounter)

Returns true if this message recent compared to the passed sequence value.

psMGBoardMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psMGBoardMessage::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

int8_t psMGBoardMessage::msgCols

Number of columns.

Definition at line 5664 of file messages.h.

uint8_t psMGBoardMessage::msgCounter

Message counter for versioning.

Definition at line 5655 of file messages.h.

uint32_t psMGBoardMessage::msgGameID

Game ID (from action location ID).

Definition at line 5658 of file messages.h.

uint8_t* psMGBoardMessage::msgLayout

Array with the game board layout.

Every byte in this array defines two game tiles. 0 - Empty 1..14 - Game pieces 15 - Disabled

Definition at line 5677 of file messages.h.

uint8_t psMGBoardMessage::msgNumOfPieces

Number of available pieces.

Definition at line 5680 of file messages.h.

uint16_t psMGBoardMessage::msgOptions

Game options.

Definition at line 5661 of file messages.h.

uint8_t* psMGBoardMessage::msgPieces

Available pieces (both white and black).

Definition at line 5683 of file messages.h.

int8_t psMGBoardMessage::msgRows

Number of rows.

Definition at line 5667 of file messages.h.


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