1. Home
  2. Docs
  3. PopcornFX v2
  4. Scripting reference
  5. effect

effect

The effect namespace contains all effect-related functions and variables.

 

Return typeDescription
booleffect.isRunning()
Returns true if the parent effect instance is still running, false if it has stopped.
This can be used to detect when the effect is stopped, and kill infinite particles, or gracefully fade them out.
floateffect.age()
Returns the age of the parent effect instance, in seconds.
float3effect.position()
Returns the position of the parent effect instance, in worldspace.
float3effect.velocity()
Returns the velocity of the parent effect instance, in worldspace.
orientationeffect.orientation()
Returns the orientation of the parent effect instance, in worldspace.
float3effect.axisSide()
Returns the side axis of the parent effect instance (left / right), in worldspace.
float3effect.axisVertical()
Returns the vertical axis of the parent effect instance (down / up), in worldspace.
float3effect.axisDepth()
Returns the depth axis of the parent effect instance (backward / forward), in worldspace.
float3effect.axisLeft()
Returns the left axis direction of the parent effect instance, in worldspace.
float3effect.axisRight()
Returns the right axis direction of the parent effect instance, in worldspace.
float3effect.axisDown()
Returns the down axis direction of the parent effect instance, in worldspace.
float3effect.axisUp()
Returns the up axis direction of the parent effect instance, in worldspace.
float3effect.axisBackward()
Returns the backward axis direction of the parent effect instance, in worldspace.
float3effect.axisForward()
Returns the forward axis direction of the parent effect instance, in worldspace.
Was this article helpful to you? Yes No

How can we help?