QuickTween 1.3
Loading...
Searching...
No Matches
UQuickTweenLibrary Class Reference

#include <QuickTweenLibrary.h>

Inheritance diagram for UQuickTweenLibrary:

Static Public Member Functions

static UQuickTweenSequenceQuickTweenCreateSequence (UObject *worldContextObject, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false)
static UQuickVectorTweenQuickTweenCreateTweenVector (UObject *worldContextObject, const FVector &from, const FVector &to, FVectorSetter setter, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickRotatorTweenQuickTweenCreateTweenRotator (UObject *worldContextObject, const FRotator &from, const FRotator &to, FRotatorSetter setter, bool bUseShortestPath, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenCreateTweenFloat (UObject *worldContextObject, float from, float to, FFloatSetter setter, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVector2DTweenQuickTweenCreateTweenVector2D (UObject *worldContextObject, const FVector2D &from, const FVector2D &to, FVector2DSetter setter, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickColorTweenQuickTweenCreateTweenColor (UObject *worldContextObject, const FColor &from, const FColor &to, FColorSetter setter, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickIntTweenQuickTweenCreateTweenInt (UObject *worldContextObject, int32 from, int32 to, FIntSetter setter, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVectorTweenQuickTweenMoveTo_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FVector &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, EQuickTweenSpace space=EQuickTweenSpace::WorldSpace, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVector2DTweenQuickTweenMoveTo_Widget (UObject *worldContextObject, UWidget *widget, const FVector2D &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVectorTweenQuickTweenMoveBy_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FVector &by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, EQuickTweenSpace space=EQuickTweenSpace::WorldSpace, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVector2DTweenQuickTweenMoveBy_Widget (UObject *worldContextObject, UWidget *widget, const FVector2D &by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVectorTweenQuickTweenScaleTo_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FVector &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, EQuickTweenSpace space=EQuickTweenSpace::LocalSpace, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVector2DTweenQuickTweenScaleTo_Widget (UObject *worldContextObject, UWidget *widget, const FVector2D &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVectorTweenQuickTweenScaleBy_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FVector &by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, EQuickTweenSpace space=EQuickTweenSpace::LocalSpace, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVector2DTweenQuickTweenScaleBy_Widget (UObject *worldContextObject, UWidget *widget, const FVector2D &by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickRotatorTweenQuickTweenRotateTo_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FRotator &to, bool bUseShortestPath=true, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, EQuickTweenSpace space=EQuickTweenSpace::LocalSpace, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenRotateTo_Widget (UObject *worldContextObject, UWidget *widget, float to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickRotatorTweenQuickTweenRotateBy_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FRotator &by, bool bUseShortestPath=true, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, EQuickTweenSpace space=EQuickTweenSpace::LocalSpace, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenRotateBy_Widget (UObject *worldContextObject, UWidget *widget, float by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickRotatorTweenQuickTweenLookAt_SceneComponent (UObject *worldContextObject, USceneComponent *component, const FVector &to, bool bUseShortestPath=true, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenRotateAroundPoint_SceneComponent (UObject *worldContextObject, USceneComponent *component, float from, float to, const FVector &point, const FVector &normal, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickColorTweenQuickTweenChangeColorTo_Image (UObject *worldContextObject, UImage *widget, const FColor &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenChangeOpacityTo_Widget (UObject *worldContextObject, UWidget *widget, float to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenChangeFovTo_Camera (UObject *worldContextObject, UCameraComponent *camera, float to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenChangeDistanceTo_SpringArm (UObject *worldContextObject, USpringArmComponent *springArm, float to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenChangeDistanceBy_SpringArm (UObject *worldContextObject, USpringArmComponent *springArm, float by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVectorTweenQuickTweenVectorParameterTo_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName &parameterName, const FVector &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickVectorTweenQuickTweenVectorParameterBy_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName &parameterName, const FVector &by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenScalarParameterTo_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName &parameterName, float to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickFloatTweenQuickTweenScalarParameterBy_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName &parameterName, float by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickColorTweenQuickTweenColorParameterTo_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName &parameterName, const FColor &to, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickColorTweenQuickTweenColorParameterBy_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName &parameterName, const FColor &by, float duration=1.0f, float timeScale=1.0f, EEaseType easeType=EEaseType::Linear, UCurveFloat *easeCurve=nullptr, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
static UQuickTweenableQuickTweenFindTweenByTag (const UObject *worldContextObject, const FString &tweenTag)
static TArray< UQuickTweenable * > QuickTweenFindAllTweensByPredicate (const UObject *worldContextObject, const FQuickConstTweenableAction &predicate)
static void QuickTweenKillAllTweens (const UObject *worldContextObject)
static void QuickTweenPauseAllTweens (const UObject *worldContextObject)
static void QuickTweenPlayAllTweens (const UObject *worldContextObject)
static void QuickTweenReverseAllTweens (const UObject *worldContextObject)
static void QuickTweenCompleteAllTweens (const UObject *worldContextObject)
static void QuickTweenExecuteActionOnAllTweens (const UObject *worldContextObject, const FQuickTweenableAction &action)
static void QuickTweenExecuteActionByPredicate (const UObject *worldContextObject, const FQuickConstTweenableAction &predicate, const FQuickTweenableAction &action)

Detailed Description

UQuickTweenLibrary

Blueprint function library exposing helpers to create and manage QuickTween objects (sequences and tweens) from Blueprints and C++.

This class is a static container (derived from UBlueprintFunctionLibrary) providing factory functions for creating vector, rotator and float tweens, plus convenience functions for common SceneComponent operations (move, rotate, scale, look-at and rotate-around). All functions operate on the game thread and require a valid world context object when applicable.

Member Function Documentation

◆ QuickTweenChangeColorTo_Image()

UQuickColorTween * UQuickTweenLibrary::QuickTweenChangeColorTo_Image ( UObject * worldContextObject,
UImage * widget,
const FColor & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a color tween that animates a UImage's color/tint to a target FColor.

The widget's start color is sampled on the first update and the tween will interpolate from that start value to the specified to value over duration seconds. Easing can be controlled with a predefined EEaseType or by supplying a custom UCurveFloat (easeCurve overrides easeType when provided).

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UImage widget whose color will be animated.
toTarget color to animate to.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite).
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickColorTween, or nullptr on failure.

◆ QuickTweenChangeDistanceBy_SpringArm()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenChangeDistanceBy_SpringArm ( UObject * worldContextObject,
USpringArmComponent * springArm,
float by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that animates the spring arm's TargetArmLength by a relative amount.

This function creates a UQuickFloatTween which samples the spring arm's current TargetArmLength on the first update and interpolates to (start + by) over duration seconds. Easing is controlled by easeType or overridden by easeCurve when provided.

Parameters
worldContextObjectContext object used to find the world for the tween.
springArmThe USpringArmComponent whose TargetArmLength will be animated.
byRelative change to apply to the spring arm's current TargetArmLength.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite).
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenChangeDistanceTo_SpringArm()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenChangeDistanceTo_SpringArm ( UObject * worldContextObject,
USpringArmComponent * springArm,
float to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Animate the spring arm's distance (TargetArmLength) to a target value.

Creates a UQuickFloatTween that interpolates the spring arm's current arm length (sampled at the first update) to the provided to value over duration seconds. Easing can be controlled with a predefined EEaseType or by supplying a custom UCurveFloat (when provided, easeCurve overrides easeType).

Parameters
worldContextObjectContext object used to find the world for the tween.
springArmThe USpringArmComponent whose TargetArmLength will be animated.
toTarget arm length (world units).
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite).
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenChangeFovTo_Camera()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenChangeFovTo_Camera ( UObject * worldContextObject,
UCameraComponent * camera,
float to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Animate camera field of view (FOV) to a target value.

Creates a UQuickFloatTween that interpolates the camera's FOV from the camera's current FOV (sampled at first update) to the provided to value over duration seconds. Easing can be selected via easeType or an optional easeCurve (when provided, easeCurve overrides easeType).

Parameters
worldContextObjectContext object used to find the world for the tween.
cameraThe UCameraComponent whose FOV will be animated.
toTarget FOV value in degrees.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use (default EEaseType::Linear).
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite, default 1).
loopTypeHow the tween loops (Restart, PingPong, etc., default ELoopType::Restart).
tweenTagOptional tag to identify the created tween (default empty).
bShouldAutoKillIf true the tween will be automatically killed when complete (default false).
bShouldPlayWhilePausedIf true the tween will update while the game is paused (default false).
bShouldAutoPlayIf true the tween will start playing immediately after creation (default false).
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenChangeOpacityTo_Widget()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenChangeOpacityTo_Widget ( UObject * worldContextObject,
UWidget * widget,
float to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that animates a UWidget's opacity to a target value.

The widget's start opacity is sampled on the first update and the tween will interpolate from that start value to the specified to value over duration seconds. Easing may be controlled using a predefined EEaseType or by supplying a custom UCurveFloat (easeCurve overrides easeType when set).

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget whose opacity will be animated.
toTarget opacity value (0.0 = transparent, 1.0 = opaque).
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite).
loopTypeHow the tween loops (e.g., Restart, PingPong).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenColorParameterBy_Material()

UQuickColorTween * UQuickTweenLibrary::QuickTweenColorParameterBy_Material ( UObject * worldContextObject,
UMaterialInstanceDynamic * material,
const FName & parameterName,
const FColor & by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a color tween that animates a material color parameter by a relative amount.

The material parameter's starting value is sampled on the first update and the tween will interpolate from that start value to (start + by) over duration seconds. Note: the by parameter is provided as a float and should be interpreted according to how the material parameter consumes the value (e.g., intensity or a scalar channel modifier).

Parameters
worldContextObjectContext object used to find the world for the tween.
materialThe UMaterialInstanceDynamic containing the color parameter.
parameterNameThe name of the color parameter to animate.
byRelative FColor value to add to the sampled start value.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use for interpolation (default EEaseType::Linear).
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite, default 1).
loopTypeHow the tween loops (Restart, PingPong, etc., default ELoopType::Restart).
tweenTagOptional tag to identify the created tween (default empty).
bShouldAutoKillIf true the tween will be automatically killed when complete (default false).
bShouldPlayWhilePausedIf true the tween will update while the game is paused (default false).
bShouldAutoPlayIf true the tween will start playing immediately after creation (default false).
Returns
Pointer to the created UQuickColorTween, or nullptr on failure.

◆ QuickTweenColorParameterTo_Material()

UQuickColorTween * UQuickTweenLibrary::QuickTweenColorParameterTo_Material ( UObject * worldContextObject,
UMaterialInstanceDynamic * material,
const FName & parameterName,
const FColor & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a color tween that animates a vector/color parameter on a dynamic material instance to an absolute color.

The material parameter's starting color is sampled on the first update and the tween will interpolate from that start value to the provided to FColor over duration seconds. Easing may be controlled using a predefined EEaseType or an optional UCurveFloat (easeCurve overrides easeType when provided).

Parameters
worldContextObjectContext object used to find the world for the tween.
materialThe UMaterialInstanceDynamic containing the color parameter.
parameterNameThe name of the color parameter to animate.
toTarget FColor value for the material parameter.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use for interpolation (default EEaseType::Linear).
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite, default 1).
loopTypeHow the tween loops (Restart, PingPong, etc., default ELoopType::Restart).
tweenTagOptional tag to identify the created tween (default empty).
bShouldAutoKillIf true the tween will be automatically killed when complete (default false).
bShouldPlayWhilePausedIf true the tween will update while the game is paused (default false).
bShouldAutoPlayIf true the tween will start playing immediately after creation (default false).
Returns
Pointer to the created UQuickColorTween, or nullptr on failure.

◆ QuickTweenCompleteAllTweens()

void UQuickTweenLibrary::QuickTweenCompleteAllTweens ( const UObject * worldContextObject)
static

Complete all active QuickTweens within the specified world context.

This function locates the tween manager for the provided worldContextObject and immediately completes all active tweens, setting them to their end state. Completed tweens may be auto-killed based on their configuration.

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.

◆ QuickTweenCreateSequence()

UQuickTweenSequence * UQuickTweenLibrary::QuickTweenCreateSequence ( UObject * worldContextObject,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false )
static

Create a new Quick Tween sequence.

Parameters
worldContextObjectContext object used to find the world for the sequence.
loopsNumber of times to loop the sequence. Use -1 for infinite.
loopTypeHow the sequence loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created sequence.
bShouldAutoKillIf true the sequence will be automatically killed when complete.
bShouldPlayWhilePausedIf true the sequence will update while game is paused.
Returns
A newly created UQuickTweenSequence pointer.

◆ QuickTweenCreateTweenColor()

UQuickColorTween * UQuickTweenLibrary::QuickTweenCreateTweenColor ( UObject * worldContextObject,
const FColor & from,
const FColor & to,
FColorSetter setter,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a Color tween that interpolates between two FColor values and applies the interpolated value via the provided setter delegate each tick.

Easing can be controlled with a predefined EEaseType or by supplying a UCurveFloat.

Parameters
worldContextObjectContext object used to find the world for the tween.
fromStarting FColor value.
toTarget FColor value.
setterDelegate invoked each update with the current interpolated FColor.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickColorTween.

◆ QuickTweenCreateTweenFloat()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenCreateTweenFloat ( UObject * worldContextObject,
float from,
float to,
FFloatSetter setter,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that interpolates a value from from to to and applies it via setter.

Parameters
worldContextObjectContext object used to find the world for the tween.
fromDelegate that returns the starting float value.
toDelegate that returns the target float value.
setterDelegate invoked each update with the current interpolated float value.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite loops.
loopTypeHow the tween loops (e.g., Restart, PingPong).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true, the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true, the tween will update while the game is paused.
bShouldAutoPlayIf true, the tween will start playing immediately after creation.
Returns
A pointer to the created UQuickFloatTween.

◆ QuickTweenCreateTweenInt()

UQuickIntTween * UQuickTweenLibrary::QuickTweenCreateTweenInt ( UObject * worldContextObject,
int32 from,
int32 to,
FIntSetter setter,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create an Int tween that interpolates between two integer values and applies the interpolated value via the provided setter delegate each tick.

The tween uses floating point easing internally but outputs integer values to the setter.

Parameters
worldContextObjectContext object used to find the world for the tween.
fromStarting integer value.
toTarget integer value.
setterDelegate invoked each update with the current interpolated integer.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickIntTween.

◆ QuickTweenCreateTweenRotator()

UQuickRotatorTween * UQuickTweenLibrary::QuickTweenCreateTweenRotator ( UObject * worldContextObject,
const FRotator & from,
const FRotator & to,
FRotatorSetter setter,
bool bUseShortestPath,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a rotator tween that interpolates between two rotator values using delegates.

Parameters
worldContextObjectContext object used to find the world for the tween.
fromDelegate that returns the starting rotation.
toDelegate that returns the target rotation.
setterDelegate invoked each update with the current interpolated rotator.
bUseShortestPathIf true, rotation will take the shortest angular path.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite loops.
loopTypeHow the tween loops (e.g., Restart, PingPong).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true, the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true, the tween will update while the game is paused.
bShouldAutoPlayIf true, the tween will start playing immediately after creation.
Returns
A pointer to the created UQuickRotatorTween, or nullptr on failure.

◆ QuickTweenCreateTweenVector()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenCreateTweenVector ( UObject * worldContextObject,
const FVector & from,
const FVector & to,
FVectorSetter setter,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that interpolates between two FVector values using delegate getters and applies the interpolated value via a setter delegate each tick.

Parameters
worldContextObjectContext object used to find the world for the tween.
fromDelegate that returns the starting FVector value.
toDelegate that returns the target FVector value.
setterDelegate invoked each update with the current interpolated FVector.
durationTime in seconds for the tween to complete. Defaults to 1.0f.
timeScaleMultiplier applied to the tween time. Defaults to 1.0f.
easeTypePredefined easing function to use for interpolation. Defaults to EEaseType::Linear.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite. Defaults to 1.
loopTypeHow the tween loops (Restart, PingPong, etc.). Defaults to ELoopType::Restart.
tweenTagOptional tag to identify the created tween. Defaults to empty string.
bShouldAutoKillIf true the tween will be automatically killed when complete. Defaults to true.
bShouldPlayWhilePausedIf true the tween will update while game is paused. Defaults to false.
bShouldAutoPlayIf true the tween will start playing immediately after creation. Defaults to false.
Returns
A pointer to the created UQuickVectorTween.

◆ QuickTweenCreateTweenVector2D()

UQuickVector2DTween * UQuickTweenLibrary::QuickTweenCreateTweenVector2D ( UObject * worldContextObject,
const FVector2D & from,
const FVector2D & to,
FVector2DSetter setter,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a Vector2D tween that interpolates between two FVector2D values and applies the interpolated value via the provided setter delegate each tick.

The tween will evaluate easing using either a predefined EEaseType or an optional UCurveFloat. The start and target values are provided directly as parameters.

Parameters
worldContextObjectContext object used to find the world for the tween.
fromStarting FVector2D value.
toTarget FVector2D value.
setterDelegate invoked each update with the current interpolated FVector2D.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickVector2DTween.

◆ QuickTweenExecuteActionByPredicate()

void UQuickTweenLibrary::QuickTweenExecuteActionByPredicate ( const UObject * worldContextObject,
const FQuickConstTweenableAction & predicate,
const FQuickTweenableAction & action )
static

Execute a specified action on all active QuickTweens that match a given predicate within the world context.

This function searches through all active tweens managed by the tween manager associated with the provided worldContextObject. For each tween that satisfies the given predicate, the specified action is executed.

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.
predicateThe predicate function used to filter tweens.
actionThe action to execute on matching tweens.

◆ QuickTweenExecuteActionOnAllTweens()

void UQuickTweenLibrary::QuickTweenExecuteActionOnAllTweens ( const UObject * worldContextObject,
const FQuickTweenableAction & action )
static

Execute a specified action on all active QuickTweens within the given world context.

This function locates the tween manager for the provided worldContextObject and performs the specified action on all active tweens. The action is defined by the FQuickTweenableAction enum (e.g., Pause, Play, Reverse, etc.).

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.
actionThe action to execute on all active tweens.

◆ QuickTweenFindAllTweensByPredicate()

TArray< UQuickTweenable * > UQuickTweenLibrary::QuickTweenFindAllTweensByPredicate ( const UObject * worldContextObject,
const FQuickConstTweenableAction & predicate )
static

Find all active QuickTweens that match a specified predicate within the world context.

This function searches through all active tweens managed by the tween manager associated with the provided worldContextObject and returns an array of UQuickTweenable instances that satisfy the given predicate.

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.
predicateThe predicate function used to filter tweens.
Returns
An array of UQuickTweenable pointers that match the predicate.

◆ QuickTweenFindTweenByTag()

UQuickTweenable * UQuickTweenLibrary::QuickTweenFindTweenByTag ( const UObject * worldContextObject,
const FString & tweenTag )
static

Find an active QuickTween by its tag within the world context.

Parameters
worldContextObjectContext object used to locate the world that contains the tween.
tweenTagTag identifying the tween to find.
Returns
Pointer to the found UQuickTweenable instance, or nullptr if none found.

◆ QuickTweenKillAllTweens()

void UQuickTweenLibrary::QuickTweenKillAllTweens ( const UObject * worldContextObject)
static

Kill all active QuickTweens within the specified world context.

This function locates the tween manager for the provided worldContextObject and immediately kills/removes all active tweens. Use this to forcefully stop any running tweens (useful for cleanup, level transitions, or global reset).

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.

◆ QuickTweenLookAt_SceneComponent()

UQuickRotatorTween * UQuickTweenLibrary::QuickTweenLookAt_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FVector & to,
bool bUseShortestPath = true,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a rotator tween that orients a SceneComponent to look at a target point.

Note: The start and end value will be cached from the component's current location at the first update.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to rotate.
toTarget world-space location to look at.
bUseShortestPathIf true rotation will take the shortest angular path.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use.
easeCurveOptional custom curve to evaluate easing.
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickRotatorTween pointer controlling the look-at rotation.

◆ QuickTweenMoveBy_SceneComponent()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenMoveBy_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FVector & by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
EQuickTweenSpace space = EQuickTweenSpace::WorldSpace,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that moves a SceneComponent by a relative offset.

This function generates a UQuickVectorTween which will drive the component's world or local position from its current value (cached at the first update) by adding the provided by vector to the start position. The interpolated value is applied each tick via the tween's setter. Easing can be controlled with either a predefined EEaseType or an optional UCurveFloat. The operation can be performed in local or world space according to space.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to move.
byRelative world/local offset to apply (added to the start location).
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
spaceSpace in which to apply the movement (World or Local).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickVectorTween pointer controlling the movement.

◆ QuickTweenMoveBy_Widget()

UQuickVector2DTween * UQuickTweenLibrary::QuickTweenMoveBy_Widget ( UObject * worldContextObject,
UWidget * widget,
const FVector2D & by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a Vector2D tween that moves a UWidget by a relative offset.

The tween samples the widget's current position/translation on its first update and interpolates from that start value to (start + by) over duration seconds. The interpolated FVector2D is applied to the widget each tick via the tween's internal setter. Easing may be controlled using a predefined EEaseType or by supplying a custom UCurveFloat.

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget to move.
byRelative offset to add to the widget's start position.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickVector2DTween, or nullptr on failure.

◆ QuickTweenMoveTo_SceneComponent()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenMoveTo_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FVector & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
EQuickTweenSpace space = EQuickTweenSpace::WorldSpace,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that moves a SceneComponent to a target location.

Note: The start and end value will be cached from the component's current location at the first update.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to move.
toTarget world-space location.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use.
easeCurveOptional custom curve to evaluate easing.
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
spaceSpace in which to perform the look-at operation (World or Local).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickVectorTween pointer controlling the movement.

◆ QuickTweenMoveTo_Widget()

UQuickVector2DTween * UQuickTweenLibrary::QuickTweenMoveTo_Widget ( UObject * worldContextObject,
UWidget * widget,
const FVector2D & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a Vector2D tween that moves a UWidget to a target absolute position.

The widget's start position is sampled on the first update and the tween interpolates from that start position to the specified to value over duration seconds. Easing is controlled via easeType or an optional easeCurve. The returned tween will apply interpolated FVector2D values to the widget each tick.

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget to move.
toTarget position as an FVector2D.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use (default EEaseType::Linear).
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite, default 1).
loopTypeHow the tween loops (Restart, PingPong, etc., default ELoopType::Restart).
tweenTagOptional tag to identify the created tween (default empty).
bShouldAutoKillIf true the tween will be automatically killed when complete (default false).
bShouldPlayWhilePausedIf true the tween will update while the game is paused (default false).
bShouldAutoPlayIf true the tween will start playing immediately after creation (default false).
Returns
Pointer to the created UQuickVector2DTween, or nullptr on failure.

◆ QuickTweenPauseAllTweens()

void UQuickTweenLibrary::QuickTweenPauseAllTweens ( const UObject * worldContextObject)
static

Pause all active QuickTweens within the specified world context.

This function finds the tween manager associated with worldContextObject and pauses all currently active tweens. Paused tweens retain their state and can be resumed later. This does not kill or destroy tweens.

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.

◆ QuickTweenPlayAllTweens()

void UQuickTweenLibrary::QuickTweenPlayAllTweens ( const UObject * worldContextObject)
static

Play all QuickTweens within the specified world context.

This function locates the tween manager for the provided worldContextObject and resumes all tweens that were previously paused. Active tweens that are not paused remain unaffected.

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.

◆ QuickTweenReverseAllTweens()

void UQuickTweenLibrary::QuickTweenReverseAllTweens ( const UObject * worldContextObject)
static

Reverse all active QuickTweens within the specified world context.

This function finds the tween manager associated with worldContextObject and reverses the playback direction of all currently active tweens. Tweens that were playing forward will play backward, and vice versa.

Parameters
worldContextObjectContext object used to locate the world that contains the tweens.

◆ QuickTweenRotateAroundPoint_SceneComponent()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenRotateAroundPoint_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
float from,
float to,
const FVector & point,
const FVector & normal,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that rotates a SceneComponent around a specified point and axis.

The tween will drive a single float value (angle) from from to to over duration and apply that rotation to component around point using normal as the rotation axis.

Note: The starting position is determined by the current location of the component at the time of tween creation, unlike other functions that the starting position is determined at the first update.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to rotate around the point.
fromStarting angle in degrees.
toTarget angle in degrees.
pointWorld-space point to rotate around.
normalAxis (normal) to rotate around.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use.
easeCurveOptional custom curve to evaluate easing.
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickFloatTween pointer controlling the rotation, or nullptr on failure.

◆ QuickTweenRotateBy_SceneComponent()

UQuickRotatorTween * UQuickTweenLibrary::QuickTweenRotateBy_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FRotator & by,
bool bUseShortestPath = true,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
EQuickTweenSpace space = EQuickTweenSpace::LocalSpace,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a rotator tween that rotates a SceneComponent by a relative rotator value.

This method creates a UQuickRotatorTween which will drive the component's rotation from its current rotation (cached at the first update) by the provided by rotator. The rotation can be applied in world or local space according to space. When bUseShortestPath is true the interpolation will pick the shortest angular path for each axis.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to rotate.
byRelative rotator to apply (added to the start rotation).
bUseShortestPathIf true rotation will take the shortest angular path.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use.
easeCurveOptional custom curve to evaluate easing.
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
spaceSpace in which to apply the relative rotation (World or Local).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickRotatorTween pointer controlling the rotation.

◆ QuickTweenRotateBy_Widget()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenRotateBy_Widget ( UObject * worldContextObject,
UWidget * widget,
float by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that rotates a UWidget by a relative angle.

The tween will drive a single float value representing the widget's rotation angle and apply a relative change of by degrees over duration. The widget's starting rotation is sampled when the tween first updates. Easing may be controlled using a predefined EEaseType or a custom UCurveFloat.

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget to rotate.
byRelative angle in degrees to rotate the widget (added to start rotation).
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickFloatTween.

◆ QuickTweenRotateTo_SceneComponent()

UQuickRotatorTween * UQuickTweenLibrary::QuickTweenRotateTo_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FRotator & to,
bool bUseShortestPath = true,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
EQuickTweenSpace space = EQuickTweenSpace::LocalSpace,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a rotator tween that rotates a SceneComponent to a target rotator.

Note: The start and end value will be cached from the component's current location at the first update.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to rotate.
toTarget rotation (should be in the target space).
bUseShortestPathIf true rotation will take the shortest angular path.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use.
easeCurveOptional custom curve to evaluate easing.
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
spaceSpace in which to perform the look-at operation (World or Local).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickRotatorTween pointer controlling the rotation.

◆ QuickTweenRotateTo_Widget()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenRotateTo_Widget ( UObject * worldContextObject,
UWidget * widget,
float to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that rotates a UWidget to a target absolute angle.

This tween drives a single float value representing the widget's rotation angle and interpolates from the widget's current rotation (sampled at first update) to the specified target to over duration seconds.

Easing may be controlled using a predefined EEaseType or a custom UCurveFloat.

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget to rotate.
toTarget absolute angle in degrees to rotate the widget to.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenScalarParameterBy_Material()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenScalarParameterBy_Material ( UObject * worldContextObject,
UMaterialInstanceDynamic * material,
const FName & parameterName,
float by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that animates a scalar parameter on a dynamic material instance by a relative amount.

The tween samples the material parameter's current value on the first update and interpolates from that start value to (start + by) over the specified duration. Easing is controlled by easeType or overridden by easeCurve when provided.

Parameters
worldContextObjectContext object used to find the world for the tween.
materialThe UMaterialInstanceDynamic containing the scalar parameter.
parameterNameThe name of the scalar parameter to animate.
byRelative float value to add to the sampled start value.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite, default 1).
loopTypeHow the tween loops (Restart, PingPong, etc., default ELoopType::Restart).
tweenTagOptional tag to identify the created tween (default empty).
bShouldAutoKillIf true the tween will be automatically killed when complete (default false).
bShouldPlayWhilePausedIf true the tween will update while the game is paused (default false).
bShouldAutoPlayIf true the tween will start playing immediately after creation (default false).
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenScalarParameterTo_Material()

UQuickFloatTween * UQuickTweenLibrary::QuickTweenScalarParameterTo_Material ( UObject * worldContextObject,
UMaterialInstanceDynamic * material,
const FName & parameterName,
float to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a float tween that animates a scalar parameter on a dynamic material instance.

The tween will sample the material parameter's current value on the first update and interpolate from that start value to the provided to value over duration seconds. Easing is controlled using easeType or overridden by easeCurve when provided.

Parameters
worldContextObjectContext object used to find the world for the tween.
materialThe UMaterialInstanceDynamic containing the scalar parameter.
parameterNameThe name of the scalar parameter to animate.
toTarget float value for the material parameter.
durationTime in seconds for the tween to complete (default 1.0f).
timeScaleMultiplier applied to the tween time (default 1.0f).
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween (-1 for infinite, default 1).
loopTypeHow the tween loops (Restart, PingPong, etc., default ELoopType::Restart).
tweenTagOptional tag to identify the created tween (default empty).
bShouldAutoKillIf true the tween will be automatically killed when complete (default false).
bShouldPlayWhilePausedIf true the tween will update while the game is paused (default false).
bShouldAutoPlayIf true the tween will start playing immediately after creation (default false).
Returns
Pointer to the created UQuickFloatTween, or nullptr on failure.

◆ QuickTweenScaleBy_SceneComponent()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenScaleBy_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FVector & by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
EQuickTweenSpace space = EQuickTweenSpace::LocalSpace,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that scales a SceneComponent by a relative amount.

This function generates a UQuickVectorTween which will drive the component's scale from its current value (cached at the first update) by adding the provided by vector to the start scale. The scale change is applied every tick via the tween's setter. Easing can be controlled with either a predefined EEaseType or an optional UCurveFloat. The operation can be performed in local or world space according to space.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to scale.
byRelative scale vector to apply (added to the start scale).
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
spaceSpace in which to apply the scale (World or Local).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickVectorTween pointer controlling the scale tween.

◆ QuickTweenScaleBy_Widget()

UQuickVector2DTween * UQuickTweenLibrary::QuickTweenScaleBy_Widget ( UObject * worldContextObject,
UWidget * widget,
const FVector2D & by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a Vector2D tween that scales a UWidget by a relative amount.

This function creates a UQuickVector2DTween which will drive the widget's scale from its current value (sampled at the first update) by adding the provided by vector to the start scale. Easing may be controlled using a predefined EEaseType or by supplying a custom UCurveFloat. The tween will apply the interpolated FVector2D value to the widget each tick.

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget to scale.
byRelative scale vector to apply (added to the start scale).
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickVector2DTween, or nullptr on failure.

◆ QuickTweenScaleTo_SceneComponent()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenScaleTo_SceneComponent ( UObject * worldContextObject,
USceneComponent * component,
const FVector & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
EQuickTweenSpace space = EQuickTweenSpace::LocalSpace,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that scales a SceneComponent to a target scale.

Note: The start and end value will be cached from the component's current location at the first update.

Parameters
worldContextObjectContext object used to find the world for the tween.
componentThe SceneComponent to scale.
toTarget scale vector.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing type to use.
easeCurveOptional custom curve to evaluate easing.
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
spaceSpace in which to perform the look-at operation (World or Local).
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
A UQuickVectorTween pointer controlling the scale tween.

◆ QuickTweenScaleTo_Widget()

UQuickVector2DTween * UQuickTweenLibrary::QuickTweenScaleTo_Widget ( UObject * worldContextObject,
UWidget * widget,
const FVector2D & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a Vector2D tween that scales a UWidget to a target absolute scale.

This function creates a UQuickVector2DTween which will sample the widget's current scale on the first update and interpolate from that start value to the provided to target over duration seconds. Easing may be controlled using a predefined EEaseType or by supplying a custom UCurveFloat.

Parameters
worldContextObjectContext object used to find the world for the tween.
widgetThe UWidget to scale.
toTarget absolute scale as an FVector2D.
durationTime in seconds for the tween to complete. Defaults to 1.0f.
timeScaleMultiplier applied to the tween time. Defaults to 1.0f.
easeTypePredefined easing function to use for interpolation. Defaults to EEaseType::Linear.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite. Defaults to 1.
loopTypeHow the tween loops (Restart, PingPong, etc.). Defaults to ELoopType::Restart.
tweenTagOptional tag to identify the created tween. Defaults to empty string.
bShouldAutoKillIf true the tween will be automatically killed when complete. Defaults to false.
bShouldPlayWhilePausedIf true the tween will update while the game is paused. Defaults to false.
bShouldAutoPlayIf true the tween will start playing immediately after creation. Defaults to false.
Returns
Pointer to the created UQuickVector2DTween, or nullptr on failure.

◆ QuickTweenVectorParameterBy_Material()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenVectorParameterBy_Material ( UObject * worldContextObject,
UMaterialInstanceDynamic * material,
const FName & parameterName,
const FVector & by,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that animates a vector parameter on a dynamic material instance by a relative amount.

The tween samples the material parameter's current value on its first update and interpolates from that start value to (start + by) over the specified duration. Easing is controlled by easeType or overridden by easeCurve when provided.

Parameters
worldContextObjectContext object used to find the world for the tween.
materialThe UMaterialInstanceDynamic containing the vector parameter.
parameterNameThe name of the vector parameter to animate.
byRelative FVector value to add to the sampled start value.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickVectorTween, or nullptr on failure.

◆ QuickTweenVectorParameterTo_Material()

UQuickVectorTween * UQuickTweenLibrary::QuickTweenVectorParameterTo_Material ( UObject * worldContextObject,
UMaterialInstanceDynamic * material,
const FName & parameterName,
const FVector & to,
float duration = 1.0f,
float timeScale = 1.0f,
EEaseType easeType = EEaseType::Linear,
UCurveFloat * easeCurve = nullptr,
int32 loops = 1,
ELoopType loopType = ELoopType::Restart,
const FString & tweenTag = "",
bool bShouldAutoKill = true,
bool bShouldPlayWhilePaused = false,
bool bShouldAutoPlay = false )
static

Create a vector tween that animates a vector parameter on a dynamic material instance.

The tween will sample the material parameter's current value on the first update and interpolate from that start value to the provided to value over duration seconds. Easing is controlled using easeType or overridden by easeCurve when provided.

Parameters
worldContextObjectContext object used to find the world for the tween.
materialThe UMaterialInstanceDynamic containing the vector parameter.
parameterNameThe name of the vector parameter to animate.
toTarget FVector value for the material parameter.
durationTime in seconds for the tween to complete.
timeScaleMultiplier applied to the tween time.
easeTypePredefined easing function to use for interpolation.
easeCurveOptional custom UCurveFloat used for easing (overrides easeType when provided).
loopsNumber of times to loop the tween. Use -1 for infinite.
loopTypeHow the tween loops (Restart, PingPong, etc.).
tweenTagOptional tag to identify the created tween.
bShouldAutoKillIf true the tween will be automatically killed when complete.
bShouldPlayWhilePausedIf true the tween will update while the game is paused.
bShouldAutoPlayIf true the tween will start playing immediately after creation.
Returns
Pointer to the created UQuickVectorTween, or nullptr on failure.

The documentation for this class was generated from the following files:
  • D:/UnrealEngine/TweenPlugin/Plugins/QuickTween/Source/QuickTween/Public/Blueprint/QuickTweenLibrary.h
  • D:/UnrealEngine/TweenPlugin/Plugins/QuickTween/Source/QuickTween/Private/Blueprint/QuickTweenLibrary.cpp