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.
	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.
	psEffectMessage (MsgEntry *message)
	Translates a generic message to a psEffectMessage.
	PSF_DECLARE_MSG_FACTORY ()
virtual csString	ToString (NetBase::AccessPointers *accessPointers)
	Converts the message into human readable string.
Public Attributes
EID	anchorID
uint32_t	duration
csString	name
csVector3	offset
float	scale [4]
EID	targetID
uint32_t	uid

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.