1. Epic GamesDeveloper
  3. FStreamableHandle

FStreamableHandle

A handle to a synchronous or async load.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/StreamableManager.h
Include #include "Engine/StreamableManager.h"

Syntax

struct FStreamableHandle : public TSharedFromThis< FStreamableHandle >

Remarks

A handle to a synchronous or async load. As long as the handle is Active, loaded assets will stay in memory

Constructors

  Type Name Description
Public function   Not safe to copy or duplicate

Destructors

  Type Name Description
Public function   Destructor

Functions

  Type Name Description
Public function void

AddContextData ( const TSharedPtr< T >& NewData
)

 Unconditionally adds a contextual data struct to this handle. Uniqueness is not enforced.
Public function bool Bind delegate that is called if handle is canceled, only works if loading is in progress.
Public function bool Bind delegate that is called when load completes, only works if loading is in progress.
Public function bool Bind delegate that is called periodically as delegate updates, only works if loading is in progress.
Public function void Cancel a request, callable from within the manager or externally This will immediately release the handle even if it is still in progress, and call the cancel callback if bound This stops the completion callback from happening, even if it is in the delayed callback queue
Public function TSharedPtr< FStreamableHandle >

CreateCombinedHandle ( const TConstArrayView< TSharedPtr< FStreamableHandle > >& OtherHandles
)

 Creates a new merged handle which contains this handle as well as any external handles.
Public function Static void

ExecuteDelegate ( const FStreamableDelegate& Delegate,
TSharedPtr< FStreamableHandle > AssociatedHandle,
const FStreamableDelegate& CancelDelegate
)

 Calls a StreamableDelegate, this will add to the delayed callback queue depending on s.StreamableDelegateDelayFrames
Public function Static void

ExecuteDelegate ( FStreamableDelegate&& Delegate,
TSharedPtr< FStreamableHandle > AssociatedHandle,
FStreamableDelegate&& CancelDelegate
)

 Overload taking the Delegate by rvalue.
Public function Const TSharedPtr< T > Finds the first instance of a contextual data struct which is attached to this handle.
Public function Const TSharedPtr< FStreamableHandle >

FindMatchingHandle ( TFunction< bool(const FStreamableHandle&)> Predicate
)

 Return a TSharedPtr of the first handle among this and descendants which satisfies the predicate.
Public function T & Gives you a mutable reference to a contextual data struct of the specified type.
Public function Const void

ForEachLoadedAsset ( CallableT Callable
)

 Invokes a callable for each loaded asset if load has succeeded.
Public function Const TArray< TSharedPtr< T > > Finds all instances of a contextual data struct which are attached to this handle
Public function Const ECookLoadType  
Public function Const const FString & Returns the debug name for this handle.
Public function Const T * Templated version of above
Public function Const UObject * Returns first asset in requested asset list, if it's been successfully loaded.
Public function Const void

GetLoadedAssets ( TArray< UObject* >& LoadedAssets
)

 Adds all loaded assets if load has succeeded. Some entries will be null if loading failed
Public function Const void

GetLoadedAssets ( TArray< T* >& LoadedAssets
)

 Templated version of above. Entries that fail to cast will also be null.
Public function Const void

GetLoadedCount ( int32& LoadedCount,
int32& RequestedCount
)

 Returns number of assets that have completed loading out of initial list, failed loads will count as loaded
Public function TSharedPtr< FStreamableHandle > Crawls out to the outermost handle and returns it.
Public function Const FStreamableManager * Get the StreamableManager for this handle
Public function Const TAsyncLoadPriority Returns the streaming priority.
Public function Const float Returns progress as a value between 0.0 and 1.0.
Public function Const void

GetRequestedAssets ( TArray< FSoftObjectPath >& AssetList,
bool bIncludeChildren
)

 Gets list of assets references this load was started with.
Public function Const bool Check to see whether or not the Cancel delegate is bound; useful for doing extra work before/without stomping the existing delegate.
Public function Const bool Check to see whether or not the Complete delegate is bound; useful for doing extra work before/without stomping the existing delegate.
Public function Const bool If this request has finished loading, meaning all available assets were loaded Any assets that failed to load will still be null This can be true before the completion callback has happened as it may be in the delayed callback queue
Public function Const bool Returns true if we've done all the loading we can now, ie all handles are either completed or stalled
Public function Const bool Check to see whether or not the Update delegate is bound; useful for doing extra work before/without stomping the existing delegate.
Public function Const bool If this handle is still active, meaning it wasn't canceled or released
Public function Const bool Returns true if this is a combined handle that depends on child handles.
Public function Const bool True if load is still ongoing and we haven't been cancelled
Public function Const bool If this handle is stalled and waiting for another event to occur before it is actually requested
Public function void Release this handle.
Public function void Allows user code to provide a more detailed name in the cases where a name is autogenerated or otherwise default.
Public function void Tells a stalled handle to start its actual request.
Public function EAsyncPackageState::Type

WaitUntilComplete ( float Timeout,
bool bStartStalledHandles
)

 Blocks until the requested assets have loaded.
Public function Const bool If this request was cancelled.

Operators

  Type Name Description
Public function FStreamableHandle &  

Constants

Name Description
HandleDebugName_AssetList  
HandleDebugName_CombinedHandle  
HandleDebugName_Preloading  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page