-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Curve Player wiki!
- Download the
Curve Playerplugin from FAB and then enable it in your project.
- If you downloaded the plugin from another source, place it in your project folder. The plugin path will look like this:
YourProject/Plugins/CurvePlayer
The plugin contains several functions:
-
Play Float Curve- Used to play a simple float curve. Double-clicking this node will open the full curve editor.
-
Play Vector Curve- Used to play the Vector curve. Double-clicking this node will open the full curve editor.
-
Play Color Curve- Used to play the Color Curve. Double-clicking this node will open the full curve editor with color selection.
-
Curve Play Speed- The speed at which the curve will play. This value should always be greater than or equal to 0. Typically, PlaySpeed can be set to 0 if you want to pause playback.
-
Curve Direction Mode- The direction of movement along the curve. If Forward, it will play from MinCurveTime to MaxCurveTime. If Backward, it will play from MaxCurveTime to MinCurveTime. MinCurveTime is always equal to the time of the very first key on the curve, and MaxCurveTime is equal to the time of the very last key.
As an example, see the image below. MinCurveTime will be equal to the first key of the red curve, and MaxCurveTime will be equal to the last key of the green curve.

-
CurveLoopMode- IfNone, the curve will be played once and will callCompletedwhen playback is complete. IfRepeat, the curve will be played infinitely from start to finish or from finish to start depending onCurveDirectionMode, andCompletedwill not be called! IfPingPong, the curve will be played back and forth infinitely, withoutCompletedbeing called. You can manually stop the curve by calling theDestroyfunction. The built-in visualizer will display how the curve will be played!
-
Started- Called immediately after the curve is created. At this point, you can perform any actions with the function. All output variables are also available! -
Update- Called every frame while the curve is playing. -
Completed- Called after the curve has finished playing. This will only work if CurveLoopMode is set to None.
-
CurvePlayer____AsyncAction- A reference to a function. Used to perform certain actions in Runtime. For example, you can get some values or prematurely destroy the curve playback
-
CurveTime- The current time on the curve. It is always between MinCurveTime and MaxCurveTime. -
CurveValue- Can be Float, Vector, or Color. The current value on the curve relative to CurveTime. -
CurveDirectionMode- Current direction of the curve. -
DeltaTime- Time elapsed since the last Update was received. During Started and Completed this value is always zero. -
DeltaValue- Changes in value since the last Update call. Used to determine how the CurveValue has changed. During Started and Completed this value is always zero.