FGantryLoadScopeInfo
A copy of one load scope's state: its name, kind, asset counts, elapsed time and whether it has closed.
This is what a loading screen reads to show a line such as "Loading the arena (37/120)": Debug Name, then Loaded Count over Requested Count. It is a copy, so keep it and read it whenever you like; it does not change as the load goes on. Take a fresh one each frame.
In Blueprint, get one from Get Primary Scope or a snapshot's Active Scopes, and measure it with Get Scope Progress and Is Scope Finished.
Properties
| Property | Type | Default | Description |
|---|---|---|---|
Handle read-only | FGantryHandle | (Index=-1) | Ledger handle for this scope; it goes stale as soon as the scope closes. |
ParentHandle read-only | FGantryHandle | (Index=-1) | Scope this one is nested in, or an invalid handle for a root scope. Informational only: the ledger does not fold a child's counts into its parent. |
DebugName read-only | FString | Human readable name a loading bar can show, e.g. "Experience: Arena". | |
ReasonTag read-only | FGameplayTag | () | What kind of work this is, e.g. Gantry.Load.Scope.Experience. |
State read-only | EGantryLoadState | Pending | Where the scope is in its lifecycle; open scopes are Pending or Loading. |
RequestedCount read-only | int32 | 0 | Assets requested across every streamable handle attached to the scope, plus manual work. |
LoadedCount read-only | int32 | 0 | Requested assets that have finished loading, including completed manual work. |
ElapsedSeconds read-only | float | 0.000000 | Seconds since the scope opened, frozen at the moment it closed. |
bUserFacing read-only | bool | True | True when a loading bar should count this scope; false for background work. |
C++
Public C++ members that Blueprint does not see.
GetProgress
float
Returns the fraction of requested assets that have loaded, from 0 to 1.
A scope that requested nothing reads 0 while open and 1 once closed, whatever its final state. In Blueprint this is Get Scope Progress.
IsFinished
bool
Returns true once the scope has closed, whatever the outcome.
Blueprint: Is Scope Finished.