Planeshift
psGUIStorageMessage Class Reference

GUI Merchant Message. More...

#include <messages.h>

Public Types

enum  Command {
  REQUEST, STORAGE, CATEGORIES, CATEGORY,
  MONEY, ITEMS, WITHDRAW, STORE,
  VIEW, CANCEL
}
 

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psGUIStorageMessage (uint32_t clientNum, uint8_t command, csString commandData)
 Constuct a new equipment message to go on the network. More...
 
 psGUIStorageMessage (uint8_t command, csString commandData)
 
 psGUIStorageMessage (MsgEntry *message)
 Crack this message off the network. 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

uint8_t command
 
csString commandData
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

GUI Merchant Message.

This message is used to manage the player storage window.

Definition at line 2083 of file messages.h.

Member Enumeration Documentation

Enumerator
REQUEST 
STORAGE 
CATEGORIES 
CATEGORY 
MONEY 
ITEMS 
WITHDRAW 
STORE 
VIEW 
CANCEL 

Definition at line 2086 of file messages.h.

Constructor & Destructor Documentation

psGUIStorageMessage::psGUIStorageMessage ( uint32_t  clientNum,
uint8_t  command,
csString  commandData 
)

Constuct a new equipment message to go on the network.

This will build any of the GUI exchange message needed in a player item exchange.

Parameters
clientNumClient destination.
commandOne of REQUEST, EXCHANGE, INVENTORY, OFFERING or RECEIVING
commandDataXML string with command data
psGUIStorageMessage::psGUIStorageMessage ( uint8_t  command,
csString  commandData 
)
psGUIStorageMessage::psGUIStorageMessage ( MsgEntry message)

Crack this message off the network.

Member Function Documentation

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

uint8_t psGUIStorageMessage::command

Definition at line 2129 of file messages.h.

csString psGUIStorageMessage::commandData

Definition at line 2130 of file messages.h.


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