FStreamableManager

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

Inheritance Hierarchy

FGCObject

FStreamableManager

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

Name Description

Public function

FStreamableManager()

Public function

FStreamableManager

(
    const FStreamableManager&
)

Not safe to copy or duplicate

Destructors

Name Description

Public function

~FStreamableManager()

Functions

Name Description

Public function Const

bool

 

AreAllAsyncLoadsComplete()

Returns true if all pending async loads have finished for all targets

Public function

TSharedPtr< ...

 

CreateCombinedHandle

(
    const TConstArrayView< TSharedPtr< ...,
    const FString& DebugName,
    EStreamableManagerCombinedHandleOpt...
)

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

Public function Const

bool

 

GetActiveHandles

(
    const FSoftObjectPath& Target,
    TArray< TSharedRef< FStreamableHand...,
    bool bOnlyManagedHandles
)

Gets list of handles that are directly referencing this asset, returns true if any found.

Public function Const

const FStrin...

 

GetManagerName()

Returns the debug name for this manager

Public function Const

bool

 

IsAsyncLoadComplete

(
    const FSoftObjectPath& Target
)

Returns true if all pending async loads have finished for this target

Public function

TSubclassOf<...

 

LoadSynchronous

(
    const TSoftClassPtr< T >& Target,
    bool bManageActiveHandle,
    TSharedPtr< FStreamableHandle >...
)

Public function

T *

 

LoadSynchronous

(
    const TSoftObjectPtr< T >& Target,
    bool bManageActiveHandle,
    TSharedPtr< FStreamableHandle >...
)

Public function

T *

 

LoadSynchronous

(
    const FSoftObjectPath& Target,
    bool bManageActiveHandle,
    TSharedPtr< FStreamableHandle >...
)

Typed wrappers

Public function

UObject *...

 

LoadSynchronous

(
    const FSoftObjectPath& Target,
    bool bManageActiveHandle,
    TSharedPtr< FStreamableHandle >...
)

Synchronously load the referred asset and return the loaded object, or nullptr if it can't be found.

Public function

TSharedPtr< ...

 

RequestAsyncLoad

(
    TArray< FSoftObjectPath > TargetsTo...,
    TFunction< void()>&& Callback,
    TAsyncLoadPriority Priority,
    bool bManageActiveHandle,
    bool bStartStalled,
    FString DebugName
)

Lambda Wrappers. Be aware that Callback may go off multiple seconds in the future.

Public function

TSharedPtr< ...

 

RequestAsyncLoad

(
    const FSoftObjectPath& TargetToStr...,
    TFunction< void()>&& Callback,
    TAsyncLoadPriority Priority,
    bool bManageActiveHandle,
    bool bStartStalled,
    FString DebugName
)

Public function

TSharedPtr< ...

 

RequestAsyncLoad

(
    const FSoftObjectPath& TargetToStr...,
    FStreamableDelegate DelegateToCall,
    TAsyncLoadPriority Priority,
    bool bManageActiveHandle,
    bool bStartStalled,
    FString DebugName
)

Public function

TSharedPtr< ...

 

RequestAsyncLoad

(
    TArray< FSoftObjectPath > TargetsTo...,
    FStreamableDelegate DelegateToCall,
    TAsyncLoadPriority Priority,
    bool bManageActiveHandle,
    bool bStartStalled,
    FString DebugName
)

This is the primary streamable operation.

Public function

TSharedPtr< ...

 

RequestSyncLoad

(
    const FSoftObjectPath& TargetToStr...,
    bool bManageActiveHandle,
    FString DebugName
)

Public function

TSharedPtr< ...

 

RequestSyncLoad

(
    TArray< FSoftObjectPath > TargetsTo...,
    bool bManageActiveHandle,
    FString DebugName
)

Synchronously load a set of assets, and return a handle.

Public function Const

FSoftObjectP...

 

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

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Add referenced objects to stop them from GCing

Public function Virtual Const

FString

 

GetReferencerName()

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

Name Description

Public function

FStreamableM...

 

operator=

(
    const 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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel