MOAIParticleEmitter Class Reference

Inheritance diagram for MOAIParticleEmitter:

List of all members.

Function List
	setAngle
	setEmission
	setMagnitude
	setRadius
	setRect
	setSystem
	surge

---

Function Documentation

setAngle

Set the size and angle of the emitter.

---

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

Parameters:

self	( MOAIParticleEmitter )
min	( number ) Minimum angle in degrees.
max	( number ) Maximum angle in degrees.

Returns:

nil

setEmission

Set the size of each emission.

---

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

Parameters:

self	( MOAIParticleEmitter )
min	( number ) Minimum emission size.
max	( number ) 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:

self	( MOAIParticleEmitter )
min	( number ) Minimum magnitude.
max	( number ) Optional. Maximum magnitude. Defaults to min.

Returns:

nil

setRadius

Set the shape and radius of the emitter.

---

function setRadius ( MOAIParticleEmitter self, number radius )

Parameters:

self	( MOAIParticleEmitter )
radius	( number )

Returns:

nil

Note:

---

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

Parameters:

self	( MOAIParticleEmitter )
innerRadius	( number )
outerRadius	( number )

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:

self	( MOAIParticleEmitter )
xMin	( number )
yMin	( number )
xMax	( number )
yMax	( number )

Returns:

nil

setSystem

Attaches the emitter to a particle system.

---

function setSystem ( MOAIParticleEmitter self, MOAIParticleSystem system )

Parameters:

self	( MOAIParticleEmitter )
system	( MOAIParticleSystem )

Returns:

nil

surge

Forces the emission of one or more particles.

---

function surge ( MOAIParticleEmitter self [, number total ] )

Parameters:

self	( MOAIParticleEmitter )
total	( number ) Optional. Size of surge. Default value is a random emission value for emitter.

Returns:

nil