psGUIGuildMessage Class Reference

GUI Guild Message. More...

#include <messages.h>

Public Types
enum	Command {   SUBSCRIBE_GUILD_DATA, UNSUBSCRIBE_GUILD_DATA, SET_ONLINE, GUILD_DATA,   LEVEL_DATA, MEMBER_DATA, ALLIANCE_DATA, CLOSE_WINDOW,   NOT_IN_GUILD, SET_LEVEL_RIGHT, SET_MEMBER_POINTS, SET_MAX_GUILD_POINTS,   SET_MEMBER_PUBLIC_NOTES, SET_MEMBER_PRIVATE_NOTES, SET_GUILD_NOTIFICATION, SET_ALLIANCE_NOTIFICATION }

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psGUIGuildMessage (uint32_t command, csString commandData)
	Constuct a new Guild message to go on the network. More...
	psGUIGuildMessage (uint32_t clientNum, uint32_t command, csString commandData)
	Constuct a new Guild message to go on the network. More...
	psGUIGuildMessage (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
uint32_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 Guild Message.

This message is used to manage the player guild window. The client psGuildWindow and the server psSpellManger will deal with this messages.

Definition at line 1143 of file messages.h.

Member Enumeration Documentation

enum psGUIGuildMessage::Command

Enumerator
SUBSCRIBE_GUILD_DATA	Client asks server to send guild data (GUILD_DATA,LEVELS_DATA,MEMBERS_DATA msgs) < and also to send it when it changes.
UNSUBSCRIBE_GUILD_DATA	Client asks server not to send guild data updates any more.
SET_ONLINE	Cliens asks server to change 'onlineOnly' attribute of its subscription < server will reply with new MEMBERS_DATA message.
GUILD_DATA	Server sends client basic data about guild.
LEVEL_DATA	Server sends client data about guild levels.
MEMBER_DATA	Server sends client data about guild members.
ALLIANCE_DATA	Server sends client data about guild alliance.
CLOSE_WINDOW	server tells client to close GuildWindow
NOT_IN_GUILD	Server tells client that player is not in a guild < so the guild data cannot be sent.
SET_LEVEL_RIGHT	Clients changes right for guild level.
SET_MEMBER_POINTS	Sets the amount of guild points assigned to a member.
SET_MAX_GUILD_POINTS	Sets the maximum amount of guild points for the guild.
SET_MEMBER_PUBLIC_NOTES
SET_MEMBER_PRIVATE_NOTES
SET_GUILD_NOTIFICATION	Clients asks server to change the guild member login/logout notification setting.
SET_ALLIANCE_NOTIFICATION	Clients asks server to change the alliance member login/logout notification setting.

Definition at line 1146 of file messages.h.

Constructor & Destructor Documentation

psGUIGuildMessage::psGUIGuildMessage	(	uint32_t	command,
		csString	commandData
	)

Constuct a new Guild message to go on the network.

This will build any of the GUI exchange message needed in the guild window.

Parameters

command	One of OPEN.
commandData	XML string with command data

psGUIGuildMessage::psGUIGuildMessage	(	uint32_t	clientNum,
		uint32_t	command,
		csString	commandData
	)

Constuct a new Guild message to go on the network.

This will build any of the GUI exchange message needed in the guild window.

Parameters

clientNum	Client destination.
command	One of OPEN.
commandData	XML string with command data

psGUIGuildMessage::psGUIGuildMessage

(

MsgEntry *

message

)

Crack this message off the network.

Member Function Documentation

psGUIGuildMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psGUIGuildMessage::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

uint32_t psGUIGuildMessage::command

Definition at line 1214 of file messages.h.

csString psGUIGuildMessage::commandData

Definition at line 1215 of file messages.h.

---

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

• common/net/messages.h