Skip to content

How To Use

UnBocal edited this page Mar 29, 2026 · 3 revisions

Import :

The UBTweening System is for moment only usable through scripts.

Before doing anything, you need to get the UnBocal.Tweening namespace.

using UnBocal.Tweening;


Method General Structure :

Each interpolation method is static and can be called from the UBTween class.

Here is an exemple of a translation from the current position to a target position :

// Interpolate The Transform Position From Current Position To The Target Position In 1 Second
UBTween.Position(transform, transform.position, Vector3.up, 1f);

// An Other Way Of  Doing The Same Action
UBTween.Position(transform, Vector3.up, 1f);


Controls :

To control the behavior of an interpolation you can use the controls method at the end of the instruction such as :

SetDelay(float duration) :

To add a delay before the execution of the interpolation.

// Start Interpolate After delay seconds
UBTween.Position(transform, Vector3.up, 1f)
    .SetDelay(1f);

Note that for the moment, the start position will be the position of the transform at the moment where the method is called.


SetEase(EaseType ease) :

To ease the interpolation and give it a little style. :]

// Ease The Interpolation
UBTween.Position(transform, Vector3.up, 1f)
    .SetEase(EaseType.InOutExpo);

SetCurve(AnimationCurve curve)

To ease the interpolation following a curve.

// Ease The Interpolation Based On A Curve
UBTween.Position(transform, Vector3.up, 1f)
    .SetCurve(curve);

SetLoop()

To loop the interpolation.

// Every 
UBTween.Position(transform, targetPosition, 1f)
    .SetLoop()

And you can combine them !

// Start Interpolate After delay seconds
UBTween.Position(transform, Vector3.up, 1f)
    .SetDelay(1f)
    .SetEase(EaseType.InOutExpo)


Callbacks :

You have three callbacks possible :

OnStart(UnityAction method) :

Will be called when the interpolation starts (After the delay).

UBTween.Position(transform, Vector3.up, 1f)
    .OnStart(method);

OnLoop(UnityAction method) :

Will be called at the end of every loop.

UBTween.Position(transform, Vector3.up, 1f)
    .SetLoop()
    .OnLoop(method);

OnFinished(UnityAction method) :

Will be called when the interpolation stops.

UBTween.Position(transform, Vector3.up, 1f)
    .OnFinished(method);

Clone this wiki locally