LuaDocs/AEmitter
From Data Realms Wiki
(AEmitter - Automatically generated by LuaBot) |
|||
Line 1: | Line 1: | ||
+ | |||
===Parent: [[Attachable|Attachable]]=== | ===Parent: [[Attachable|Attachable]]=== | ||
Revision as of 22:58, 10 May 2011
Contents |
Parent: Attachable
Concrete Class. An attachable MO that creates and emits particle MO's.
Properties
ClassName
The class name of this Entity.A string with the friendly-formatted type name of this object.
BurstScale
The scale factor that will be applied to the regular spread and emission velocity to get the burst particle parameters.The scale factor.
EmitAngle
The angle of direction that the emitted particles will be shot at.A float with the angle in radians.
GetThrottle
The normalized throttle scalar which controls how to affect the emission rate as per the emisison rate range.A float with the normalized throttle scalar. 1.0 means max throttle, 0 means normal, -1.0 means least emission rate.
Functions
IsEmitting
Indicates whether this AEmitter is currently enabled and emitting.
Arguments:
- None.
Return value:
Whether it's emitting or not.
EnableEmission
Sets this AEmitter to start emitting at the set rate, or to stop.
Arguments:
- Whether to enable or disable emission.
Return value:
None.
TriggerBurst
Triggers a one-shot burst of emissions in the number that has previously been set. The burst will happen during the next Update of this AEmitter.
Arguments:
- None.
Return value:
None.
IsSetToBurst
Indicates whether this AEmitter is set to burst next update or not.
Arguments:
- None.
Return value:
Whether a burst is gonna happen or not..