effects library

Classes

ColorEffect
Change the color of a component over time.
ComponentEffect<T extends Component>
Base class for effects that target a Component of type T.
CurvedEffectController
A controller that grows non-linearly from 0 to 1 following the provided curve. The duration cannot be 0.
DelayedEffectController
An effect controller that waits for delay seconds before running the child controller. While waiting, the progress will be reported at 0.
DurationEffectController
Abstract class for an effect controller that has a predefined duration.
Effect
An Effect is a component that changes properties or appearance of another component over time.
EffectController
Base "controller" class to facilitate animation of effects.
InfiniteEffectController
Effect controller that wraps a child effect controller and repeats it infinitely.
LinearEffectController
A controller that grows linearly from 0 to 1 over duration seconds.
MoveAlongPathEffect
This effect will move the target along the specified path, which may contain curved segments, but must be simply-connected.
MoveEffect
Move a component to a new position.
NoiseEffectController
Effect controller that oscillates around 0 following a noise curve.
OpacityEffect
Change the opacity of a component over time.
PauseEffectController
A controller that keeps constant progress over duration seconds.
PositionProvider
Interface for a component that can be affected by move effects.
RandomEffectController
An EffectController that wraps another effect controller child and randomizes its duration after each reset.
RandomVariable
RandomVariable is an object capable of producing random values with the prescribed distribution function. Each distribution is implemented within its own derived class.
RemoveEffect
This simple effect, when attached to a component, will cause that component to be removed from the game tree after delay seconds.
RepeatedEffectController
Effect controller that repeats child controller a certain number of times.
ReverseCurvedEffectController
A controller that grows non-linearly from 1 to 0 following the provided curve. The duration cannot be 0.
ReverseLinearEffectController
A controller that grows linearly from 1 to 0 over duration seconds.
RotateEffect
Rotate a component around its anchor.
ScaleEffect
Scale a component.
SequenceEffect
Run multiple effects in a sequence, one after another.
SequenceEffectController
An effect controller that executes a list of other controllers one after another.
SineEffectController
This effect controller follows a sine wave.
SizeEffect
Change the size of a component over time.
SpeedEffectController
This controller can force execution of an effect at a predefined speed.
Transform2DEffect
Base class for effects that target a Transform2D property.
ZigzagEffectController
This effect controller goes from 0 to 1, then back to 0, then to -1, and then again to 0.

Mixins

EffectTarget<T>
Mixin adds field target of type T to an Effect. The target can be either set explicitly by the effect class, or acquired automatically from the effect's parent when mounting.