QuickTweenable.h

// Copyright 2025 Juan Pablo Hernandez Mosti. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Utils/EaseType.h"
#include "Utils/LoopType.h"
#include "QuickTweenable.generated.h"
 
struct FQuickTweenEvaluatePayload;
UCLASS(BlueprintType)
class QUICKTWEEN_API UQuickTweenable : public UObject
{
    GENERATED_BODY()
public:

    virtual void SetOwner(UQuickTweenable* owner);

    UFUNCTION(BlueprintCallable, Category= "Tween|Control")
    virtual void Play();

    UFUNCTION(BlueprintCallable, Category= "Tween|Control")
    virtual void Pause();

    UFUNCTION(BlueprintCallable, Category= "Tween|Control")
    virtual void Reverse();

    UFUNCTION(BlueprintCallable, Category= "Tween|Control")
    virtual void Restart();

    UFUNCTION(BlueprintCallable, Category= "Tween|Control")
    virtual void Complete(bool bSnapToEnd = true);

    UFUNCTION(BlueprintCallable, Category= "Tween|Control")
    virtual void Kill();

    virtual void Update(float deltaTime);

    virtual void Evaluate(const FQuickTweenEvaluatePayload& payload, const UQuickTweenable* instigator);

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual bool GetIsPendingKill() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual float GetLoopDuration() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual float GetTotalDuration() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual float GetElapsedTime() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual float GetTimeScale() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual bool GetIsPlaying() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual bool GetIsCompleted() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual bool GetIsReversed() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual EEaseType GetEaseType() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual UCurveFloat* GetEaseCurve() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual int32 GetLoops() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual ELoopType GetLoopType() const;

    UFUNCTION(BlueprintCallable, meta = (Keywords = "Tween"), Category = "Tween|Info")
    [[nodiscard]] virtual FString GetTweenTag() const;

    UFUNCTION(BlueprintCallable, Category= "Tween|Info")
    [[nodiscard]] virtual int32 GetCurrentLoop() const;

    UFUNCTION(BlueprintCallable, Category= "Tween|Info")
    [[nodiscard]] virtual bool GetAutoKill() const;

    UFUNCTION(BlueprintCallable, Category= "Tween|Info")
    [[nodiscard]] virtual bool GetShouldPlayWhilePaused() const;
};