UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FLevelStreamingGCHelper Struct Reference

#include <LevelStreamingGCHelper.h>

Public Member Functions

 DECLARE_MULTICAST_DELEGATE (FOnGCStreamedOutLevelsEvent)
 

Static Public Member Functions

static ENGINE_API void AddGarbageCollectorCallback ()
 
static ENGINE_API void RequestUnload (ULevel *InLevel)
 
static ENGINE_API void CancelUnloadRequest (ULevel *InLevel)
 
static ENGINE_API int32 GetNumLevelsPendingPurge ()
 
static ENGINE_API void TrashPackage (UPackage *InPackage)
 
static ENGINE_API void EnableForCommandlet ()
 

Static Public Attributes

static ENGINE_API FOnGCStreamedOutLevelsEvent OnGCStreamedOutLevels
 

Detailed Description

Helper structure encapsulating functionality used to defer marking actors and their components as pending kill till right before garbage collection by registering a callback.

Member Function Documentation

◆ AddGarbageCollectorCallback()

void FLevelStreamingGCHelper::AddGarbageCollectorCallback ( )
static

Register with the garbage collector to receive callbacks pre and post garbage collection

◆ CancelUnloadRequest()

void FLevelStreamingGCHelper::CancelUnloadRequest ( ULevel InLevel)
static

Cancel any pending unload requests for passed in Level.

◆ DECLARE_MULTICAST_DELEGATE()

FLevelStreamingGCHelper::DECLARE_MULTICAST_DELEGATE ( FOnGCStreamedOutLevelsEvent  )

Called when streamed out levels are going to be garbage collected

◆ EnableForCommandlet()

void FLevelStreamingGCHelper::EnableForCommandlet ( )
static

Allows FLevelStreamingGCHelper to be used in a commandlet.

◆ GetNumLevelsPendingPurge()

int32 FLevelStreamingGCHelper::GetNumLevelsPendingPurge ( )
static
Returns
The number of levels pending a purge by the garbage collector

◆ RequestUnload()

void FLevelStreamingGCHelper::RequestUnload ( ULevel InLevel)
static

Request to be unloaded.

Parameters
InLevelLevel that should be unloaded

◆ TrashPackage()

void FLevelStreamingGCHelper::TrashPackage ( UPackage InPackage)
static

Trash a package, making sure it will be reloaded if needed again by level streaming

Member Data Documentation

◆ OnGCStreamedOutLevels

FLevelStreamingGCHelper::FOnGCStreamedOutLevelsEvent FLevelStreamingGCHelper::OnGCStreamedOutLevels
static

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