Moai SDK
2.0
|
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 | |
|
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 ] )
MOAIParticleSystem | self |
boolean | cap Optional. Default value is true. |
|
Controls capping vs. wrapping of sprites.
function capSprites ( MOAIParticleSystem self [, boolean cap ] )
MOAIParticleSystem | self |
boolean | cap Optional. Default value is true. |
|
Flushes any existing sprites in system.
function clearSprites ( MOAIParticleSystem self )
MOAIParticleSystem | self |
|
Returns a particle state for an index or nil if none exists.
function getState ( MOAIParticleSystem self, number index )
MOAIParticleSystem | self |
number | index |
|
Returns true if the current system is not currently processing any particles.
function isIdle ( MOAIParticleSystem self )
MOAIParticleSystem | self |
|
Adds a particle to the system.
function pushParticle ( MOAIParticleSystem self [, number x, number y, number dx, number dy, number state ] )
MOAIParticleSystem | self |
number | x Optional. Default value is 0. |
number | y Optional. Default value is 0. |
number | dx Optional. Default value is 0. |
number | dy Optional. Default value is 0. |
number | state Optional. Index of initial particle state. |
|
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 ] )
MOAIParticleSystem | self |
number | x |
number | y |
number | rot Optional. Rotation in degrees. Default value is 0. |
number | xScale Optional. Default value is 1. |
number | yScale Optional. Default value is 1. |
|
Reserve particle capacity of system.
function reserveParticles ( MOAIParticleSystem self, number nParticles, number particleSize )
MOAIParticleSystem | self |
number | nParticles Total number of particle records. |
number | particleSize Number of parameters reserved for the particle. |
|
Reserve sprite capacity of system.
function reserveSprites ( MOAIParticleSystem self, number nSprites )
MOAIParticleSystem | self |
number | nSprites |
|
Reserve total number of states for system.
function reserveStates ( MOAIParticleSystem self, number nStates )
MOAIParticleSystem | self |
number | nStates |
|
Set the a flag controlling whether the particle system re-computes its bounds every frame.
function setComputeBounds ( MOAIParticleSystem self [, boolean computBounds ] )
MOAIParticleSystem | self |
boolean | computBounds Optional. Default value is false. |
|
Set draw order of sprites in particle system.
function setDrawOrder ( MOAIParticleSystem self, number order )
MOAIParticleSystem | self |
number | order MOAIParticleSystem.ORDER_NORMAL or MOAIParticleSystem.ORDER_REVERSE |
|
Set the color of the most recently added sprite.
function setSpriteColor ( MOAIParticleSystem self, number r, number g, number b, number a )
MOAIParticleSystem | self |
number | r |
number | g |
number | b |
number | a |
|
Set the sprite's deck index.
function setSpriteDeckIdx ( MOAIParticleSystem self, number index )
MOAIParticleSystem | self |
number | index |
|
Set a particle state.
function setState ( MOAIParticleSystem self, number index, MOAIParticleState state )
MOAIParticleSystem | self |
number | index |
MOAIParticleState | state |
|
Release a batch emission or particles into the system.
function surge ( MOAIParticleSystem self [, number total, number x, number y, number dx, number dy ] )
MOAIParticleSystem | self |
number | total Optional. Default value is 1. |
number | x Optional. Default value is 0. |
number | y Optional. Default value is 0. |
number | dx Optional. Default value is 0. |
number | dy Optional. Default value is 0. |