Choose your operating system:
Windows
macOS
Linux
| TSharedFromThis
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Engine/StreamableManager.h |
Include |
#include "Engine/StreamableManager.h" |
struct FStreamableHandle : public TSharedFromThis< FStreamableHandle >
A handle to a synchronous or async load. As long as the handle is Active, loaded assets will stay in memory
Name | Description | |
---|---|---|
|
FStreamableHandle ( |
Not safe to copy or duplicate |
Name | Description | |
---|---|---|
|
~FStreamableHandle() |
Destructor |
Name | Description | ||
---|---|---|---|
|
AddContextData ( |
Unconditionally adds a contextual data struct to this handle. Uniqueness is not enforced. |
|
|
BindCancelDelegate ( |
Bind delegate that is called if handle is canceled, only works if loading is in progress. |
|
|
BindCompleteDelegate ( |
Bind delegate that is called when load completes, only works if loading is in progress. |
|
|
BindUpdateDelegate ( |
Bind delegate that is called periodically as delegate updates, only works if loading is in progress. |
|
|
CancelHandle() |
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 |
|
|
TSharedPtr< ... |
CreateCombinedHandle ( |
Creates a new merged handle which contains this handle as well as any external handles. |
|
ExecuteDelegate ( |
Calls a StreamableDelegate, this will add to the delayed callback queue depending on s.StreamableDelegateDelayFrames |
|
|
TSharedPtr< ... |
FindFirstContextDataOfType() |
Finds the first instance of a contextual data struct which is attached to this handle. |
|
TSharedPtr< ... |
FindMatchingHandle |
Return a TSharedPtr of the first handle among this and descendants which satisfies the predicate. |
|
T & |
FindOrAddContextData() |
Gives you a mutable reference to a contextual data struct of the specified type. |
|
GetContextDataOfType() |
Finds all instances of a contextual data struct which are attached to this handle |
|
|
const FStrin... |
GetDebugName() |
Returns the debug name for this handle. |
|
UObject *... |
GetLoadedAsset() |
Returns first asset in requested asset list, if it's been successfully loaded. |
|
GetLoadedAssets |
Adds all loaded assets if load has succeeded. Some entries will be null if loading failed |
|
|
GetLoadedCount |
Returns number of assets that have completed loading out of initial list, failed loads will count as loaded |
|
|
TSharedPtr< ... |
GetOutermostHandle() |
Crawls out to the outermost handle and returns it. |
|
FStreamableM... |
GetOwningManager() |
Get the StreamableManager for this handle |
|
TAsyncLoadPr... |
GetPriority() |
Returns the streaming priority. |
|
float |
GetProgress() |
Returns progress as a value between 0.0 and 1.0. |
|
GetRequestedAssets ( |
Gets list of assets references this load was started with. |
|
|
HasCancelDelegate() |
Check to see whether or not the Cancel delegate is bound; useful for doing extra work before/without stomping the existing delegate. |
|
|
HasCompleteDelegate() |
Check to see whether or not the Complete delegate is bound; useful for doing extra work before/without stomping the existing delegate. |
|
|
HasLoadCompleted() |
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 |
|
|
HasLoadCompletedOrStalled() |
Returns true if we've done all the loading we can now, ie all handles are either completed or stalled |
|
|
HasUpdateDelegate() |
Check to see whether or not the Update delegate is bound; useful for doing extra work before/without stomping the existing delegate. |
|
|
IsActive() |
If this handle is still active, meaning it wasn't canceled or released |
|
|
IsCombinedHandle() |
Returns true if this is a combined handle that depends on child handles. |
|
|
IsLoadingInProgress() |
True if load is still ongoing and we haven't been cancelled |
|
|
IsStalled() |
If this handle is stalled and waiting for another event to occur before it is actually requested |
|
|
ReleaseHandle() |
Release this handle. |
|
|
SetDebugNameIfEmptyOrDefault ( |
Allows user code to provide a more detailed name in the cases where a name is autogenerated or otherwise default. |
|
|
StartStalledHandle() |
Tells a stalled handle to start its actual request. |
|
|
EAsyncPackag... |
WaitUntilComplete ( |
Blocks until the requested assets have loaded. |
|
WasCanceled() |
If this request was cancelled. |
Name | Description | ||
---|---|---|---|
|
FStreamableH... |
operator= ( |