MOAIParticleState Class Reference

Inherits MOAILuaObject.

Function List
	clearForces
	pushForce
	setDamping
	setInitScript
	setMass
	setNext
	setPlugin
	setRenderScript
	setTerm

Function Documentation

clearForces

Removes all particle forces from the state.

---

function clearForces ( MOAIParticleState self )

Parameters

MOAIParticleState

self

Returns

nil

pushForce

Adds a force to the state.

---

function pushForce ( MOAIParticleState self, MOAIParticleForce force )

Parameters

MOAIParticleState	self
MOAIParticleForce	force

Returns

nil

setDamping

Sets damping for particle physics model.

---

function setDamping ( MOAIParticleState self, number damping )

Parameters

MOAIParticleState	self
number	damping

Returns

nil

setInitScript

Sets the particle script to use for initializing new particles.

---

function setInitScript ( MOAIParticleState self [, MOAIParticleScript script ] )

Parameters

MOAIParticleState	self
MOAIParticleScript	script Optional.

Returns

nil

setMass

Sets range of masses (chosen randomly) for particles initialized by the state.

---

function setMass ( MOAIParticleState self, number minMass [, number maxMass ] )

Parameters

MOAIParticleState	self
number	minMass
number	maxMass Optional. Default value is minMass.

Returns

nil

setNext

Sets the next state (if any).

---

function setNext ( MOAIParticleState self [, MOAIParticleState next ] )

Parameters

MOAIParticleState	self
MOAIParticleState	next Optional. Default value is nil.

Returns

nil

setPlugin

Sets the particle plugin to use for initializing and updating particles.

---

function setPlugin ( MOAIParticleState self [, MOAIParticlePlugin plugin ] )

Parameters

MOAIParticleState	self
MOAIParticlePlugin	plugin Optional.

Returns

nil

setRenderScript

Sets the particle script to use for rendering particles.

---

function setRenderScript ( MOAIParticleState self [, MOAIParticleScript script ] )

Parameters

MOAIParticleState	self
MOAIParticleScript	script Optional.

Returns

nil

setTerm

Sets range of terms (chosen randomly) for particles initialized by the state.

---

function setTerm ( MOAIParticleState self, number minTerm [, number maxTerm ] )

Parameters

MOAIParticleState	self
number	minTerm
number	maxTerm Optional. Default value is minTerm.

Returns

nil