Moai SDK  2.0
MOAIParticleEmitter Class Reference
+ Inheritance diagram for MOAIParticleEmitter:

Function List

setAngle
 
setEmission
 
setMagnitude
 
setRadius
 
setRect
 
setState
 
setSystem
 
surge
 
- Function List inherited from MOAITransform
addLoc
 
addPiv
 
addRot
 
addScl
 
getLoc
 
getPiv
 
getRot
 
getScl
 
move
 
moveLoc
 
movePiv
 
moveRot
 
moveScl
 
seek
 
seekLoc
 
seekPiv
 
seekRot
 
seekScl
 
setLoc
 
setPiv
 
setRot
 
setScl
 
setShearByX
 
setShearByY
 
setShearByZ
 
- Function List inherited from MOAITransformBase
getWorldDir
 
getWorldLoc
 
getWorldRot
 
getWorldScl
 
getWorldXAxis
 
getWorldYAxis
 
getWorldZAxis
 
getWorldXNormal
 
getWorldYNormal
 
getWorldZNormal
 
modelToWorld
 
setParent
 
worldToModel
 

Additional Inherited Members

- Function List inherited from MOAINode
clearAttrLink
 
clearNodeLink
 
forceUpdate
 
getAttr
 
getAttrLink
 
getNodeState
 
moveAttr
 
scheduleUpdate
 
seekAttr
 
setAttrLink
 
setAttr
 
setNodeLink
 
- Function List inherited from MOAIInstanceEventSource
getListener
 
setListener
 
- Function List inherited from MOAIAction
addChild
 
attach
 
clear
 
defer
 
detach
 
getChildren
 
hasChildren
 
isActive
 
isBusy
 
isDone
 
isPaused
 
pause
 
setAutoStop
 
start
 
stop
 
throttle
 
update
 

Function Documentation

setAngle

Set the size and angle of the emitter.


function setAngle ( MOAIParticleEmitter self, number min, number max )

Parameters
MOAIParticleEmitterself
numbermin Minimum angle in degrees.
numbermax Maximum angle in degrees.
Returns
nil
setEmission

Set the size of each emission.


function setEmission ( MOAIParticleEmitter self, number min [, number max ] )

Parameters
MOAIParticleEmitterself
numbermin Minimum emission size.
numbermax Optional. Maximum emission size. Defaults to min.
Returns
nil
setMagnitude

Set the starting magnitude of particles deltas.


function setMagnitude ( MOAIParticleEmitter self, number min [, number max ] )

Parameters
MOAIParticleEmitterself
numbermin Minimum magnitude.
numbermax Optional. Maximum magnitude. Defaults to min.
Returns
nil
setRadius

Set the shape and radius of the emitter.


function setRadius ( MOAIParticleEmitter self, number radius )

Parameters
MOAIParticleEmitterself
numberradius
Returns
nil
Note

function setRadius ( MOAIParticleEmitter self, number innerRadius, number outerRadius )

Parameters
MOAIParticleEmitterself
numberinnerRadius
numberouterRadius
Returns
nil
Note
setRect

Set the shape and dimensions of the emitter.


function setRect ( MOAIParticleEmitter self, number xMin, number yMin, number xMax, number yMax )

Parameters
MOAIParticleEmitterself
numberxMin
numberyMin
numberxMax
numberyMax
Returns
nil
setState

Set initial state index for new particles.


function setState ( MOAIParticleEmitter self, number state )

Parameters
MOAIParticleEmitterself
numberstate index of MOAIParticleState in attached MOAIParticleSystem
Returns
nil
setSystem

Attaches the emitter to a particle system.


function setSystem ( MOAIParticleEmitter self, MOAIParticleSystem system )

Parameters
MOAIParticleEmitterself
MOAIParticleSystemsystem
Returns
nil
surge

Forces the emission of one or more particles.


function surge ( MOAIParticleEmitter self [, number total ] )

Parameters
MOAIParticleEmitterself
numbertotal Optional. Size of surge. Default value is a random emission value for emitter.
Returns
nil