#include <Fx.h>

Inheritance diagram for idEntityFx:

Public Member Functions
	CLASS_PROTOTYPE (idEntityFx)

	idEntityFx ()

virtual	~idEntityFx ()

void	Spawn (void)

void	Save (idSaveGame *savefile) const

void	Restore (idRestoreGame *savefile)

virtual void	Think ()

void	Setup (const char *fx)

void	Run (int time)

void	Start (int time)

void	Stop (void)

const int	Duration (void)

const char *	EffectName (void)

const char *	Joint (void)

const bool	Done ()

virtual void	WriteToSnapshot (idBitMsgDelta &msg) const

virtual void	ReadFromSnapshot (const idBitMsgDelta &msg)

virtual void	ClientPredictionThink (void)

Public Member Functions inherited from idEntity
	ABSTRACT_PROTOTYPE (idEntity)

	idEntity ()

	~idEntity ()

void	Spawn (void)

void	Save (idSaveGame *savefile) const

void	Restore (idRestoreGame *savefile)

const char *	GetEntityDefName (void) const

void	SetName (const char *name)

const char *	GetName (void) const

virtual void	UpdateChangeableSpawnArgs (const idDict *source)

virtual renderView_t *	GetRenderView ()

bool	CheckDormant (void)

virtual void	DormantBegin (void)

virtual void	DormantEnd (void)

bool	IsActive (void) const

void	BecomeActive (int flags)

void	BecomeInactive (int flags)

void	UpdatePVSAreas (const idVec3 &pos)

virtual void	Present (void)

virtual renderEntity_t *	GetRenderEntity (void)

virtual int	GetModelDefHandle (void)

virtual void	SetModel (const char *modelname)

void	SetSkin (const idDeclSkin *skin)

const idDeclSkin *	GetSkin (void) const

void	SetShaderParm (int parmnum, float value)

virtual void	SetColor (float red, float green, float blue)

virtual void	SetColor (const idVec3 &color)

virtual void	GetColor (idVec3 &out) const

virtual void	SetColor (const idVec4 &color)

virtual void	GetColor (idVec4 &out) const

virtual void	FreeModelDef (void)

virtual void	FreeLightDef (void)

virtual void	Hide (void)

virtual void	Show (void)

bool	IsHidden (void) const

void	UpdateVisuals (void)

void	UpdateModel (void)

void	UpdateModelTransform (void)

virtual void	ProjectOverlay (const idVec3 &origin, const idVec3 &dir, float size, const char *material)

int	GetNumPVSAreas (void)

const int *	GetPVSAreas (void)

void	ClearPVSAreas (void)

bool	PhysicsTeamInPVS (pvsHandle_t pvsHandle)

virtual bool	UpdateAnimationControllers (void)

bool	UpdateRenderEntity (renderEntity_s renderEntity, const renderView_t renderView)

virtual idAnimator *	GetAnimator (void)

virtual bool	CanPlayChatterSounds (void) const

bool	StartSound (const char soundName, const s_channelType channel, int soundShaderFlags, bool broadcast, int length)

bool	StartSoundShader (const idSoundShader shader, const s_channelType channel, int soundShaderFlags, bool broadcast, int length)

void	StopSound (const s_channelType channel, bool broadcast)

void	SetSoundVolume (float volume)

void	UpdateSound (void)

int	GetListenerId (void) const

idSoundEmitter *	GetSoundEmitter (void) const

void	FreeSoundEmitter (bool immediate)

virtual void	PreBind (void)

virtual void	PostBind (void)

virtual void	PreUnbind (void)

virtual void	PostUnbind (void)

void	JoinTeam (idEntity *teammember)

void	Bind (idEntity *master, bool orientated)

void	BindToJoint (idEntity master, const char jointname, bool orientated)

void	BindToJoint (idEntity *master, jointHandle_t jointnum, bool orientated)

void	BindToBody (idEntity *master, int bodyId, bool orientated)

void	Unbind (void)

bool	IsBound (void) const

