Planeshift
psReadBookTextMessage Class Reference

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psReadBookTextMessage (uint32_t clientNum, csString &itemName, csString &bookText, bool canWrite, int slotID, int containerID, csString backgroundImg)
 
 psReadBookTextMessage (MsgEntry *me)
 Crack out the details from the message. More...
 
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

csString backgroundImg
 The image which will be shown as a background of this book. More...
 
bool canWrite
 whether or not to display the 'edit' button More...
 
int containerID
 
csString name
 
int slotID
 to identify which item this is later More...
 
csString text
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

Definition at line 4544 of file messages.h.

Constructor & Destructor Documentation

psReadBookTextMessage::psReadBookTextMessage ( uint32_t  clientNum,
csString &  itemName,
csString &  bookText,
bool  canWrite,
int  slotID,
int  containerID,
csString  backgroundImg 
)
psReadBookTextMessage::psReadBookTextMessage ( MsgEntry me)

Crack out the details from the message.

This will look at the packet and figure out if it is a single item or a container. If it is a container it will populate it's internal array of data.

Member Function Documentation

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

Converts the message into human readable string.

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

Implements psMessageCracker.

Member Data Documentation

csString psReadBookTextMessage::backgroundImg

The image which will be shown as a background of this book.

Definition at line 4573 of file messages.h.

bool psReadBookTextMessage::canWrite

whether or not to display the 'edit' button

Definition at line 4568 of file messages.h.

int psReadBookTextMessage::containerID

Definition at line 4571 of file messages.h.

csString psReadBookTextMessage::name

Definition at line 4565 of file messages.h.

int psReadBookTextMessage::slotID

to identify which item this is later

Definition at line 4570 of file messages.h.

csString psReadBookTextMessage::text

Definition at line 4566 of file messages.h.


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