UQuickTweenable Class Reference

#include <QuickTweenable.h>

Inheritance diagram for UQuickTweenable:

Public Member Functions
virtual void	SetOwner (UQuickTweenable *owner)
virtual void	Play ()
virtual void	Pause ()
virtual void	Reverse ()
virtual void	Restart ()
virtual void	Complete (bool bSnapToEnd=true)
virtual void	Kill ()
virtual void	Update (float deltaTime)
virtual void	Evaluate (bool bIsActive, float value, const UQuickTweenable *instigator)
virtual bool	GetIsPendingKill () const
virtual float	GetLoopDuration () const
virtual float	GetTotalDuration () const
virtual float	GetElapsedTime () const
virtual float	GetTimeScale () const
virtual bool	GetIsPlaying () const
virtual bool	GetIsCompleted () const
virtual bool	GetIsReversed () const
virtual EEaseType	GetEaseType () const
virtual UCurveFloat *	GetEaseCurve () const
virtual int32	GetLoops () const
virtual ELoopType	GetLoopType () const
virtual FString	GetTweenTag () const
virtual int32	GetCurrentLoop () const
virtual bool	GetAutoKill () const
virtual bool	GetShouldPlayWhilePaused () const

Detailed Description

Base UObject for QuickTween tweens.

Provides a common interface for playback control, querying state, and configuring tween behavior. This class is intended to be extended in C++ or Blueprint to implement concrete tween logic (e.g., property interpolation). Marked as BlueprintType so instances and subclasses can be used in Blueprint graphs.

Usage notes:

• Use SetOwner to assign the owning sequence.

Member Function Documentation

Complete()

void UQuickTweenable::Complete ( bool bSnapToEnd = true )

virtual

Immediately complete the tween. If the tween is reversed bSnapToEnd is inverted.

Parameters

bSnapToEnd

If true, snap properties to final state when completing.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Evaluate()

void UQuickTweenable::Evaluate ( bool bIsActive, float value, const UQuickTweenable * instigator )

virtual

Evaluate the tween with value.

Parameters

bIsActive	if true, this tween is active.
value	.
instigator

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetAutoKill()

bool UQuickTweenable::GetAutoKill ( ) const

nodiscardvirtual

Returns whether this tween will be removed automatically after completion.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetCurrentLoop()

int32 UQuickTweenable::GetCurrentLoop ( ) const

nodiscardvirtual

Get the current loop index (0-based) the tween is on.

Returns

0 for the first loop, 1 for the second, etc.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetEaseCurve()

UCurveFloat * UQuickTweenable::GetEaseCurve ( ) const

nodiscardvirtual

Get the custom easing curve used by the tween, if any.

Returns

Pointer to a UCurveFloat or nullptr if not set.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetEaseType()

EEaseType UQuickTweenable::GetEaseType ( ) const

nodiscardvirtual

Get the easing function type used by this tween.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetElapsedTime()

float UQuickTweenable::GetElapsedTime ( ) const

nodiscardvirtual

Get the total elapsed time since the tween started (in seconds).

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetIsCompleted()

bool UQuickTweenable::GetIsCompleted ( ) const

nodiscardvirtual

Check whether the tween has reached its completion state.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetIsPendingKill()

bool UQuickTweenable::GetIsPendingKill ( ) const

nodiscardvirtual

Query whether this tween is pending removal from the manager.

Returns

True if the tween is pending kill, false otherwise.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetIsPlaying()

bool UQuickTweenable::GetIsPlaying ( ) const

nodiscardvirtual

Check if the tween is currently playing.

Returns

True when playing; false when paused or stopped.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetIsReversed()

bool UQuickTweenable::GetIsReversed ( ) const

nodiscardvirtual

Returns true if the tween's reversed flag is set (affects playback direction).

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetLoopDuration()

float UQuickTweenable::GetLoopDuration ( ) const

nodiscardvirtual

Get the configured duration of the loop in seconds.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetLoops()

int32 UQuickTweenable::GetLoops ( ) const

nodiscardvirtual

Get the configured number of loops for this tween (-1 for infinite if supported).

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetLoopType()

ELoopType UQuickTweenable::GetLoopType ( ) const

nodiscardvirtual

Get the loop behavior used when the tween repeats (e.g., Restart, Yoyo).

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetShouldPlayWhilePaused()

bool UQuickTweenable::GetShouldPlayWhilePaused ( ) const

nodiscardvirtual

Whether the tween should continue running even when the game is paused.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetTimeScale()

float UQuickTweenable::GetTimeScale ( ) const

nodiscardvirtual

Get the current time scale applied to the tween (1.0 = normal speed).

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetTotalDuration()

float UQuickTweenable::GetTotalDuration ( ) const

nodiscardvirtual

Get the total duration of the whole tween (max value for infinite)

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

GetTweenTag()

FString UQuickTweenable::GetTweenTag ( ) const

nodiscardvirtual

Get the user-assigned tag for this tween. Useful for identification and grouping.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Kill()

void UQuickTweenable::Kill ( )

virtual

Forcefully kill the tween and mark it for removal.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Pause()

void UQuickTweenable::Pause ( )

virtual

Pause playback of the tween.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Play()

void UQuickTweenable::Play ( )

virtual

Start or resume playback of the tween.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Restart()

void UQuickTweenable::Restart ( )

virtual

Restart the tween from its beginning (in case it is reversed, it will restart at the end). Must be played again after restarting.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Reverse()

void UQuickTweenable::Reverse ( )

virtual

Play the tween in reverse (playback direction is inverted).

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

SetOwner()

void UQuickTweenable::SetOwner ( UQuickTweenable * owner )

virtual

Set the owning tween object for this tweenable.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

Update()

void UQuickTweenable::Update ( float deltaTime )

virtual

Update the tween state by a time delta.

Parameters

deltaTime

Time in seconds to advance the tween.

Reimplemented in UQuickTweenBase, and UQuickTweenSequence.

---

The documentation for this class was generated from the following files:

• D:/UnrealEngine/TweenPlugin/Plugins/QuickTween/Source/QuickTween/Public/QuickTweenable.h
• D:/UnrealEngine/TweenPlugin/Plugins/QuickTween/Source/QuickTween/Private/QuickTweenable.cpp