psGUIActiveMagicMessage Class Reference

GUI Active Magic Message. More...

#include <messages.h>

Public Types
enum	commandType { Add, Remove, List }

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psGUIActiveMagicMessage (uint32_t clientNum, csArray< ActiveSpell * > &spells, uint32_t index, csTicks serverTime)
	psGUIActiveMagicMessage (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
commandType	command
csArray< uint32 >	duration
csArray< csString >	image
uint32_t	index
csArray< csString >	name
csArray< uint32 >	registrationTime
uint32	serverTime
csArray< SPELL_TYPE >	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

GUI Active Magic Message.

This message is used to manage the active spells window. The client psActiveSpellWindow and server psProgressionManager will deal with this message.

Definition at line 3819 of file messages.h.

Member Enumeration Documentation

enum psGUIActiveMagicMessage::commandType

Enumerator
Add
Remove
List

Definition at line 3823 of file messages.h.

Constructor & Destructor Documentation

psGUIActiveMagicMessage::psGUIActiveMagicMessage ( uint32_t  clientNum, csArray< ActiveSpell * > &  spells, uint32_t  index, csTicks  serverTime  )

inline

Definition at line 3825 of file messages.h.

psGUIActiveMagicMessage::psGUIActiveMagicMessage ( MsgEntry *  message )

inline

Crack this message off the network.

Definition at line 3861 of file messages.h.

Member Function Documentation

psGUIActiveMagicMessage::PSF_DECLARE_MSG_FACTORY

(

)

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

commandType psGUIActiveMagicMessage::command

Definition at line 3901 of file messages.h.

csArray<uint32> psGUIActiveMagicMessage::duration

Definition at line 3903 of file messages.h.

csArray<csString> psGUIActiveMagicMessage::image

Definition at line 3907 of file messages.h.

uint32_t psGUIActiveMagicMessage::index

Definition at line 3900 of file messages.h.

csArray<csString> psGUIActiveMagicMessage::name

Definition at line 3906 of file messages.h.

csArray<uint32> psGUIActiveMagicMessage::registrationTime

Definition at line 3904 of file messages.h.

uint32 psGUIActiveMagicMessage::serverTime

Definition at line 3905 of file messages.h.

csArray<SPELL_TYPE> psGUIActiveMagicMessage::type

Definition at line 3902 of file messages.h.

---

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

• common/net/messages.h