Tween

A lightweight tweening library for Unreal Engine.

👀 Summary

NsTween moves a value from a start to an end over time, with an easing curve. Use it from C++ with FNsTween::Play, or from Blueprint with async nodes. It suits UI motion and small game motion, such as a floating pickup, a door, or a color pulse.

NsTween does not replace UMG animations or Sequencer, and it does not replicate. Tweens run on real time, so a game pause or a time dilation does not slow them.

📦 Features

• Value types: Float, Vector, Vector 2D, Rotator, Quat, Transform, and Linear Color.
• Easing: Linear, 30 In, Out, and InOut presets from Sine to Back, a cubic Bezier ease, and a Float Curve asset.
• Repeats: Loops, ping-pong, a start delay, and a time scale.
• Callbacks: OnComplete, OnLoop, and OnPingPong in C++, and the same events on the async nodes.
• Control: Pause, resume, cancel, and test a tween by its handle.
• Owner: A tween with an owner stops when the owner is destroyed.
• Blueprint nodes: Async tween nodes for each value type, and Play ... Tween nodes that take a full spec.
• One subsystem: A game instance subsystem ticks all tweens from one core ticker.

⚙️ Requirements

• Unreal Engine 5.7+
• Windows (Win64). The module builds only for Win64.

🛠️ Installation

1. Clone or download this repository.
2. Copy the NsTween folder into the Plugins folder of your project.
3. For C++, add "NsTween" to the dependencies of your game module.
4. Generate the project files and enable the plugin.

🚀 Getting Started

In C++, FNsTween::Play returns a builder. Chain the options in the same statement. The tween starts when the builder goes out of scope.

#include "NsTween.h"

void AMyActor::BeginPlay()
{
    Super::BeginPlay();

    const FVector Start = GetActorLocation();
    FNsTween::Play(0.f, 100.f, 2.f, ENsTweenEase::InOutQuad, [this, Start](float Value)
    {
        SetActorLocation(Start + FVector(Value, 0.f, 0.f));
    })
    .SetOwner(this);
}

In Blueprint:

1. Add the Tween Float node.
2. Set Start, End, Duration Secs, and Ease Type.
3. Connect Apply Easing to the code that uses Value.
4. Connect On Complete to the code that runs at the end.

🧩 Blueprint Nodes

🔧 API

• FNsTween::Play – Make a tween from a start, an end, a duration, an ease, and an update function. A second overload takes an FNsTweenSpec and a value strategy factory.
• FNsTweenBuilder – Set the options: SetLoops, SetPingPong, SetDelay, SetTimeScale, SetCurveAsset, SetOwner, OnComplete, OnLoop, OnPingPong.
• FNsTweenBuilder control – Pause, Resume, Cancel, IsActive, GetHandle.
• FNsTweenSpec – The Blueprint struct with all the options of one tween.
• FNsTweenHandle – The id of one tween.
• ENsTweenEase – The easing presets, plus CustomBezier and CurveAsset.
• UNsTweenBlueprintLibrary – The Play ... Tween and control nodes.
• UNsTweenAsyncAction – The base class of the async tween nodes.

🚧 Limits

• Tweens use real time. The async inputs Can Tick During Pause, Use Global Time Dilation, Loop Delay, and Ping Pong Delay have no effect.
• Tweens tick only while a game world exists (Play In Editor, a game, or a game preview).
• A Rotator tween takes the shortest path, so a tween from 0 to 360 degrees does not turn.
• UNsTweenSequence holds a list of specs, but no code plays it.

🧾 Acknowledgement

NsTween takes its inspiration from Fresh Cooked Tweens by Jared Cook.

📚 Documentation

Contact

E-mail LinkedIn GitHub Bluesky