UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FStreamLevelAction Class Reference

#include <LevelStreaming.h>

+ Inheritance diagram for FStreamLevelAction:

Public Member Functions

ENGINE_API FStreamLevelAction (bool bIsLoading, const FName &InLevelName, bool bIsMakeVisibleAfterLoad, bool bShouldBlock, const FLatentActionInfo &InLatentInfo, UWorld *World)
 
ENGINE_API void ActivateLevel (ULevelStreaming *LevelStreamingObject)
 
ENGINE_API bool UpdateLevel (ULevelStreaming *LevelStreamingObject)
 
virtual ENGINE_API void UpdateOperation (FLatentResponse &Response) override
 
- Public Member Functions inherited from FPendingLatentAction
 FPendingLatentAction ()
 
virtual ~FPendingLatentAction ()
 
virtual void NotifyObjectDestroyed ()
 
virtual void NotifyActionAborted ()
 

Static Public Member Functions

static ENGINE_API FString MakeSafeLevelName (const FName &InLevelName, UWorld *InWorld)
 
static ENGINE_API ULevelStreamingFindAndCacheLevelStreamingObject (const FName LevelName, UWorld *InWorld)
 

Public Attributes

bool bLoading
 
bool bMakeVisibleAfterLoad
 
bool bShouldBlock
 
TWeakObjectPtr< ULevelStreamingLevel
 
FName LevelName
 
FLatentActionInfo LatentInfo
 

Constructor & Destructor Documentation

◆ FStreamLevelAction()

FStreamLevelAction::FStreamLevelAction ( bool  bIsLoading,
const FName InLevelName,
bool  bIsMakeVisibleAfterLoad,
bool  bShouldBlock,
const FLatentActionInfo InLatentInfo,
UWorld World 
)

Member Function Documentation

◆ ActivateLevel()

void FStreamLevelAction::ActivateLevel ( ULevelStreaming LevelStreamingObject)

Handles "Activated" for single ULevelStreaming object.

Parameters
LevelStreamingObjectLevelStreaming object to handle "Activated" for.

◆ FindAndCacheLevelStreamingObject()

ULevelStreaming * FStreamLevelAction::FindAndCacheLevelStreamingObject ( const FName  LevelName,
UWorld InWorld 
)
static

Helper function to potentially find a level streaming object by name and cache the result

Parameters
LevelNameName of level to search streaming object for in case Level is NULL
Returns
level streaming object or NULL if none was found

Helper function to potentially find a level streaming object by name

Parameters
LevelNameName of level to search streaming object for in case Level is NULL
Returns
level streaming object or NULL if none was found

◆ MakeSafeLevelName()

FString FStreamLevelAction::MakeSafeLevelName ( const FName InLevelName,
UWorld InWorld 
)
static

Given a level name, returns level name that will work with Play on Editor or Play on Console

Parameters
InLevelNameRaw level name (no UEDPIE or UED<console> prefix)

Given a level name, returns a level name that will work with Play on Editor or Play on Console

Parameters
InLevelNameRaw level name (no UEDPIE or UED<console> prefix)
InWorldWorld in which to check for other instances of the name

◆ UpdateLevel()

bool FStreamLevelAction::UpdateLevel ( ULevelStreaming LevelStreamingObject)

Handles "UpdateOp" for single ULevelStreaming object.

Parameters
LevelStreamingObjectLevelStreaming object to handle "UpdateOp" for.
Returns
true if operation has completed, false if still in progress

◆ UpdateOperation()

void FStreamLevelAction::UpdateOperation ( FLatentResponse Response)
overridevirtual

Reimplemented from FPendingLatentAction.

Member Data Documentation

◆ bLoading

bool FStreamLevelAction::bLoading

◆ bMakeVisibleAfterLoad

bool FStreamLevelAction::bMakeVisibleAfterLoad

◆ bShouldBlock

bool FStreamLevelAction::bShouldBlock

◆ LatentInfo

FLatentActionInfo FStreamLevelAction::LatentInfo

◆ Level

TWeakObjectPtr<ULevelStreaming> FStreamLevelAction::Level

◆ LevelName

FName FStreamLevelAction::LevelName

The documentation for this class was generated from the following files: