Planeshift
Public Member Functions | Public Attributes

psMGBoardMessage Class Reference

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

#include <messages.h>

List of all members.

Public Member Functions

bool IsNewerThan (uint8_t oldCounter)
 Returns true if this message recent compared to the passed sequence value.
 PSF_DECLARE_MSG_FACTORY ()
 psMGBoardMessage (MsgEntry *me)
 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)
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string.

Public Attributes

int8_t msgCols
 Number of columns.
uint8_t msgCounter
 Message counter for versioning.
uint32_t msgGameID
 Game ID (from action location ID).
uint8_t * msgLayout
 Array with the game board layout.
uint8_t msgNumOfPieces
 Number of available pieces.
uint16_t msgOptions
 Game options.
uint8_t * msgPieces
 Available pieces (both white and black).
int8_t msgRows
 Number of rows.

Detailed Description

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

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

Number of columns.

Definition at line 5657 of file messages.h.

Message counter for versioning.

Definition at line 5648 of file messages.h.

Game ID (from action location ID).

Definition at line 5651 of file messages.h.

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

Number of available pieces.

Definition at line 5673 of file messages.h.

Game options.

Definition at line 5654 of file messages.h.

Available pieces (both white and black).

Definition at line 5676 of file messages.h.

Number of rows.

Definition at line 5660 of file messages.h.


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