Torque3D Documentation / _generateds / ParticleEmitterData

ParticleEmitterData

Engine/source/T3D/fx/particleEmitter.h

More...

Private Types

Parent 

Public Attributes

The direction aligned particles should face.

bool

Particles always face along a particular axis.

A scalar value used to influence the effect of the ambient color on the particle.

Pre-define blend factor setting.

Datablock IDs (parellel array to particleDataBlocks)

Z offset from emitter point to eject from.

Z offset Variance from emitter point to eject.

Time, in Milliseconds, between particle ejection.

Ejection velocity.

bool
bool

Renders this emitter into the glow buffer.

bool

This particle system should not use the mixed-resolution particle rendering.

Lifetime of particles.

Varience in lifetime from 0 to n.

bool

Particles face the screen at the start.

bool

Particles always face the screen.

Used to load particle data directly from a string.

Varience in ejection peroid between 0 and n.

Reference angle, from the verticle plane, to eject from.

Varience from the reference angle, from 0 to n.

initial size of particle list calc'd from datablock info

bool

Enables this emitter to render into reflection passes.

bool

reverses draw order

bool

Particles are rendered as a continous ribbon.

For soft particles, the distance (in meters) where particles will be faded based on the difference in depth between the particle and the scene geometry.

bool

Particles are sorted back-to-front.

Emitter texture handle from txrName.

Emitter texture file to override particle textures.

Maximum angle, from the horizontal plane, to eject from.

Minimum angle, from the horizontal plane, to eject from.

Angle, from the previous particle, to eject from.

bool

Use emitter specified colors instead of datablock colors.

bool

Use emitter specified sizes instead of datablock sizes.

Variance for velocity between 0 and n.

Private Static Functions

bool
_setAlignDirection(void * object, const char * index, const char * data)

Public Functions

allocPrimBuffer(S32 overrideSize)
bool

Called when the object is added to the sim.

bool
preload(bool server, String & errorStr)

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

bool

Public Static Functions

Detailed Description

Private Types

typedef GameBaseData Parent 

Public Attributes

Point3F alignDirection 

The direction aligned particles should face.

bool alignParticles 

Particles always face along a particular axis.

F32 ambientFactor 

A scalar value used to influence the effect of the ambient color on the particle.

S32 blendStyle 

Pre-define blend factor setting.

Vector< U32 > dataBlockIds 

Datablock IDs (parellel array to particleDataBlocks)

bool ejectionInvert 
F32 ejectionOffset 

Z offset from emitter point to eject from.

F32 ejectionOffsetVariance 

Z offset Variance from emitter point to eject.

S32 ejectionPeriodMS 

Time, in Milliseconds, between particle ejection.

F32 ejectionVelocity 

Ejection velocity.

bool fade_alpha 
bool fade_color 
bool fade_size 
bool glow 

Renders this emitter into the glow buffer.

bool highResOnly 

This particle system should not use the mixed-resolution particle rendering.

S32 lifetimeMS 

Lifetime of particles.

U32 lifetimeVarianceMS 

Varience in lifetime from 0 to n.

bool orientOnVelocity 

Particles face the screen at the start.

bool orientParticles 

Particles always face the screen.

bool overrideAdvance 
Vector< ParticleData * > particleDataBlocks 

Particle Datablocks.

StringTableEntry particleString 

Used to load particle data directly from a string.

U32 partListInitSize 
U8 parts_per_eject 
S32 periodVarianceMS 

Varience in ejection peroid between 0 and n.

F32 phiReferenceVel 

Reference angle, from the verticle plane, to eject from.

F32 phiVariance 

Varience from the reference angle, from 0 to n.

GFXPrimitiveBufferHandle primBuff 

initial size of particle list calc'd from datablock info

bool renderReflection 

Enables this emitter to render into reflection passes.

bool reverseOrder 

reverses draw order

bool ribbonParticles 

Particles are rendered as a continous ribbon.

F32 softnessDistance 

For soft particles, the distance (in meters) where particles will be faded based on the difference in depth between the particle and the scene geometry.

bool sortParticles 

Particles are sorted back-to-front.

GFXTexHandle textureHandle 

Emitter texture handle from txrName.

StringTableEntry textureName 

Emitter texture file to override particle textures.

F32 thetaMax 

Maximum angle, from the horizontal plane, to eject from.

F32 thetaMin 

Minimum angle, from the horizontal plane, to eject from.

F32 thetaVariance 

Angle, from the previous particle, to eject from.

bool use_emitter_xfm 
bool useEmitterColors 

Use emitter specified colors instead of datablock colors.

bool useEmitterSizes 

Use emitter specified sizes instead of datablock sizes.

F32 velocityVariance 

Variance for velocity between 0 and n.

Private Static Functions

_setAlignDirection(void * object, const char * index, const char * data)