bool	IsBoundTo (idEntity *master) const

idEntity *	GetBindMaster (void) const

jointHandle_t	GetBindJoint (void) const

int	GetBindBody (void) const

idEntity *	GetTeamMaster (void) const

idEntity *	GetNextTeamEntity (void) const

void	ConvertLocalToWorldTransform (idVec3 &offset, idMat3 &axis)

idVec3	GetLocalVector (const idVec3 &vec) const

idVec3	GetLocalCoordinates (const idVec3 &vec) const

idVec3	GetWorldVector (const idVec3 &vec) const

idVec3	GetWorldCoordinates (const idVec3 &vec) const

bool	GetMasterPosition (idVec3 &masterOrigin, idMat3 &masterAxis) const

void	GetWorldVelocities (idVec3 &linearVelocity, idVec3 &angularVelocity) const

void	SetPhysics (idPhysics *phys)

idPhysics *	GetPhysics (void) const

void	RestorePhysics (idPhysics *phys)

bool	RunPhysics (void)

void	SetOrigin (const idVec3 &org)

void	SetAxis (const idMat3 &axis)

void	SetAngles (const idAngles &ang)

bool	GetFloorPos (float max_dist, idVec3 &floorpos) const

virtual bool	GetPhysicsToVisualTransform (idVec3 &origin, idMat3 &axis)

virtual bool	GetPhysicsToSoundTransform (idVec3 &origin, idMat3 &axis)

virtual bool	Collide (const trace_t &collision, const idVec3 &velocity)

virtual void	GetImpactInfo (idEntity ent, int id, const idVec3 &point, impactInfo_t info)

virtual void	ApplyImpulse (idEntity *ent, int id, const idVec3 &point, const idVec3 &impulse)

virtual void	AddForce (idEntity *ent, int id, const idVec3 &point, const idVec3 &force)

virtual void	ActivatePhysics (idEntity *ent)

virtual bool	IsAtRest (void) const

virtual int	GetRestStartTime (void) const

virtual void	AddContactEntity (idEntity *ent)

virtual void	RemoveContactEntity (idEntity *ent)

virtual bool	CanDamage (const idVec3 &origin, idVec3 &damagePoint) const

virtual void	Damage (idEntity inflictor, idEntity attacker, const idVec3 &dir, const char *damageDefName, const float damageScale, const int location)

virtual void	AddDamageEffect (const trace_t &collision, const idVec3 &velocity, const char *damageDefName)

virtual void	DamageFeedback (idEntity victim, idEntity inflictor, int &damage)

virtual bool	Pain (idEntity inflictor, idEntity attacker, int damage, const idVec3 &dir, int location)

virtual void	Killed (idEntity inflictor, idEntity attacker, int damage, const idVec3 &dir, int location)

virtual bool	ShouldConstructScriptObjectAtSpawn (void) const

virtual idThread *	ConstructScriptObject (void)

virtual void	DeconstructScriptObject (void)

void	SetSignal (signalNum_t signalnum, idThread thread, const function_t function)

void	ClearSignal (idThread *thread, signalNum_t signalnum)

void	ClearSignalThread (signalNum_t signalnum, idThread *thread)

bool	HasSignal (signalNum_t signalnum) const

void	Signal (signalNum_t signalnum)

void	SignalEvent (idThread *thread, signalNum_t signalnum)

void	TriggerGuis (void)

bool	HandleGuiCommands (idEntity entityGui, const char cmds)

virtual bool	HandleSingleGuiCommand (idEntity entityGui, idLexer src)

void	FindTargets (void)

void	RemoveNullTargets (void)

void	ActivateTargets (idEntity *activator) const

virtual void	Teleport (const idVec3 &origin, const idAngles &angles, idEntity *destination)

bool	TouchTriggers (void) const

idCurve_Spline< idVec3 > *	GetSpline (void) const

virtual void	ShowEditingDialog (void)

virtual bool	ServerReceiveEvent (int event, int time, const idBitMsg &msg)

virtual bool	ClientReceiveEvent (int event, int time, const idBitMsg &msg)

void	WriteBindToSnapshot (idBitMsgDelta &msg) const

void	ReadBindFromSnapshot (const idBitMsgDelta &msg)

void	WriteColorToSnapshot (idBitMsgDelta &msg) const

void	ReadColorFromSnapshot (const idBitMsgDelta &msg)

void	WriteGUIToSnapshot (idBitMsgDelta &msg) const

void	ReadGUIFromSnapshot (const idBitMsgDelta &msg)

void	ServerSendEvent (int eventId, const idBitMsg *msg, bool saveEvent, int excludeClient) const

void	ClientSendEvent (int eventId, const idBitMsg *msg) const

Public Member Functions inherited from idClass
	ABSTRACT_PROTOTYPE (idClass)

void *	operator new (size_t)

void *	operator new (size_t s, int, int, char *, int)

void	operator delete (void *)

void	operator delete (void , int, int, char , int)

virtual	~idClass ()

void	Spawn (void)

void	CallSpawn (void)

bool	IsType (const idTypeInfo &c) const

const char *	GetClassname (void) const

const char *	GetSuperclass (void) const

void	FindUninitializedMemory (void)

void	Save (idSaveGame *savefile) const

void	Restore (idRestoreGame *savefile)

bool	RespondsTo (const idEventDef &ev) const

bool	PostEventMS (const idEventDef *ev, int time)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7)

bool	PostEventMS (const idEventDef *ev, int time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7, idEventArg arg8)

bool	PostEventSec (const idEventDef *ev, float time)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7)

bool	PostEventSec (const idEventDef *ev, float time, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7, idEventArg arg8)

bool	ProcessEvent (const idEventDef *ev)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7)

bool	ProcessEvent (const idEventDef *ev, idEventArg arg1, idEventArg arg2, idEventArg arg3, idEventArg arg4, idEventArg arg5, idEventArg arg6, idEventArg arg7, idEventArg arg8)

bool	ProcessEventArgPtr (const idEventDef ev, int data)

void	CancelEvents (const idEventDef *ev)

void	Event_Remove (void)

Static Public Member Functions
static idEntityFx *	StartFx (const char fx, const idVec3 useOrigin, const idMat3 useAxis, idEntity ent, bool bind)

Static Public Member Functions inherited from idEntity
static bool	ModelCallback (renderEntity_s renderEntity, const renderView_t renderView)

Static Public Member Functions inherited from idClass
static void	Init (void)

static void	Shutdown (void)

static idTypeInfo *	GetClass (const char *name)

static void	DisplayInfo_f (const idCmdArgs &args)

static void	ListClasses_f (const idCmdArgs &args)

static idClass *	CreateInstance (const char *name)

static int	GetNumTypes (void)

static int	GetTypeNumBits (void)

static idTypeInfo *	GetType (int num)

Protected Member Functions
void	Event_Trigger (idEntity *activator)

void	Event_ClearFx (void)

void	CleanUp (void)

void	CleanUpSingleAction (const idFXSingleAction &fxaction, idFXLocalAction &laction)

void	ApplyFade (const idFXSingleAction &fxaction, idFXLocalAction &laction, const int time, const int actualStart)

Protected Attributes
int	started

int	nextTriggerTime

const idDeclFX *	fxEffect

idList< idFXLocalAction >	actions

idStr	systemName

Protected Attributes inherited from idEntity
renderEntity_t	renderEntity

int	modelDefHandle

refSound_t	refSound

Additional Inherited Members
Public Types inherited from idEntity
enum	{ EVENT_STARTSOUNDSHADER, EVENT_STOPSOUNDSHADER, EVENT_MAXEVENTS }

Public Attributes inherited from idEntity
int	entityNumber

int	entityDefNumber

idLinkList< idEntity >	spawnNode

idLinkList< idEntity >	activeNode

idLinkList< idEntity >	snapshotNode

int	snapshotSequence

int	snapshotBits

idStr	name

idDict	spawnArgs

