psGMGuiMessage Class Reference

Messages that are sent to the GM GUI windowManager. More...

#include <messages.h>

Classes
struct	PlayerInfo

Public Types
enum	{ TYPE_QUERYPLAYERLIST, TYPE_PLAYERLIST, TYPE_GETGMSETTINGS }

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psGMGuiMessage (uint32_t clientnum, int gmSets)
	psGMGuiMessage (uint32_t clientnum, csArray< PlayerInfo > *playerArray, int type)
	psGMGuiMessage (MsgEntry *message)
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
int	gmSettings
csArray< PlayerInfo >	players
int	type
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

Messages that are sent to the GM GUI windowManager.

Definition at line 1070 of file messages.h.

Member Enumeration Documentation

anonymous enum

Enumerator
TYPE_QUERYPLAYERLIST
TYPE_PLAYERLIST
TYPE_GETGMSETTINGS

Definition at line 1087 of file messages.h.

Constructor & Destructor Documentation

psGMGuiMessage::psGMGuiMessage	(	uint32_t	clientnum,
		int	gmSets
	)

psGMGuiMessage::psGMGuiMessage	(	uint32_t	clientnum,
		csArray< PlayerInfo > *	playerArray,
		int	type
	)

psGMGuiMessage::psGMGuiMessage

(

MsgEntry *

message

)

Member Function Documentation

psGMGuiMessage::PSF_DECLARE_MSG_FACTORY

(

)

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

int psGMGuiMessage::gmSettings

Definition at line 1083 of file messages.h.

csArray<PlayerInfo> psGMGuiMessage::players

Definition at line 1084 of file messages.h.

int psGMGuiMessage::type

Definition at line 1085 of file messages.h.

---

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

• common/net/messages.h