#include <QuickFloatTween.h>

Inheritance diagram for UQuickFloatTween:

Public Member Functions
float	GetCurrentValue () const
float	GetStartValue () const
float	GetEndValue () const
Public Member Functions inherited from UQuickTweenBase
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)

Static Public Member Functions

static UQuickFloatTween * CreateTween (UObject *worldContextObject, FNativeFloatGetter from, FNativeFloatGetter to, FNativeFloatSetter 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=FString(), bool bShouldAutoKill=true, bool bShouldPlayWhilePaused=false, bool bShouldAutoPlay=false)

Protected Member Functions
virtual void	ApplyAlphaValue (float alpha) override
virtual void	HandleOnStart () override
virtual void	HandleOnComplete () override
Protected Member Functions inherited from UQuickTweenBase
virtual void	HandleOnKill ()

Additional Inherited Members
Public Attributes inherited from UQuickTweenBase
FNativeDelegateTween	OnStart
FNativeDelegateTween	OnUpdate
FNativeDelegateTween	OnComplete
FNativeDelegateTween	OnKilled
FNativeDelegateTween	OnLoop

Detailed Description

Tween class for interpolating between two FVector values over time. Inherits from UQuickTweenBase and provides vector-specific tweening functionality.

Member Function Documentation

◆ ApplyAlphaValue()

void UQuickFloatTween::ApplyAlphaValue ( float alpha )

overrideprotectedvirtual

Apply the interpolated alpha value to the tweened property.

Parameters

alpha Interpolated alpha value (0.0 to 1.0).

Reimplemented from UQuickTweenBase.

◆ CreateTween()

UQuickFloatTween * UQuickFloatTween::CreateTween	(	UObject *	worldContextObject,
		FNativeFloatGetter	from,
		FNativeFloatGetter	to,
		FNativeFloatSetter	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 = FString(),
		bool	bShouldAutoKill = true,
		bool	bShouldPlayWhilePaused = false,
		bool	bShouldAutoPlay = false )

inlinestatic

Create and set up a UQuickFloatTween with the specified parameters.

Note: The start and end value will be cached at the first update.

Parameters

worldContextObject	Context object for world access.
from	Function to get the FROM value.
to	Function to get the TO value.
setter	Function to apply the interpolated value.
duration	Duration of the loop in seconds.
timeScale	Multiplier for the tween's speed.
easeType	Type of easing to apply.
easeCurve	Optional custom curve for easing.
loops	Number of times to loop the tween.
loopType	Type of looping behavior.
tweenTag	Optional tag for identifying the tween.
bShouldAutoKill	Whether to auto-kill the tween on completion.
bShouldPlayWhilePaused	Whether the tween should play while the game is paused.
bShouldAutoPlay	Whether to start playing the tween immediately after setup.

◆ GetCurrentValue()

float UQuickFloatTween::GetCurrentValue ( ) const

inlinenodiscard

Get the current interpolated float value.

◆ GetEndValue()

float UQuickFloatTween::GetEndValue ( ) const

inlinenodiscard

Get the ending float value. Set after the first tick

◆ GetStartValue()

float UQuickFloatTween::GetStartValue ( ) const

inlinenodiscard

Get the starting float value. Set after the first tick

◆ HandleOnComplete()

void UQuickFloatTween::HandleOnComplete ( )

overrideprotectedvirtual

Called when the tween transitions to the Complete state.

Reimplemented from UQuickTweenBase.

◆ HandleOnStart()

void UQuickFloatTween::HandleOnStart ( )

overrideprotectedvirtual

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 from UQuickTweenBase.

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ApplyAlphaValue()

◆ CreateTween()

◆ GetCurrentValue()

◆ GetEndValue()

◆ GetStartValue()

◆ HandleOnComplete()

◆ HandleOnStart()