#include <QuickTweenSequence.h>

Inheritance diagram for UQuickTweenSequence:

Public Member Functions
UQuickTweenSequence *	Join (UQuickTweenable *tween)
UQuickTweenSequence *	Append (UQuickTweenable *tween)
virtual void	SetOwner (UQuickTweenable *owner) override
virtual void	Play () override
virtual void	Pause () override
virtual void	Reverse () override
virtual void	Complete (bool bSnapToEnd=true) override
virtual void	Restart () override
virtual void	Kill () override
virtual void	Update (float deltaTime) override
virtual void	Evaluate (const FQuickTweenEvaluatePayload &payload, const UQuickTweenable *instigator) override
virtual bool	GetIsPendingKill () const override
virtual bool	GetIsPlaying () const override
virtual float	GetTimeScale () const override
virtual bool	GetIsReversed () const override
virtual EEaseType	GetEaseType () const override
virtual UCurveFloat *	GetEaseCurve () const override
virtual bool	GetAutoKill () const override
virtual bool	GetIsCompleted () const override
virtual float	GetLoopDuration () const override
virtual float	GetTotalDuration () const override
virtual float	GetElapsedTime () const override
virtual int32	GetLoops () const override
virtual int32	GetCurrentLoop () const override
virtual ELoopType	GetLoopType () const override
virtual FString	GetTweenTag () const override
virtual bool	GetShouldPlayWhilePaused () const override
int32	GetNumTweens () const
UQuickTweenable *	GetTween (int32 index) const
void	AssignOnStartEvent (FDynamicDelegateTweenSequence callback)
void	AssignOnUpdateEvent (FDynamicDelegateTweenSequence callback)
void	AssignOnCompleteEvent (FDynamicDelegateTweenSequence callback)
void	AssignOnKilledEvent (FDynamicDelegateTweenSequence callback)
void	AssignOnLoopEvent (FDynamicDelegateTweenSequence callback)
void	RemoveAllOnStartEvent (const UObject *object)
void	RemoveAllOnUpdateEvent (const UObject *object)
void	RemoveAllOnCompleteEvent (const UObject *object)
void	RemoveAllOnKilledEvent (const UObject *object)
void	RemoveAllOnLoopEvent (const UObject *object)

Static Public Member Functions
static UQuickTweenSequence *	CreateSequence (UObject *worldContextObject, int32 loops=1, ELoopType loopType=ELoopType::Restart, const FString &id=FString(), bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false)

Public Attributes
FNativeDelegateTweenSequence	OnStart
FNativeDelegateTweenSequence	OnUpdate
FNativeDelegateTweenSequence	OnComplete
FNativeDelegateTweenSequence	OnKilled
FNativeDelegateTweenSequence	OnLoop

Detailed Description

UQuickTweenSequence manages a sequence of tween animations. Allows joining, appending, and controlling multiple tweens as a group. Supports looping, reversing, and querying sequence state. Note:

Tweens added to the sequence can not be controlled individually.

Member Function Documentation

◆ Append()

UQuickTweenSequence * UQuickTweenSequence::Append ( UQuickTweenable * tween )

Creates a new group and adds a new tween to it.

Parameters

tween The tween to append.

Returns: Reference to this sequence.

◆ AssignOnCompleteEvent()

void UQuickTweenSequence::AssignOnCompleteEvent ( FDynamicDelegateTweenSequence callback )

Assign a Blueprint dynamic delegate to be invoked when the tween completes.

Parameters

callback Dynamic delegate with signature (UQuickTweenSequence* Tween). The provided delegate will be stored and called on completion.

◆ AssignOnKilledEvent()

void UQuickTweenSequence::AssignOnKilledEvent ( FDynamicDelegateTweenSequence callback )

Assign a Blueprint dynamic delegate to be invoked when the tween is killed.

Parameters

callback Dynamic delegate with signature (UQuickTweenSequence* Tween). The provided delegate will be stored and called when the tween is killed.

◆ AssignOnLoopEvent()

void UQuickTweenSequence::AssignOnLoopEvent ( FDynamicDelegateTweenSequence callback )

Assign a Blueprint dynamic delegate to be invoked when the tween loops.

Parameters

callback Dynamic delegate with signature (UQuickTweenSequence* Tween). The provided delegate will be stored and called when the tween loops.

◆ AssignOnStartEvent()

void UQuickTweenSequence::AssignOnStartEvent ( FDynamicDelegateTweenSequence callback )

Assign a Blueprint dynamic delegate to be invoked when the tween starts.

Parameters

callback Dynamic delegate with signature (UQuickTweenSequence* Tween). The provided delegate will be stored and called on start events.

◆ AssignOnUpdateEvent()

void UQuickTweenSequence::AssignOnUpdateEvent ( FDynamicDelegateTweenSequence callback )

Assign a Blueprint dynamic delegate to be invoked on every tween update.

Parameters

callback Dynamic delegate with signature (UQuickTweenSequence* Tween). The provided delegate will be stored and called each update tick.

◆ Complete()

void UQuickTweenSequence::Complete ( bool bSnapToEnd = true )

overridevirtual

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

Parameters

bSnapToEnd If true, snap properties to final state when completing.

Reimplemented from UQuickTweenable.

◆ CreateSequence()

UQuickTweenSequence * UQuickTweenSequence::CreateSequence	(	UObject *	worldContextObject,
		int32	loops = 1,
		ELoopType	loopType = ELoopType::Restart,
		const FString &	id = FString(),
		bool	bShouldAutoKill = true,
		bool	bShouldPlayWhilePaused = false )

inlinestatic

Creates a new tween sequence with the specified parameters.

Parameters

worldContextObject	Context object for world access.
loops	Number of loops (-1 = infinite).
loopType	Looping behavior.
id	Optional identifier for the sequence.
bShouldAutoKill	Whether to auto-kill the sequence on completion.
bShouldPlayWhilePaused	Whether the sequence should play while the game is paused.

Returns: Pointer to the created tween sequence.

◆ Evaluate()

void UQuickTweenSequence::Evaluate	(	const FQuickTweenEvaluatePayload &	payload,
		const UQuickTweenable *	instigator )

overridevirtual

Evaluate the tween with value.

Parameters

payload	Evaluation payload containing active state and value.
instigator

Reimplemented from UQuickTweenable.

◆ GetAutoKill()

virtual bool UQuickTweenSequence::GetAutoKill ( ) const

inlinenodiscardoverridevirtual

Returns whether this tween will be removed automatically after completion.

Reimplemented from UQuickTweenable.

◆ GetCurrentLoop()

virtual int32 UQuickTweenSequence::GetCurrentLoop ( ) const

inlinenodiscardoverridevirtual

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

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

Reimplemented from UQuickTweenable.

◆ GetEaseCurve()

virtual UCurveFloat * UQuickTweenSequence::GetEaseCurve ( ) const

inlinenodiscardoverridevirtual

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

Returns: Pointer to a UCurveFloat or nullptr if not set.

Reimplemented from UQuickTweenable.

◆ GetEaseType()

virtual EEaseType UQuickTweenSequence::GetEaseType ( ) const

inlinenodiscardoverridevirtual

Get the easing function type used by this tween.

Reimplemented from UQuickTweenable.

◆ GetElapsedTime()

virtual float UQuickTweenSequence::GetElapsedTime ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetIsCompleted()

virtual bool UQuickTweenSequence::GetIsCompleted ( ) const

inlinenodiscardoverridevirtual

Check whether the tween has reached its completion state.

Reimplemented from UQuickTweenable.

◆ GetIsPendingKill()

virtual bool UQuickTweenSequence::GetIsPendingKill ( ) const

inlinenodiscardoverridevirtual

Query whether this tween is pending removal from the manager.

Returns: True if the tween is pending kill, false otherwise.

Reimplemented from UQuickTweenable.

◆ GetIsPlaying()

virtual bool UQuickTweenSequence::GetIsPlaying ( ) const

inlinenodiscardoverridevirtual

Check if the tween is currently playing.

Returns: True when playing; false when paused or stopped.

Reimplemented from UQuickTweenable.

◆ GetIsReversed()

virtual bool UQuickTweenSequence::GetIsReversed ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetLoopDuration()

float UQuickTweenSequence::GetLoopDuration ( ) const

nodiscardoverridevirtual

Get the configured duration of the loop in seconds.

Reimplemented from UQuickTweenable.

◆ GetLoops()

virtual int32 UQuickTweenSequence::GetLoops ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetLoopType()

virtual ELoopType UQuickTweenSequence::GetLoopType ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetNumTweens()

int32 UQuickTweenSequence::GetNumTweens ( ) const

nodiscard

Gets the number of tweens in the sequence.

Returns: Number of tweens.

◆ GetShouldPlayWhilePaused()

virtual bool UQuickTweenSequence::GetShouldPlayWhilePaused ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetTimeScale()

virtual float UQuickTweenSequence::GetTimeScale ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetTotalDuration()

virtual float UQuickTweenSequence::GetTotalDuration ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ GetTween()

UQuickTweenable * UQuickTweenSequence::GetTween ( int32 index ) const

nodiscard

Gets the tween at the specified index.

Parameters

index Index of the tween.

Returns: Pointer to the tween.

◆ GetTweenTag()

virtual FString UQuickTweenSequence::GetTweenTag ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

◆ Join()

UQuickTweenSequence * UQuickTweenSequence::Join ( UQuickTweenable * tween )

Joins a tween to the previously created group, or creates a new one if it is the first.

Parameters

tween The tween to join.

Returns: Reference to this sequence.

◆ Kill()

void UQuickTweenSequence::Kill ( )

overridevirtual

Forcefully kill the tween and mark it for removal.

Reimplemented from UQuickTweenable.

◆ Pause()

void UQuickTweenSequence::Pause ( )

overridevirtual

Pause playback of the tween.

Reimplemented from UQuickTweenable.

◆ Play()

void UQuickTweenSequence::Play ( )

overridevirtual

Start or resume playback of the tween.

Reimplemented from UQuickTweenable.

◆ RemoveAllOnCompleteEvent()

void UQuickTweenSequence::RemoveAllOnCompleteEvent ( const UObject * object )

Remove all bound Blueprint dynamic delegates for the complete event that belong to the specified object.

Parameters

object The UObject whose bindings should be removed. If nullptr, no action is taken.

◆ RemoveAllOnKilledEvent()

void UQuickTweenSequence::RemoveAllOnKilledEvent ( const UObject * object )

Remove all bound Blueprint dynamic delegates for the killed event that belong to the specified object.

Parameters

object The UObject whose bindings should be removed. If nullptr, no action is taken.

◆ RemoveAllOnLoopEvent()

void UQuickTweenSequence::RemoveAllOnLoopEvent ( const UObject * object )

Remove all bound Blueprint dynamic delegates for the loop event that belong to the specified object.

Parameters

object The UObject whose bindings should be removed. If nullptr, no action is taken.

◆ RemoveAllOnStartEvent()

void UQuickTweenSequence::RemoveAllOnStartEvent ( const UObject * object )

Remove all bound Blueprint dynamic delegates for the start event that belong to the specified object.

Parameters

object The UObject whose bindings should be removed. If nullptr, no action is taken.

◆ RemoveAllOnUpdateEvent()

void UQuickTweenSequence::RemoveAllOnUpdateEvent ( const UObject * object )

Remove all bound Blueprint dynamic delegates for the update event that belong to the specified object.

Parameters

object The UObject whose bindings should be removed. If nullptr, no action is taken.

◆ Restart()

void UQuickTweenSequence::Restart ( )

overridevirtual

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

Reimplemented from UQuickTweenable.

◆ Reverse()

void UQuickTweenSequence::Reverse ( )

overridevirtual

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

Reimplemented from UQuickTweenable.

◆ SetOwner()

virtual void UQuickTweenSequence::SetOwner ( UQuickTweenable * owner )

inlineoverridevirtual

Set the owning tween object for this tweenable.

Reimplemented from UQuickTweenable.

◆ Update()

void UQuickTweenSequence::Update ( float deltaTime )

overridevirtual

Update the tween state by a time delta.

Parameters

deltaTime Time in seconds to advance the tween.

Reimplemented from UQuickTweenable.

Member Data Documentation

◆ OnComplete

FNativeDelegateTweenSequence UQuickTweenSequence::OnComplete

Called when the sequence completes.

◆ OnKilled

FNativeDelegateTweenSequence UQuickTweenSequence::OnKilled

Called when the sequence is killed.

◆ OnLoop

FNativeDelegateTweenSequence UQuickTweenSequence::OnLoop

Called when the sequence loops.

◆ OnStart

FNativeDelegateTweenSequence UQuickTweenSequence::OnStart

Called when the sequence starts.

◆ OnUpdate

FNativeDelegateTweenSequence UQuickTweenSequence::OnUpdate

Called when the sequence updates.

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

Source/QuickTween/Public/Tweens/QuickTweenSequence.h
Source/QuickTween/Private/Tweens/QuickTweenSequence.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ Append()

◆ AssignOnCompleteEvent()

◆ AssignOnKilledEvent()

◆ AssignOnLoopEvent()

◆ AssignOnStartEvent()

◆ AssignOnUpdateEvent()

◆ Complete()

◆ CreateSequence()

◆ Evaluate()

◆ GetAutoKill()

◆ GetCurrentLoop()

◆ GetEaseCurve()

◆ GetEaseType()

◆ GetElapsedTime()

◆ GetIsCompleted()

◆ GetIsPendingKill()

◆ GetIsPlaying()

◆ GetIsReversed()

◆ GetLoopDuration()

◆ GetLoops()

◆ GetLoopType()

◆ GetNumTweens()

◆ GetShouldPlayWhilePaused()

◆ GetTimeScale()

◆ GetTotalDuration()

◆ GetTween()

◆ GetTweenTag()

◆ Join()

◆ Kill()

◆ Pause()

◆ Play()

◆ RemoveAllOnCompleteEvent()

◆ RemoveAllOnKilledEvent()

◆ RemoveAllOnLoopEvent()

◆ RemoveAllOnStartEvent()

◆ RemoveAllOnUpdateEvent()

◆ Restart()

◆ Reverse()

◆ SetOwner()

◆ Update()

Member Data Documentation

◆ OnComplete

◆ OnKilled

◆ OnLoop

◆ OnStart

◆ OnUpdate