C# quickstartC# quickstart

Install the library, create a scene with a Sprite2D, give it a texture, and attach this script as MoveAndFade.cs. Play the scene in Godot.

MoveAndFade.cs

using Godot;
using tweens.gd;

public partial class MoveAndFade : Sprite2D
{
    public override async void _Ready()
    {
        // Structured, Readable, Reusable
        var tween = new Position2DTween
        {
            To = Position + new Vector2(240, 0),
            Duration = 0.6,
            Ease = EaseType.CubicOut,
        };

        var movement = this.Tween(tween);
        if (await movement.Completion != TweenCompletionReason.Completed) return;

        // Shorthand for Convenience
        this.TweenModulateAlpha(to: 0, duration: 0.3);
    }
}

The move uses the structured style that tweens.gd is built around: a definition object keeps the property, endpoints, timing, and easing together. It reads top to bottom, and you can name it, store it in a field, and start it from as many places as you like. Change the definition once and every later start follows. The fade uses a shorthand extension method, which builds and starts a definition in one call. Use it for one-off motion; prefer definitions for anything you reuse or expect to tune.

The movement captures the current position as From. When it finishes normally, the sprite fades out. Leaving the tree cancels its playback; checking the completion reason prevents the fade from starting after cancellation.

The first tween installs one internal runner under the scene-tree root through deferred attachment. No autoload, extra script, or custom main loop is required. Start from _Ready or later on Godot’s main thread.

Keep a handle to control it

var movement = sprite.TweenPosition(new Vector2(400, 180), 0.6);
movement.Pause();
movement.Resume();
movement.Cancel();

Cancellation keeps the latest value. You can also call sprite.CancelTweens(includeChildren: true) to cancel automatic tweens owned by that node and its descendants.

Choose the next guide

• Definitions and playback explains snapshots and reuse.
• Playback and async covers sequences, parallel work, and errors.
• Node and value catalog lists typed adapters and units.
• Gallery shows combinations you can run and inspect.