Ramp

Runs to a target value over a set duration when triggered.

Parameters

NameTypeDescription
ValueoutputFloatThe value on its way from the start to the target.
DoneoutputTriggerFires when the value arrives at the target.
TriggerTriggerStarts a run to the target.
ResetTriggerStops any run and puts the value back at the start.
FromFloatThe value before the first run, after a reset and, depending on Start From, at the start of each run.
ToFloatThe value the run ends at.
DurationFloatHow many seconds a run takes.
EasingEnumThe curve the value follows during a run.Choices: Linear, Ease In Sine, Ease Out Sine, Ease In Out Sine, Ease In Quad, Ease Out Quad, Ease In Out Quad, Ease In Cubic, Ease Out Cubic, Ease In Out Cubic, Ease In Expo, Ease Out Expo, Ease In Out Expo, Ease In Back, Ease Out Back, Ease In Out Back, Ease In Elastic, Ease Out Elastic, Ease In Out Elastic, Ease In Bounce, Ease Out Bounce, Ease In Out Bounce
Start FromEnumWhether a run starts at the From value or at wherever the value is at that moment.Choices: From Value, Current Value

Ramp is a one-shot movement. It sits at its start value until triggered, then travels to the target over the duration and stays there. Done fires the moment it arrives. Triggering again starts a new run, and a reset stops everything and puts the value back at the start.

Start From decides where a run begins. From Value always begins at the start value, so a trigger during a run makes the value jump back and start over. Current Value begins wherever the value is at that moment, so a trigger during a run just continues from there without a jump. The target can change during a run, and the run heads for wherever it is.

The easing bends the movement. Linear is a steady pace, Ease In starts slow, Ease Out ends slow, and Ease In Out does both. The Back and Elastic curves overshoot on purpose and can go past the target for a moment. The curves are the same ones Remap offers, and that page describes them in more detail.

A duration of 0 arrives at once. A typical use is fading something in on a trigger, or moving it from one place to another on a button press.

Keywords: tween, animate, fade, transition, ease, envelope, one shot