FStreamableDelegateDelayHelper Class Reference

Inheritance diagram for FStreamableDelegateDelayHelper:

Public Member Functions
template<typename InStreamableDelegate >
void	AddDelegate (InStreamableDelegate &&Delegate, InStreamableDelegate &&CancelDelegate, TSharedPtr< FStreamableHandle > AssociatedHandle)
void	CancelDelegatesForHandle (TSharedPtr< FStreamableHandle > AssociatedHandle)
void	FlushDelegates ()
void	Tick (float DeltaTime) override
virtual ETickableTickType	GetTickableTickType () const override
virtual bool	IsTickableWhenPaused () const override
virtual bool	IsTickableInEditor () const
virtual TStatId	GetStatId () const override
Public Member Functions inherited from FTickableGameObject
	UE_NONCOPYABLE (FTickableGameObject)
ENGINE_API	FTickableGameObject (ETickableTickType StartingTickType=ETickableTickType::NewObject)
virtual ENGINE_API	~FTickableGameObject ()
virtual UWorld *	GetTickableGameObjectWorld () const
ENGINE_API void	SetTickableTickType (ETickableTickType NewTickType)
Public Member Functions inherited from FTickableObjectBase
virtual bool	IsTickable () const
virtual bool	IsAllowedToTick () const

Additional Inherited Members
Static Public Member Functions inherited from FTickableGameObject
static ENGINE_API void	TickObjects (UWorld *World, ELevelTick LevelTickType, bool bIsPaused, float DeltaSeconds)
Static Protected Member Functions inherited from FTickableObjectBase
static ENGINE_API void	SimpleTickObjects (FTickableStatics &Statics, TFunctionRef< void(FTickableObjectBase *)> TickFunc)

Detailed Description

Helper class that defers streamable manager delegates until the next frame

Member Function Documentation

AddDelegate()

template<typename InStreamableDelegate >

void FStreamableDelegateDelayHelper::AddDelegate ( InStreamableDelegate &&  Delegate, InStreamableDelegate &&  CancelDelegate, TSharedPtr< FStreamableHandle >  AssociatedHandle  )

inline

Adds a delegate to deferred list

CancelDelegatesForHandle()

void FStreamableDelegateDelayHelper::CancelDelegatesForHandle ( TSharedPtr< FStreamableHandle >  AssociatedHandle )

inline

Cancels delegate for handle, this will either delete the delegate or replace with the cancel delegate

FlushDelegates()

void FStreamableDelegateDelayHelper::FlushDelegates ( )

inline

Calls all delegates, call from synchronous flushes

GetStatId()

virtual TStatId FStreamableDelegateDelayHelper::GetStatId ( ) const

inlineoverridevirtual

Return the stat id used to track the performance of this object

Implements FTickableObjectBase.

GetTickableTickType()

virtual ETickableTickType FStreamableDelegateDelayHelper::GetTickableTickType ( ) const

inlineoverridevirtual

Virtual that can be overloaded by the inheriting class and is called before first tick. It is used to determine whether an object can possibly tick, and if not, it will not get added to the tickable objects array. If the tickable tick type is Conditional then the virtual IsTickable will be called to determine whether to tick the object on each given frame.

Returns

an enum defining the rules for ticking this object.

Reimplemented from FTickableObjectBase.

IsTickableInEditor()

virtual bool FStreamableDelegateDelayHelper::IsTickableInEditor ( ) const

inlinevirtual

Used to determine whether the object should be ticked in the editor when there is no gameplay world. Objects will still be ticked in Play in Editor if they are associated with a PIE world.

Returns

true if this tickable object should always be ticked in the editor, even if there is no gameplay world

Reimplemented from FTickableGameObject.

IsTickableWhenPaused()

virtual bool FStreamableDelegateDelayHelper::IsTickableWhenPaused ( ) const

inlineoverridevirtual

Used to determine if an object should be ticked when the game is paused. Defaults to false, as that mimics old behavior.

Returns

true if it should be ticked when paused, false otherwise

Reimplemented from FTickableGameObject.

Tick()

void FStreamableDelegateDelayHelper::Tick ( float  DeltaTime )

inlineoverridevirtual

Pure virtual that must be overloaded by the inheriting class. It will be called at different times in the frame depending on the subclass.

Parameters

DeltaTime

Game time passed since the last call.

Implements FTickableObjectBase.

---

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

• Engine/Source/Runtime/Engine/Private/StreamableManager.cpp