idScriptObject	scriptObject

int	thinkFlags

int	dormantStart

bool	cinematic

renderView_t *	renderView

idEntity *	cameraTarget

idList< idEntityPtr< idEntity > >	targets

int	health

struct idEntity::entityFlags_s	fl

Static Public Attributes inherited from idEntity
static const int	MAX_PVS_AREAS = 4

Detailed Description

Definition at line 54 of file Fx.h.

Constructor & Destructor Documentation

idEntityFx::idEntityFx ( )

Definition at line 581 of file Fx.cpp.

idEntityFx::~idEntityFx ( )

virtual

Definition at line 593 of file Fx.cpp.

Member Function Documentation

void idEntityFx::ApplyFade	(	const idFXSingleAction &	fxaction,
		idFXLocalAction &	laction,
		const int	time,
		const int	actualStart
	)

protected

Definition at line 312 of file Fx.cpp.

idEntityFx::CLASS_PROTOTYPE ( idEntityFx )

void idEntityFx::CleanUp ( void )

protected

Definition at line 213 of file Fx.cpp.

void idEntityFx::CleanUpSingleAction	(	const idFXSingleAction &	fxaction,
		idFXLocalAction &	laction
	)

protected

Definition at line 229 of file Fx.cpp.

void idEntityFx::ClientPredictionThink ( void )

virtual

Reimplemented from idEntity.

Definition at line 791 of file Fx.cpp.

const bool idEntityFx::Done ( )

Definition at line 300 of file Fx.cpp.

const int idEntityFx::Duration ( void )

Definition at line 277 of file Fx.cpp.

const char * idEntityFx::EffectName ( void )

Definition at line 195 of file Fx.cpp.

void idEntityFx::Event_ClearFx ( void )

protected

Definition at line 650 of file Fx.cpp.

void idEntityFx::Event_Trigger ( idEntity * activator )

protected

Definition at line 680 of file Fx.cpp.

const char * idEntityFx::Joint ( void )

Definition at line 204 of file Fx.cpp.

void idEntityFx::ReadFromSnapshot ( const idBitMsgDelta & msg )

virtual

Reimplemented from idEntity.

Definition at line 761 of file Fx.cpp.

void idEntityFx::Restore ( idRestoreGame * savefile )

Definition at line 96 of file Fx.cpp.

void idEntityFx::Run ( int time )

Definition at line 340 of file Fx.cpp.

END_CLASS void idEntityFx::Save ( idSaveGame * savefile ) const

Definition at line 56 of file Fx.cpp.

void idEntityFx::Setup ( const char * fx )

Definition at line 147 of file Fx.cpp.

void idEntityFx::Spawn ( void )

Definition at line 603 of file Fx.cpp.

void idEntityFx::Start ( int time )

Definition at line 246 of file Fx.cpp.

idEntityFx * idEntityFx::StartFx	(	const char *	fx,
		const idVec3 *	useOrigin,
		const idMat3 *	useAxis,
		idEntity *	ent,
		bool	bind
	)

static

Definition at line 716 of file Fx.cpp.

void idEntityFx::Stop ( void )

Definition at line 267 of file Fx.cpp.

void idEntityFx::Think ( void )

virtual

Reimplemented from idEntity.

Definition at line 630 of file Fx.cpp.

void idEntityFx::WriteToSnapshot ( idBitMsgDelta & msg ) const

virtual

Reimplemented from idEntity.

Definition at line 749 of file Fx.cpp.

Member Data Documentation

idList<idFXLocalAction> idEntityFx::actions

protected

Definition at line 93 of file Fx.h.

const idDeclFX* idEntityFx::fxEffect

protected

Definition at line 92 of file Fx.h.

int idEntityFx::nextTriggerTime

protected

Definition at line 91 of file Fx.h.

int idEntityFx::started

protected

Definition at line 90 of file Fx.h.

idStr idEntityFx::systemName

protected

Definition at line 94 of file Fx.h.

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

neo/d3xp/Fx.h
neo/d3xp/Fx.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation