|
QuickTween 1.3
|
#include <QuickTweenLibrary.h>
Static Public Member Functions | |
| static UQuickTweenSequence * | QuickTweenCreateSequence (UObject *worldContextObject, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &tweenTag="", bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false) |
| static UQuickVectorTween * | 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 UQuickRotatorTween * | 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 UQuickFloatTween * | 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 UQuickVector2DTween * | 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 UQuickColorTween * | 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 UQuickIntTween * | 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 UQuickVectorTween * | 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 UQuickVector2DTween * | 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 UQuickVectorTween * | 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 UQuickVector2DTween * | 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 UQuickVectorTween * | 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 UQuickVector2DTween * | 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 UQuickVectorTween * | 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 UQuickVector2DTween * | 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 UQuickRotatorTween * | 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 UQuickFloatTween * | 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 UQuickRotatorTween * | 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 UQuickFloatTween * | 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 UQuickRotatorTween * | 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 UQuickFloatTween * | 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 UQuickColorTween * | 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 UQuickFloatTween * | 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 UQuickFloatTween * | 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 UQuickFloatTween * | 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 UQuickFloatTween * | 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 UQuickVectorTween * | QuickTweenVectorParameterTo_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName ¶meterName, 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 UQuickVectorTween * | QuickTweenVectorParameterBy_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName ¶meterName, 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 UQuickFloatTween * | QuickTweenScalarParameterTo_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName ¶meterName, 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 UQuickFloatTween * | QuickTweenScalarParameterBy_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName ¶meterName, 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 UQuickColorTween * | QuickTweenColorParameterTo_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName ¶meterName, 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 UQuickColorTween * | QuickTweenColorParameterBy_Material (UObject *worldContextObject, UMaterialInstanceDynamic *material, const FName ¶meterName, 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 UQuickTweenable * | QuickTweenFindTweenByTag (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) |
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.
|
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).
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UImage widget whose color will be animated. |
| to | Target color to animate to. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite). |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| springArm | The USpringArmComponent whose TargetArmLength will be animated. |
| by | Relative change to apply to the spring arm's current TargetArmLength. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite). |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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).
| worldContextObject | Context object used to find the world for the tween. |
| springArm | The USpringArmComponent whose TargetArmLength will be animated. |
| to | Target arm length (world units). |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite). |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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).
| worldContextObject | Context object used to find the world for the tween. |
| camera | The UCameraComponent whose FOV will be animated. |
| to | Target FOV value in degrees. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use (default EEaseType::Linear). |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite, default 1). |
| loopType | How the tween loops (Restart, PingPong, etc., default ELoopType::Restart). |
| tweenTag | Optional tag to identify the created tween (default empty). |
| bShouldAutoKill | If true the tween will be automatically killed when complete (default false). |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused (default false). |
| bShouldAutoPlay | If true the tween will start playing immediately after creation (default 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).
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget whose opacity will be animated. |
| to | Target opacity value (0.0 = transparent, 1.0 = opaque). |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite). |
| loopType | How the tween loops (e.g., Restart, PingPong). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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).
| worldContextObject | Context object used to find the world for the tween. |
| material | The UMaterialInstanceDynamic containing the color parameter. |
| parameterName | The name of the color parameter to animate. |
| by | Relative FColor value to add to the sampled start value. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use for interpolation (default EEaseType::Linear). |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite, default 1). |
| loopType | How the tween loops (Restart, PingPong, etc., default ELoopType::Restart). |
| tweenTag | Optional tag to identify the created tween (default empty). |
| bShouldAutoKill | If true the tween will be automatically killed when complete (default false). |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused (default false). |
| bShouldAutoPlay | If true the tween will start playing immediately after creation (default 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).
| worldContextObject | Context object used to find the world for the tween. |
| material | The UMaterialInstanceDynamic containing the color parameter. |
| parameterName | The name of the color parameter to animate. |
| to | Target FColor value for the material parameter. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use for interpolation (default EEaseType::Linear). |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite, default 1). |
| loopType | How the tween loops (Restart, PingPong, etc., default ELoopType::Restart). |
| tweenTag | Optional tag to identify the created tween (default empty). |
| bShouldAutoKill | If true the tween will be automatically killed when complete (default false). |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused (default false). |
| bShouldAutoPlay | If true the tween will start playing immediately after creation (default false). |
|
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.
| worldContextObject | Context object used to locate the world that contains the tweens. |
|
static |
Create a new Quick Tween sequence.
| worldContextObject | Context object used to find the world for the sequence. |
| loops | Number of times to loop the sequence. Use -1 for infinite. |
| loopType | How the sequence loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created sequence. |
| bShouldAutoKill | If true the sequence will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the sequence will update while game is paused. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| from | Starting FColor value. |
| to | Target FColor value. |
| setter | Delegate invoked each update with the current interpolated FColor. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
static |
Create a float tween that interpolates a value from from to to and applies it via setter.
| worldContextObject | Context object used to find the world for the tween. |
| from | Delegate that returns the starting float value. |
| to | Delegate that returns the target float value. |
| setter | Delegate invoked each update with the current interpolated float value. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite loops. |
| loopType | How the tween loops (e.g., Restart, PingPong). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true, the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true, the tween will update while the game is paused. |
| bShouldAutoPlay | If true, the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| from | Starting integer value. |
| to | Target integer value. |
| setter | Delegate invoked each update with the current interpolated integer. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
static |
Create a rotator tween that interpolates between two rotator values using delegates.
| worldContextObject | Context object used to find the world for the tween. |
| from | Delegate that returns the starting rotation. |
| to | Delegate that returns the target rotation. |
| setter | Delegate invoked each update with the current interpolated rotator. |
| bUseShortestPath | If true, rotation will take the shortest angular path. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite loops. |
| loopType | How the tween loops (e.g., Restart, PingPong). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true, the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true, the tween will update while the game is paused. |
| bShouldAutoPlay | If true, the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| from | Delegate that returns the starting FVector value. |
| to | Delegate that returns the target FVector value. |
| setter | Delegate invoked each update with the current interpolated FVector. |
| duration | Time in seconds for the tween to complete. Defaults to 1.0f. |
| timeScale | Multiplier applied to the tween time. Defaults to 1.0f. |
| easeType | Predefined easing function to use for interpolation. Defaults to EEaseType::Linear. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. Defaults to 1. |
| loopType | How the tween loops (Restart, PingPong, etc.). Defaults to ELoopType::Restart. |
| tweenTag | Optional tag to identify the created tween. Defaults to empty string. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. Defaults to true. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. Defaults to false. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. Defaults to 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.
| worldContextObject | Context object used to find the world for the tween. |
| from | Starting FVector2D value. |
| to | Target FVector2D value. |
| setter | Delegate invoked each update with the current interpolated FVector2D. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to locate the world that contains the tweens. |
| predicate | The predicate function used to filter tweens. |
| action | The action to execute on matching tweens. |
|
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.).
| worldContextObject | Context object used to locate the world that contains the tweens. |
| action | The action to execute on all active tweens. |
|
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.
| worldContextObject | Context object used to locate the world that contains the tweens. |
| predicate | The predicate function used to filter tweens. |
|
static |
Find an active QuickTween by its tag within the world context.
| worldContextObject | Context object used to locate the world that contains the tween. |
| tweenTag | Tag identifying the tween to find. |
|
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).
| worldContextObject | Context object used to locate the world that contains the tweens. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to rotate. |
| to | Target world-space location to look at. |
| bUseShortestPath | If true rotation will take the shortest angular path. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use. |
| easeCurve | Optional custom curve to evaluate easing. |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to move. |
| by | Relative world/local offset to apply (added to the start location). |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| space | Space in which to apply the movement (World or Local). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget to move. |
| by | Relative offset to add to the widget's start position. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to move. |
| to | Target world-space location. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use. |
| easeCurve | Optional custom curve to evaluate easing. |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| space | Space in which to perform the look-at operation (World or Local). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget to move. |
| to | Target position as an FVector2D. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use (default EEaseType::Linear). |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite, default 1). |
| loopType | How the tween loops (Restart, PingPong, etc., default ELoopType::Restart). |
| tweenTag | Optional tag to identify the created tween (default empty). |
| bShouldAutoKill | If true the tween will be automatically killed when complete (default false). |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused (default false). |
| bShouldAutoPlay | If true the tween will start playing immediately after creation (default false). |
|
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.
| worldContextObject | Context object used to locate the world that contains the tweens. |
|
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.
| worldContextObject | Context object used to locate the world that contains the tweens. |
|
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.
| worldContextObject | Context object used to locate the world that contains the tweens. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to rotate around the point. |
| from | Starting angle in degrees. |
| to | Target angle in degrees. |
| point | World-space point to rotate around. |
| normal | Axis (normal) to rotate around. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use. |
| easeCurve | Optional custom curve to evaluate easing. |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to rotate. |
| by | Relative rotator to apply (added to the start rotation). |
| bUseShortestPath | If true rotation will take the shortest angular path. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use. |
| easeCurve | Optional custom curve to evaluate easing. |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| space | Space in which to apply the relative rotation (World or Local). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget to rotate. |
| by | Relative angle in degrees to rotate the widget (added to start rotation). |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to rotate. |
| to | Target rotation (should be in the target space). |
| bUseShortestPath | If true rotation will take the shortest angular path. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use. |
| easeCurve | Optional custom curve to evaluate easing. |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| space | Space in which to perform the look-at operation (World or Local). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget to rotate. |
| to | Target absolute angle in degrees to rotate the widget to. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| material | The UMaterialInstanceDynamic containing the scalar parameter. |
| parameterName | The name of the scalar parameter to animate. |
| by | Relative float value to add to the sampled start value. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite, default 1). |
| loopType | How the tween loops (Restart, PingPong, etc., default ELoopType::Restart). |
| tweenTag | Optional tag to identify the created tween (default empty). |
| bShouldAutoKill | If true the tween will be automatically killed when complete (default false). |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused (default false). |
| bShouldAutoPlay | If true the tween will start playing immediately after creation (default 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.
| worldContextObject | Context object used to find the world for the tween. |
| material | The UMaterialInstanceDynamic containing the scalar parameter. |
| parameterName | The name of the scalar parameter to animate. |
| to | Target float value for the material parameter. |
| duration | Time in seconds for the tween to complete (default 1.0f). |
| timeScale | Multiplier applied to the tween time (default 1.0f). |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween (-1 for infinite, default 1). |
| loopType | How the tween loops (Restart, PingPong, etc., default ELoopType::Restart). |
| tweenTag | Optional tag to identify the created tween (default empty). |
| bShouldAutoKill | If true the tween will be automatically killed when complete (default false). |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused (default false). |
| bShouldAutoPlay | If true the tween will start playing immediately after creation (default 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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to scale. |
| by | Relative scale vector to apply (added to the start scale). |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| space | Space in which to apply the scale (World or Local). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget to scale. |
| by | Relative scale vector to apply (added to the start scale). |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| component | The SceneComponent to scale. |
| to | Target scale vector. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing type to use. |
| easeCurve | Optional custom curve to evaluate easing. |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| space | Space in which to perform the look-at operation (World or Local). |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| widget | The UWidget to scale. |
| to | Target absolute scale as an FVector2D. |
| duration | Time in seconds for the tween to complete. Defaults to 1.0f. |
| timeScale | Multiplier applied to the tween time. Defaults to 1.0f. |
| easeType | Predefined easing function to use for interpolation. Defaults to EEaseType::Linear. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. Defaults to 1. |
| loopType | How the tween loops (Restart, PingPong, etc.). Defaults to ELoopType::Restart. |
| tweenTag | Optional tag to identify the created tween. Defaults to empty string. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. Defaults to false. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. Defaults to false. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. Defaults to 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.
| worldContextObject | Context object used to find the world for the tween. |
| material | The UMaterialInstanceDynamic containing the vector parameter. |
| parameterName | The name of the vector parameter to animate. |
| by | Relative FVector value to add to the sampled start value. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |
|
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.
| worldContextObject | Context object used to find the world for the tween. |
| material | The UMaterialInstanceDynamic containing the vector parameter. |
| parameterName | The name of the vector parameter to animate. |
| to | Target FVector value for the material parameter. |
| duration | Time in seconds for the tween to complete. |
| timeScale | Multiplier applied to the tween time. |
| easeType | Predefined easing function to use for interpolation. |
| easeCurve | Optional custom UCurveFloat used for easing (overrides easeType when provided). |
| loops | Number of times to loop the tween. Use -1 for infinite. |
| loopType | How the tween loops (Restart, PingPong, etc.). |
| tweenTag | Optional tag to identify the created tween. |
| bShouldAutoKill | If true the tween will be automatically killed when complete. |
| bShouldPlayWhilePaused | If true the tween will update while the game is paused. |
| bShouldAutoPlay | If true the tween will start playing immediately after creation. |