Torque Game Engine Documentation
TGE Version 1.5.2

ParticleEmitterData Class Reference

#include <particleEngine.h>

Inheritance diagram for ParticleEmitterData:


Public Member Functions
	ParticleEmitterData ()
	DECLARE_CONOBJECT (ParticleEmitterData)
void	packData (BitStream *stream)
void	unpackData (BitStream *stream)
bool	preload (bool server, char errorBuffer[256])
	Called to prepare the datablock for use, after it has been unpacked.
bool	onAdd ()
	Called when the object is added to the sim.
bool	loadParameters ()
bool	reload ()
Static Public Member Functions
static void	initPersistFields ()
	Register dynamic fields in a subclass of ConsoleObject.
Data Fields
S32	ejectionPeriodMS
	Time, in Miliseconds, between particle ejection.
S32	periodVarianceMS
	Varience in ejection peroid between 0 and n.
F32	ejectionVelocity
	Ejection velocity.
F32	velocityVariance
	Variance for velocity between 0 and n.
F32	ejectionOffset
	Z offset from emitter point to eject from.
F32	thetaMin
	Minimum angle, from the horizontal plane, to eject from.
F32	thetaMax
	Maximum angle, from the horizontal plane, to eject from.
F32	phiReferenceVel
	Reference angle, from the verticle plane, to eject from.
F32	phiVariance
	Varience from the reference angle, from 0 to n.
U32	lifetimeMS
	Lifetime of particles.
U32	lifetimeVarianceMS
	Varience in lifetime from 0 to n.
bool	overrideAdvance
bool	orientParticles
	Particles always face the screen.
bool	orientOnVelocity
	Particles face the screen at the start.
bool	useEmitterSizes
	Use emitter specified sizes instead of datablock sizes.
bool	useEmitterColors
	Use emitter specified colors instead of datablock colors.
StringTableEntry	particleString
	Used to load particle data directly from a string.
Vector< ParticleData * >	particleDataBlocks
	Datablocks for particle emissions.
Vector< U32 >	dataBlockIds
	Datablock IDs which corospond to the particleDataBlocks.
Private Types
typedef GameBaseData	Parent

Member Typedef Documentation

typedef GameBaseData ParticleEmitterData::Parent [private]

Reimplemented from GameBaseData.

Constructor & Destructor Documentation

ParticleEmitterData::ParticleEmitterData ( )

Member Function Documentation

ParticleEmitterData::DECLARE_CONOBJECT ( ParticleEmitterData )

static void ParticleEmitterData::initPersistFields ( ) [static]

See also:: addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GameBaseData.

void ParticleEmitterData::packData ( BitStream * stream ) [virtual]

Reimplemented from SimDataBlock.

void ParticleEmitterData::unpackData ( BitStream * stream ) [virtual]

Reimplemented from GameBaseData.

bool ParticleEmitterData::preload	(	bool	server,
		char	errorBuffer[256]
	)			`[virtual]`

Called to prepare the datablock for use, after it has been unpacked.

Parameters:

	server	Set if we're running on the server (and therefore don't need to load things like textures or sounds).
	errorBuffer	If an error occurs in loading, this is set to a short string describing the error.