psGUIStorageMessage Class Reference

GUI Merchant Message. More...

#include <messages.h>

List of all members.

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.
	psGUIStorageMessage (uint8_t command, csString commandData)
	psGUIStorageMessage (MsgEntry *message)
	Crack this message off the network.
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string.
Public Attributes
uint8_t	command
csString	commandData

---

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

enum psGUIStorageMessage::Command

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:

clientNum	Client destination.
command	One of REQUEST, EXCHANGE, INVENTORY, OFFERING or RECEIVING
commandData	XML 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:

accessPointers

A 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:

• common/net/messages.h