psGUIGroupMessage Class Reference

GUI Group Message. More...

#include <messages.h>

Public Types
enum	Command { GROUP, MEMBERS, LEAVE }

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psGUIGroupMessage (uint32_t clientNum, uint8_t command, csString commandData)
	Constucts a new equipment message to go on the network. More...
	psGUIGroupMessage (uint8_t command, csString commandData)
	psGUIGroupMessage (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< MsgEntry >	msg
bool	valid

Additional Inherited Members
Static Public Attributes inherited from psMessageCracker
static MsgHandler *	msghandler

Detailed Description

GUI Group Message.

This message is used to manage the player group window. The client/server NPC manger will deal with these messages.

Definition at line 2140 of file messages.h.

Member Enumeration Documentation

enum psGUIGroupMessage::Command

Enumerator
GROUP
MEMBERS
LEAVE

Definition at line 2143 of file messages.h.

Constructor & Destructor Documentation

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

Constucts 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

psGUIGroupMessage::psGUIGroupMessage	(	uint8_t	command,
		csString	commandData
	)

psGUIGroupMessage::psGUIGroupMessage

(

MsgEntry *

message

)

Crack this message off the network.

Member Function Documentation

psGUIGroupMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psGUIGroupMessage::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 psGUIGroupMessage::command

Definition at line 2179 of file messages.h.

csString psGUIGroupMessage::commandData

Definition at line 2180 of file messages.h.

---

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

• common/net/messages.h