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

Function List

capParticles
 
capSprites
 
clearSprites
 
isIdle
 
getState
 
pushParticle
 
pushSprite
 
reserveParticles
 
reserveSprites
 
reserveStates
 
setComputeBounds
 
setDrawOrder
 
setSpriteColor
 
setSpriteDeckIdx
 
setState
 
surge
 
- Function List inherited from MOAIAction
addChild
 
attach
 
clear
 
defer
 
detach
 
getChildren
 
hasChildren
 
isActive
 
isBusy
 
isDone
 
isPaused
 
pause
 
setAutoStop
 
start
 
stop
 
throttle
 
update
 
- Function List inherited from MOAIInstanceEventSource
getListener
 
setListener
 

Function Documentation

capParticles

Controls capping vs. wrapping of particles in overflow situation. Capping will prevent emission of additional particles when system is full. Wrapping will overwrite the oldest particles with new particles.


function capParticles ( MOAIParticleSystem self [, boolean cap ] )

Parameters
MOAIParticleSystemself
booleancap Optional. Default value is true.
Returns
nil
capSprites

Controls capping vs. wrapping of sprites.


function capSprites ( MOAIParticleSystem self [, boolean cap ] )

Parameters
MOAIParticleSystemself
booleancap Optional. Default value is true.
Returns
nil
clearSprites

Flushes any existing sprites in system.


function clearSprites ( MOAIParticleSystem self )

Parameters
MOAIParticleSystemself
Returns
nil
getState

Returns a particle state for an index or nil if none exists.


function getState ( MOAIParticleSystem self, number index )

Parameters
MOAIParticleSystemself
numberindex
Returns
MOAIParticleState state
isIdle

Returns true if the current system is not currently processing any particles.


function isIdle ( MOAIParticleSystem self )

Parameters
MOAIParticleSystemself
Returns
boolean isIdle
pushParticle

Adds a particle to the system.


function pushParticle ( MOAIParticleSystem self [, number x, number y, number dx, number dy, number state ] )

Parameters
MOAIParticleSystemself
numberx Optional. Default value is 0.
numbery Optional. Default value is 0.
numberdx Optional. Default value is 0.
numberdy Optional. Default value is 0.
numberstate Optional. Index of initial particle state.
Returns
boolean result
pushSprite

Adds a sprite to the system. Sprite will persist until particle simulation is begun or 'clearSprites' is called.


function pushSprite ( MOAIParticleSystem self, number x, number y [, number rot, number xScale, number yScale ] )

Parameters
MOAIParticleSystemself
numberx
numbery
numberrot Optional. Rotation in degrees. Default value is 0.
numberxScale Optional. Default value is 1.
numberyScale Optional. Default value is 1.
Returns
boolean result
reserveParticles

Reserve particle capacity of system.


function reserveParticles ( MOAIParticleSystem self, number nParticles, number particleSize )

Parameters
MOAIParticleSystemself
numbernParticles Total number of particle records.
numberparticleSize Number of parameters reserved for the particle.
Returns
nil
reserveSprites

Reserve sprite capacity of system.


function reserveSprites ( MOAIParticleSystem self, number nSprites )

Parameters
MOAIParticleSystemself
numbernSprites
Returns
nil
reserveStates

Reserve total number of states for system.


function reserveStates ( MOAIParticleSystem self, number nStates )

Parameters
MOAIParticleSystemself
numbernStates
Returns
nil
setComputeBounds

Set the a flag controlling whether the particle system re-computes its bounds every frame.


function setComputeBounds ( MOAIParticleSystem self [, boolean computBounds ] )

Parameters
MOAIParticleSystemself
booleancomputBounds Optional. Default value is false.
Returns
nil
setDrawOrder

Set draw order of sprites in particle system.


function setDrawOrder ( MOAIParticleSystem self, number order )

Parameters
MOAIParticleSystemself
numberorder MOAIParticleSystem.ORDER_NORMAL or MOAIParticleSystem.ORDER_REVERSE
Returns
nil
setSpriteColor

Set the color of the most recently added sprite.


function setSpriteColor ( MOAIParticleSystem self, number r, number g, number b, number a )

Parameters
MOAIParticleSystemself
numberr
numberg
numberb
numbera
Returns
nil
setSpriteDeckIdx

Set the sprite's deck index.


function setSpriteDeckIdx ( MOAIParticleSystem self, number index )

Parameters
MOAIParticleSystemself
numberindex
Returns
nil
setState

Set a particle state.


function setState ( MOAIParticleSystem self, number index, MOAIParticleState state )

Parameters
MOAIParticleSystemself
numberindex
MOAIParticleStatestate
Returns
nil
surge

Release a batch emission or particles into the system.


function surge ( MOAIParticleSystem self [, number total, number x, number y, number dx, number dy ] )

Parameters
MOAIParticleSystemself
numbertotal Optional. Default value is 1.
numberx Optional. Default value is 0.
numbery Optional. Default value is 0.
numberdx Optional. Default value is 0.
numberdy Optional. Default value is 0.
Returns
nil