Effect Message. More...

#include <messages.h>

Public Member Functions
	psEffectMessage (uint32_t clientNum, const csString &effectName, const csVector3 &effectOffset, EID anchorID, EID targetID, uint32_t uid, float scale1=0.0, float scale2=0.0, float scale3=0.0, float scale4=0.0)
	Constructs a new message that will tell the client to render an effect. More...

	psEffectMessage (uint32_t clientNum, const csString &effectName, const csVector3 &effectOffset, EID anchorID, EID targetID, uint32_t duration, uint32_t uid, float scale1=0.0, float scale2=0.0, float scale3=0.0, float scale4=0.0)
	Constructs a new message that will tell the client to render a spell effect - not just a normal effect. More...

	psEffectMessage (MsgEntry *message)
	Translates a generic message to a psEffectMessage. More...

	PSF_DECLARE_MSG_FACTORY ()

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
EID	anchorID

uint32_t	duration

csString	name

csVector3	offset

float	scale [4]

EID	targetID

uint32_t	uid

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

Effect Message.

This message is used to manage any effect the server wants to send to the clients. psClientCharManager handles this clientside

Definition at line 2487 of file messages.h.

Constructor & Destructor Documentation

psEffectMessage::psEffectMessage	(	uint32_t	clientNum,
		const csString &	effectName,
		const csVector3 &	effectOffset,
		EID	anchorID,
		EID	targetID,
		uint32_t	uid,
		float	scale1 = `0.0`,
		float	scale2 = `0.0`,
		float	scale3 = `0.0`,
		float	scale4 = `0.0`
	)

Constructs a new message that will tell the client to render an effect.

Parameters

clientNum	the client to send the effect message to
effectName	the name of the effect to render
effectOffset	the offset position from the anchor point
anchorID	the ID of the entity to anchor the effect to (0 for absolute anchor)
targetID	the ID of the entity that will be the target of the effect (0 for a target the same as the anchor)
uid	Optional ID that server can use to stop a particular Effect.
scale1	Used for scalable effects.
scale2	Used for scalable effects.
scale3	Used for scalable effects.
scale4	Used for scalable effects.

psEffectMessage::psEffectMessage	(	uint32_t	clientNum,
		const csString &	effectName,
		const csVector3 &	effectOffset,
		EID	anchorID,
		EID	targetID,
		uint32_t	duration,
		uint32_t	uid,
		float	scale1 = `0.0`,
		float	scale2 = `0.0`,
		float	scale3 = `0.0`,
		float	scale4 = `0.0`
	)

Constructs a new message that will tell the client to render a spell effect - not just a normal effect.

Parameters

clientNum	the client to send the effect message to
effectName	the name of the effect to render
effectOffset	the offset position from the anchor point
anchorID	the ID of the entity to anchor the effect to (0 for absolute anchor)
targetID	the ID of the entity that will be the target of the effect (0 for a target the same as the anchor)
duration	the duration of the effect
uid	Optional ID that server can use to stop a particular Effect.
scale1	Used for scalable effects.
scale2	Used for scalable effects.
scale3	Used for scalable effects.
scale4	Used for scalable effects.

psEffectMessage::psEffectMessage ( MsgEntry * message )

Translates a generic message to a psEffectMessage.

Parameters

message the generic message to translate

Member Function Documentation

psEffectMessage::PSF_DECLARE_MSG_FACTORY ( )

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

EID psEffectMessage::anchorID

Definition at line 2541 of file messages.h.

uint32_t psEffectMessage::duration

Definition at line 2543 of file messages.h.

csString psEffectMessage::name

Definition at line 2539 of file messages.h.

csVector3 psEffectMessage::offset

Definition at line 2540 of file messages.h.

float psEffectMessage::scale[4]

Definition at line 2545 of file messages.h.

EID psEffectMessage::targetID

Definition at line 2542 of file messages.h.

uint32_t psEffectMessage::uid

Definition at line 2544 of file messages.h.

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

common/net/messages.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation