UQuickTweenBase Class Reference

#include <QuickTweenBase.h>

Inheritance diagram for UQuickTweenBase:

Public Member Functions
void	SetUp (const UObject *worldContextObject, float duration, float timeScale, EEaseType easeType, UCurveFloat *easeCurve, int32 loops, ELoopType loopType, const FString &tweenTag=FString(), bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)
virtual void	SetOwner (UQuickTweenable *owner) override
virtual void	Play () override
virtual void	Pause () override
virtual void	Reverse () override
virtual void	Restart () override
virtual void	Complete (bool bSnapToEnd=true) override
virtual void	Kill () override
virtual void	Update (float deltaTime) override
virtual void	Evaluate (bool bIsActive, float value, const UQuickTweenable *instigator) override
virtual bool	GetIsPendingKill () const override
virtual float	GetLoopDuration () const override
virtual float	GetTotalDuration () const override
virtual float	GetElapsedTime () const override
virtual float	GetTimeScale () const override
virtual bool	GetIsPlaying () const override
virtual bool	GetIsCompleted () const override
virtual bool	GetIsReversed () const override
virtual EEaseType	GetEaseType () const override
virtual UCurveFloat *	GetEaseCurve () const override
virtual int32	GetLoops () const override
virtual ELoopType	GetLoopType () const override
virtual FString	GetTweenTag () const override
virtual int32	GetCurrentLoop () const override
virtual bool	GetAutoKill () const override
virtual bool	GetShouldPlayWhilePaused () const override
bool	GetSnapToEndOnComplete () const
bool	InstigatorIsOwner (const UQuickTweenable *instigator) const
bool	HasOwner () const
void	AssignOnStartEvent (FDynamicDelegateTween callback)
void	AssignOnUpdateEvent (FDynamicDelegateTween callback)
void	AssignOnCompleteEvent (FDynamicDelegateTween callback)
void	AssignOnKilledEvent (FDynamicDelegateTween callback)
void	AssignOnLoopEvent (FDynamicDelegateTween 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)

Public Attributes
FNativeDelegateTween	OnStart
FNativeDelegateTween	OnUpdate
FNativeDelegateTween	OnComplete
FNativeDelegateTween	OnKilled
FNativeDelegateTween	OnLoop

Protected Member Functions
virtual void	ApplyAlphaValue (float alpha)
virtual void	HandleOnStart ()
virtual void	HandleOnComplete ()
virtual void	HandleOnKill ()

Detailed Description

Base class for all QuickTween tweens. Provides core tweening functionality, state, and events.

Member Function Documentation

ApplyAlphaValue()

void UQuickTweenBase::ApplyAlphaValue ( float alpha )

protectedvirtual

Apply the interpolated alpha value to the tweened property.

Parameters

alpha

Interpolated alpha value (0.0 to 1.0).

Reimplemented in UQuickColorTween, UQuickFloatTween, UQuickIntTween, UQuickRotatorTween, UQuickVector2DTween, and UQuickVectorTween.

AssignOnCompleteEvent()

void UQuickTweenBase::AssignOnCompleteEvent

(

FDynamicDelegateTween

callback

)

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

Parameters

callback

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

AssignOnKilledEvent()

void UQuickTweenBase::AssignOnKilledEvent

(

FDynamicDelegateTween

callback

)

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

Parameters

callback

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

AssignOnLoopEvent()

void UQuickTweenBase::AssignOnLoopEvent

(

FDynamicDelegateTween

callback

)

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

Parameters

callback

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

AssignOnStartEvent()

void UQuickTweenBase::AssignOnStartEvent

(

FDynamicDelegateTween

callback

)

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

Parameters

callback

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

AssignOnUpdateEvent()

void UQuickTweenBase::AssignOnUpdateEvent

(

FDynamicDelegateTween

callback

)

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

Parameters

callback

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

Complete()

void UQuickTweenBase::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.

Evaluate()

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

overridevirtual

Evaluate the tween with value.

Parameters

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

Reimplemented from UQuickTweenable.

GetAutoKill()

virtual bool UQuickTweenBase::GetAutoKill ( ) const

inlinenodiscardoverridevirtual

Returns whether this tween will be removed automatically after completion.

Reimplemented from UQuickTweenable.

GetCurrentLoop()

virtual int32 UQuickTweenBase::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 * UQuickTweenBase::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 UQuickTweenBase::GetEaseType ( ) const

inlinenodiscardoverridevirtual

Get the easing function type used by this tween.

Reimplemented from UQuickTweenable.

GetElapsedTime()

virtual float UQuickTweenBase::GetElapsedTime ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetIsCompleted()

virtual bool UQuickTweenBase::GetIsCompleted ( ) const

inlinenodiscardoverridevirtual

Check whether the tween has reached its completion state.

Reimplemented from UQuickTweenable.

GetIsPendingKill()

virtual bool UQuickTweenBase::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 UQuickTweenBase::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 UQuickTweenBase::GetIsReversed ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetLoopDuration()

virtual float UQuickTweenBase::GetLoopDuration ( ) const

inlinenodiscardoverridevirtual

Get the configured duration of the loop in seconds.

Reimplemented from UQuickTweenable.

GetLoops()

virtual int32 UQuickTweenBase::GetLoops ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetLoopType()

virtual ELoopType UQuickTweenBase::GetLoopType ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetShouldPlayWhilePaused()

virtual bool UQuickTweenBase::GetShouldPlayWhilePaused ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetTimeScale()

virtual float UQuickTweenBase::GetTimeScale ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetTotalDuration()

virtual float UQuickTweenBase::GetTotalDuration ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

GetTweenTag()

virtual FString UQuickTweenBase::GetTweenTag ( ) const

inlinenodiscardoverridevirtual

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

Reimplemented from UQuickTweenable.

HandleOnComplete()

void UQuickTweenBase::HandleOnComplete ( )

protectedvirtual

Called when the tween transitions to the Complete state.

Reimplemented in UQuickColorTween, UQuickFloatTween, UQuickIntTween, UQuickRotatorTween, UQuickVector2DTween, and UQuickVectorTween.

HandleOnKill()

void UQuickTweenBase::HandleOnKill ( )

protectedvirtual

Called when the tween transitions to the Kill state.

This is invoked once when the tween is being removed. Implementations should perform any necessary cleanup and invoke killed events.

HandleOnStart()

void UQuickTweenBase::HandleOnStart ( )

protectedvirtual

Called when the tween transitions to the Start state.

This is invoked once when the tween begins. Implementations should perform any initialization required before the first update tick (e.g. set initial values, invoke start events).

Reimplemented in UQuickColorTween, UQuickFloatTween, UQuickIntTween, UQuickRotatorTween, UQuickVector2DTween, and UQuickVectorTween.

Kill()

void UQuickTweenBase::Kill ( )

overridevirtual

Forcefully kill the tween and mark it for removal.

Reimplemented from UQuickTweenable.

Pause()

void UQuickTweenBase::Pause ( )

overridevirtual

Pause playback of the tween.

Reimplemented from UQuickTweenable.

Play()

void UQuickTweenBase::Play ( )

overridevirtual

Start or resume playback of the tween.

Reimplemented from UQuickTweenable.

RemoveAllOnCompleteEvent()

void UQuickTweenBase::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 UQuickTweenBase::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 UQuickTweenBase::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 UQuickTweenBase::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 UQuickTweenBase::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 UQuickTweenBase::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 UQuickTweenBase::Reverse ( )

overridevirtual

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

Reimplemented from UQuickTweenable.

SetOwner()

virtual void UQuickTweenBase::SetOwner ( UQuickTweenable * owner )

inlineoverridevirtual

Set the owning tween object for this tweenable.

Reimplemented from UQuickTweenable.

SetUp()

void UQuickTweenBase::SetUp	(	const UObject *	worldContextObject,
		float	duration,
		float	timeScale,
		EEaseType	easeType,
		UCurveFloat *	easeCurve,
		int32	loops,
		ELoopType	loopType,
		const FString &	tweenTag = FString(),
		bool	bShouldAutoKill = true,
		bool	bShouldPlayWhilePaused = false,
		bool	bShouldAutoPlay = false )

Set up the tween with the specified parameters.

Parameters

worldContextObject	Context object for world access.
duration	Duration of the loop in seconds.
timeScale	Time scale multiplier.
easeType	Type of easing to use.
easeCurve	Optional custom curve for easing.
loops	Number of loops (-1 = infinite).
loopType	Looping behavior.
tweenTag	Optional tag for identification.
bShouldAutoKill	Whether to auto-kill the tween on completion.
bShouldPlayWhilePaused	Whether the tween should play while the game is paused.
bShouldAutoPlay	Whether the tween should start playing immediately.

Update()

void UQuickTweenBase::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

FNativeDelegateTween UQuickTweenBase::OnComplete

Event triggered when the tween completes.

OnKilled

FNativeDelegateTween UQuickTweenBase::OnKilled

Event triggered when the tween is killed.

OnLoop

FNativeDelegateTween UQuickTweenBase::OnLoop

Event triggered when the tween loops.

OnStart

FNativeDelegateTween UQuickTweenBase::OnStart

Event triggered when the tween starts.

OnUpdate

FNativeDelegateTween UQuickTweenBase::OnUpdate

Event triggered when the tween updates.

---

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

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