FStreamableManager

A native class for managing streaming assets in and keeping them in memory.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Engine

Inheritance Hierarchy

References

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

Syntax

struct FStreamableManager : public FGCObject

Remarks

A native class for managing streaming assets in and keeping them in memory. AssetManager is the global singleton version of this with blueprint access

Constructors

  Type Name Description
Public function    
Public function   Not safe to copy or duplicate

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const bool Returns true if all pending async loads have finished for all targets
Public function TSharedPtr< FStreamableHandle >

CreateCombinedHandle ( const TConstArrayView< TSharedPtr< FStreamableHandle > >& ChildHandles,
const FString& DebugName,
EStreamableManagerCombinedHandleOptions Options
)

 Creates a combined handle, which will wait for other handles to complete before completing.
Public function Const bool

GetActiveHandles ( const FSoftObjectPath& Target,
TArray< TSharedRef< FStreamableHandle > >& HandleList,
bool bOnlyManagedHandles
)

 Gets list of handles that are directly referencing this asset, returns true if any found.
Public function Const const FString & Returns the debug name for this manager
Public function Const bool Returns true if all pending async loads have finished for this target
Public function T *

LoadSynchronous ( const FSoftObjectPath& Target,
bool bManageActiveHandle,
TSharedPtr< FStreamableHandle >* RequestHandlePointer,
UE::FSourceLocation Location
)

 Typed wrappers
Public function UObject *

LoadSynchronous ( const FSoftObjectPath& Target,
bool bManageActiveHandle,
TSharedPtr< FStreamableHandle >* RequestHandlePointer,
UE::FSourceLocation Location
)

 Synchronously load the referred asset and return the loaded object, or nullptr if it can't be found.
Public function TSubclassOf< T >

LoadSynchronous ( const TSoftClassPtr< T >& Target,
bool bManageActiveHandle,
TSharedPtr< FStreamableHandle >* RequestHandlePointer,
UE::FSourceLocation Location
)

  
Public function T *

LoadSynchronous ( const TSoftObjectPtr< T >& Target,
bool bManageActiveHandle,
TSharedPtr< FStreamableHandle >* RequestHandlePointer,
UE::FSourceLocation Location
)

  
Public function TSharedPtr< FStreamableHandle >

RequestAsyncLoad ( PathContainerType&& TargetsToStream,
FuncType&& DelegateToCall,
TAsyncLoadPriority Priority,
bool bManageActiveHandle,
bool bStartStalled,
DebugNameType&& DebugNameOrLocation
)

 This is the primary streamable operation.
Public function TSharedPtr< FStreamableHandle >

RequestSyncLoad ( PathContainerType&& TargetsToStream,
bool bManageActiveHandle,
DebugNameType&& DebugNameOrLocation
)

 Synchronously load a set of assets, and return a handle.
Public function Const FSoftObjectPath

ResolveRedirects ( const FSoftObjectPath& Target
)

 Checks for any redirectors that were previously loaded, and returns the redirected target if found.
Public function void

SetManagerName ( FString InName
)

 Modifies the debug name of this manager, used for debugging GC references
Public function void

Unload ( const FSoftObjectPath& Target
)

 This will release any managed active handles pointing to the target soft object path, even if they include other requested assets in the same load

Overridden from FGCObject

  Type Name Description
Public function Virtual void Add referenced objects to stop them from GCing
Public function Virtual Const FString Overload this method to report a name for your referencer
Public function Virtual Const bool

GetReferencerPropertyName ( UObject* Object,
FString& OutPropertyName
)

 Overload this method to report how the specified object is referenced, if necessary

Operators

  Type Name Description
Public function FStreamableManager &  

Typedefs

Name Description
TStreamableMap Map of paths to streamable objects, this will be the post-redirector name
TStreamableRedirects  

Constants

Name Description
AsyncLoadHighPriority Priority to try and load immediately.
DefaultAsyncLoadPriority Default priority for all async loads.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page