Instance Variables
animation
Type
String
Initial Value
null
Description
Name of the Vfx animation to play
chain
Type
VfxStatsProps
Initial Value
null
Description
Stats for a child Vfx to generate, inheriting all of the properties of its parent by default
fadeOut
Type
Bool
Initial Value
false
Description
When true, the Vfx animation will fade out linearly from initial spawn to timeout.
flipWith
Type
Bool
Initial Value
true
Description
Whether or not to flip the effect based on the calling GameObject's horizontal scale
forceVisible
Type
Bool
Initial Value
false
Description
When true, The Vfx will be shown regardless of any optimization settings/configs
layer
Type
String
Initial Value
null
Description
Specifies the layer to render the Vfx on which can be any valid VfxLayer constant. Defaults to VfxLayer.CHARACTERS_FRONT.
loop
Type
Bool
Initial Value
false
Description
When true, the Vfx animation will loop.
physics
Type
Bool
Initial Value
false
Description
When true, the Vfx will respond to physics-related methods
relativeWith
Type
Bool
Initial Value
true
Description
Whether or not to force relative positioning of the effect against the GameObject's position
resizeWith
Type
Bool
Initial Value
true
Description
Whether or not to scale the effect with the calling GameObject's current scale
rotation
Type
Float
Initial Value
0
Description
Rotation of the Vfx in degrees
scaleX
Type
Float
Initial Value
1
Description
Horizontal scale of the Vfx
scaleY
Type
Float
Initial Value
1
Description
Vertical scale of the Vfx
shrink
Type
Bool
Initial Value
false
Description
When true, the Vfx animation will scale down linearly from initial spawn to timeout.
smoothing
Type
Bool
Initial Value
false
Description
Whether or not to enable smoothing on the Vfx Sprite
spriteContent
Type
String
Initial Value
null
Description
Content path for sprite entity of the Vfx
timeout
Type
Int
Initial Value
-1
Description
How long to wait in frames before the Vfx should be removed. This also affects how long fade out and shrink should last (default: 0 = no timeout)
x
Type
Float
Initial Value
0
Description
Absolute x position of the Vfx
y
Type
Float
Initial Value
0
Description
Absolute y position of the Vfx