Main   Class List   Namespace List   Wiki

ParticleEmitterNode Class Reference
[Special Effects]

Manages timing update information for the assigned particleEmitter. Particles can be assigned to this emitter through the method setEmitterDataBlock(particleEmitterDatablock). More...

Inheritance diagram for ParticleEmitterNode:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void setActive (bool active)
 Turns the emitter on or off.
void setEmitterDataBlock (ParticleEmitterData emitterDatablock=0)
 Assigns the datablock for this emitter.

Public Attributes

bool active
 Boolean which sets and determines if this EmitterNode is active or not.
ParticleEmitterData emitter
 Particle emitter datablock to use.
float velocity
 Velocity to use when spawning the particles.

Static Public Attributes

static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.

Detailed Description

Manages timing update information for the assigned particleEmitter. Particles can be assigned to this emitter through the method setEmitterDataBlock(particleEmitterDatablock).


Member Function Documentation

void ParticleEmitterNode::setActive ( bool  active  ) 

Turns the emitter on or off.

Parameters:
active New emitter state
void ParticleEmitterNode::setEmitterDataBlock ( ParticleEmitterData  emitterDatablock = 0  ) 

Assigns the datablock for this emitter.

Parameters:
datablockID Numerical reference to datablock ID
Example:
// Get the editor's current particle emitter
%emitter = PE_EmitterEditor.currEmitter

// Assign a new datablock value
%emitter.setEmitterDatablock(%emitterDatablock);

Member Data Documentation

Boolean which sets and determines if this EmitterNode is active or not.

Particle emitter datablock to use.

Disables rendering of all instances of this type.

Reimplemented from GameBase.

Disables selection of all instances of this type.

Reimplemented from GameBase.

Velocity to use when spawning the particles.



Copyright © GarageGames, LLC. All Rights Reserved.