UQuickTweenManager Class Reference

#include <QuickTweenManager.h>

Inheritance diagram for UQuickTweenManager:

Public Member Functions
virtual void	Initialize (FSubsystemCollectionBase &Collection) override
virtual void	Deinitialize () override
virtual UWorld *	GetTickableGameObjectWorld () const override
virtual void	Tick (float deltaTime) override
virtual TStatId	GetStatId () const override
virtual ETickableTickType	GetTickableTickType () const override
virtual bool	IsTickable () const override
virtual bool	IsTickableInEditor () const override
virtual bool	IsTickableWhenPaused () const override
void	AddTween (class UQuickTweenable *tween)
void	RemoveTween (class UQuickTweenable *tween)
UQuickTweenable *	FindTweenByPredicate (TFunctionRef< bool(UQuickTweenable *)> predicate) const
UQuickTweenable *	FindLastTweenByPredicate (TFunctionRef< bool(UQuickTweenable *)> predicate) const
TArray< UQuickTweenable * >	FindAllTweensByPredicate (TFunctionRef< bool(UQuickTweenable *)> predicate) const
void	ExecutePredicateByCondition (TFunctionRef< void(UQuickTweenable *)> action, TFunctionRef< bool(const UQuickTweenable *)> predicate) const

Static Public Member Functions
static UQuickTweenManager *	Get (const UObject *worldContextObject)

Detailed Description

World-scoped manager that updates active tweens each frame. Implements a world subsystem to live with the UWorld and implements FTickableGameObject so the engine will call Tick on this instance.

Use UQuickTweenManager::Get(...) to retrieve the manager for a given world context object.

Member Function Documentation

AddTween()

void UQuickTweenManager::AddTween

(

class UQuickTweenable *

tween

)

Register a tween with the manager so it will be updated on Tick.

Parameters

tween

- Pointer to the UQuickTweenable to add. Manager does not take ownership.

Deinitialize()

void UQuickTweenManager::Deinitialize ( )

overridevirtual

Deinitialize the subsystem. Called when the world subsystem is being destroyed. Use this to clean up any remaining tweens and resources.

ExecutePredicateByCondition()

void UQuickTweenManager::ExecutePredicateByCondition	(	TFunctionRef< void(UQuickTweenable *)>	action,
		TFunctionRef< bool(const UQuickTweenable *)>	predicate ) const

Execute a function on all tweens matching the given predicate.

Parameters

action	- Function to execute on each matching tween.
predicate	- Function that returns true for the desired tweens.

FindAllTweensByPredicate()

TArray< UQuickTweenable * > UQuickTweenManager::FindAllTweensByPredicate

(

TFunctionRef< bool(UQuickTweenable *)>

predicate

)

const

Find all tweens matching the given predicate.

Parameters

predicate

- Function that returns true for the desired tweens.

Returns

An array of pointers to the found tweens.

FindLastTweenByPredicate()

UQuickTweenable * UQuickTweenManager::FindLastTweenByPredicate

(

TFunctionRef< bool(UQuickTweenable *)>

predicate

)

const

Find the last tween matching the given predicate.

Parameters

predicate

- Function that returns true for the desired tween.

Returns

A pointer to the found tween or null otherwise.

FindTweenByPredicate()

UQuickTweenable * UQuickTweenManager::FindTweenByPredicate

(

TFunctionRef< bool(UQuickTweenable *)>

predicate

)

const

Find a tween matching the given predicate.

Parameters

predicate

- Function that returns true for the desired tween.

Returns

A pointer to the found tween or null otherwise.

Get()

UQuickTweenManager * UQuickTweenManager::Get ( const UObject * worldContextObject )

static

Retrieve the singleton instance of UQuickTweenManager for the given world context.

Parameters

worldContextObject

- Any UObject that can be used to resolve the UWorld (e.g. Actor, Component, World).

Returns

Pointer to the manager instance for the world, or nullptr if none is available.

GetStatId()

TStatId UQuickTweenManager::GetStatId ( ) const

overridevirtual

Return a unique stat id for profiling this tickable object.

GetTickableGameObjectWorld()

UWorld * UQuickTweenManager::GetTickableGameObjectWorld ( ) const

overridevirtual

Provide the world this tickable object belongs to.

Returns

The UWorld pointer associated with this manager.

GetTickableTickType()

virtual ETickableTickType UQuickTweenManager::GetTickableTickType ( ) const

inlineoverridevirtual

Always tick this object (even when not actively rendered).

Initialize()

void UQuickTweenManager::Initialize ( FSubsystemCollectionBase & Collection )

overridevirtual

Initialize the subsystem. Called when the world subsystem is created.

Parameters

Collection

- Subsystem collection info provided by the engine.

IsTickable()

virtual bool UQuickTweenManager::IsTickable ( ) const

inlineoverridevirtual

Indicate whether this object should be ticked.

Returns

true if tickable.

IsTickableInEditor()

virtual bool UQuickTweenManager::IsTickableInEditor ( ) const

inlineoverridevirtual

Indicate whether this object is tickable in the editor.

Returns

false to avoid editor ticks.

IsTickableWhenPaused()

virtual bool UQuickTweenManager::IsTickableWhenPaused ( ) const

inlineoverridevirtual

Indicate whether this object should still tick when the game is paused.

Returns

true to continue ticking while paused.

RemoveTween()

void UQuickTweenManager::RemoveTween

(

class UQuickTweenable *

tween

)

Unregister a tween so it will no longer be updated.

Parameters

tween

- Pointer to the UQuickTweenable to remove.

Tick()

void UQuickTweenManager::Tick ( float deltaTime )

overridevirtual

Per-frame tick function called by the engine.

Parameters

deltaTime

- Time elapsed since the last tick (in seconds).

---

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

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