LuaDocs/AEmitter
From Data Realms Wiki
(AEmitter - Automatically generated by LuaBot) |
|||
| (2 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| + | |||
===Parent: [[Attachable|Attachable]]=== | ===Parent: [[Attachable|Attachable]]=== | ||
| Line 18: | Line 19: | ||
===GetThrottle=== | ===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. | + | The normalized throttle scalar which controls how to affect the emission rate as per the emisison rate range. Depricated for Lua, use the Throttle property instead.A float with the normalized throttle scalar. 1.0 means max throttle, 0 means normal, -1.0 means least emission rate. |
| + | |||
| + | ===Throttle=== | ||
| + | The normalized throttle scalar which controls how to affect the emission rate as per the emisison rate range. Depricated for Lua, use the Throttle property instead.A float with the normalized throttle scalar. 1.0 means max throttle, 0 means normal, -1.0 means least emission rate. | ||
| + | |||
| + | ===BurstSpacing=== | ||
| + | The BurstSpacing for this emitter.The BurstSpacing in ms. | ||
| + | |||
| + | ===BurstDamage=== | ||
| + | Read-only property. Returns burst damage of this emitter.Burst damage of emitter. | ||
| + | |||
| + | ===EmitDamage=== | ||
| + | Read-only property. Returns emit damage of this emitter.Emit damage of emitter. | ||
| Line 44: | Line 57: | ||
None. | None. | ||
| + | |||
| + | |||
| + | ===GetEmitVector=== | ||
| + | A vector in the direction, including the rotation of the emitter, that the emitted particles will be shot at. | ||
| + | |||
| + | '''Arguments:''' | ||
| + | |||
| + | * None. | ||
| + | |||
| + | '''Return value:''' | ||
| + | |||
| + | A unit vector. | ||
| + | |||
| + | |||
| + | ===GetRecoilVector=== | ||
| + | A vector in the opposite direction, including the rotation of the emitter, that the emitted particles will be shot at. | ||
| + | |||
| + | '''Arguments:''' | ||
| + | |||
| + | * None. | ||
| + | |||
| + | '''Return value:''' | ||
| + | |||
| + | A unit vector. | ||
| + | |||
| + | |||
| + | ===EstimateImpulse=== | ||
| + | Calculates the forces this emitter applies on any parent. | ||
| + | |||
| + | '''Arguments:''' | ||
| + | |||
| + | * Whether to calculate a burst update or not. | ||
| + | |||
| + | '''Return value:''' | ||
| + | |||
| + | The approximate impulse generated by the emitter. | ||
| Line 68: | Line 117: | ||
Whether a burst is gonna happen or not.. | Whether a burst is gonna happen or not.. | ||
| + | |||
| + | |||
| + | ===CanTriggerBurst=== | ||
| + | Checks if it is possible to trigger a one-shot burst of emissions during the next Update of this AEmitter. | ||
| + | |||
| + | '''Arguments:''' | ||
| + | |||
| + | * None. | ||
| + | |||
| + | '''Return value:''' | ||
| + | |||
| + | If it is possible to trigger a burst. | ||
[[LuaDocs/Index|'''Go back to Class Index''']] | [[LuaDocs/Index|'''Go back to Class Index''']] | ||
Latest revision as of 20:17, 2 April 2015
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. Depricated for Lua, use the Throttle property instead.A float with the normalized throttle scalar. 1.0 means max throttle, 0 means normal, -1.0 means least emission rate.
Throttle
The normalized throttle scalar which controls how to affect the emission rate as per the emisison rate range. Depricated for Lua, use the Throttle property instead.A float with the normalized throttle scalar. 1.0 means max throttle, 0 means normal, -1.0 means least emission rate.
BurstSpacing
The BurstSpacing for this emitter.The BurstSpacing in ms.
BurstDamage
Read-only property. Returns burst damage of this emitter.Burst damage of emitter.
EmitDamage
Read-only property. Returns emit damage of this emitter.Emit damage of emitter.
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.
GetEmitVector
A vector in the direction, including the rotation of the emitter, that the emitted particles will be shot at.
Arguments:
- None.
Return value:
A unit vector.
GetRecoilVector
A vector in the opposite direction, including the rotation of the emitter, that the emitted particles will be shot at.
Arguments:
- None.
Return value:
A unit vector.
EstimateImpulse
Calculates the forces this emitter applies on any parent.
Arguments:
- Whether to calculate a burst update or not.
Return value:
The approximate impulse generated by the emitter.
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..
CanTriggerBurst
Checks if it is possible to trigger a one-shot burst of emissions during the next Update of this AEmitter.
Arguments:
- None.
Return value:
If it is possible to trigger a burst.
