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

#include <GCObjectInfo.h>

Public Member Functions

 FGCObjectInfo ()=default
 
 FGCObjectInfo (const UObject *Obj)
 
COREUOBJECT_API UObjectTryResolveObject ()
 
FGCObjectInfoGetClass () const
 
FGCObjectInfoGetOuter () const
 
bool IsIn (const FGCObjectInfo *MaybeOuter) const
 
bool HasAnyFlags (EObjectFlags InFlags) const
 
bool HasAnyInternalFlags (EInternalObjectFlags InFlags) const
 
bool IsRooted () const
 
bool IsNative () const
 
bool IsGarbage () const
 
int32 GetOwnerIndex () const
 
FString GetClassName () const
 
int32 GetRefCount () const
 
bool IsValid () const
 
bool IsDisregardForGC () const
 
COREUOBJECT_API void GetPathName (FStringBuilderBase &ResultString) const
 
COREUOBJECT_API FString GetPathName () const
 
COREUOBJECT_API FString GetFullName () const
 

Static Public Member Functions

static COREUOBJECT_API FGCObjectInfoFindOrAddInfoHelper (const UObject *InObject, TMap< const UObject *, FGCObjectInfo * > &InOutObjectToInfoMap)
 

Friends

uint32 GetTypeHash (const FGCObjectInfo &Info)
 

Detailed Description

Structure containing information about a UObject participating in Garbage Collection. It's purpose is to avoid holding onto direct references to UObjects which may have already been Garbage Collected. FGCObjectInfo interface mimics that of UObject.

Constructor & Destructor Documentation

◆ FGCObjectInfo() [1/2]

FGCObjectInfo::FGCObjectInfo ( )
default

◆ FGCObjectInfo() [2/2]

FGCObjectInfo::FGCObjectInfo ( const UObject Obj)
inlineexplicit

Member Function Documentation

◆ FindOrAddInfoHelper()

FGCObjectInfo * FGCObjectInfo::FindOrAddInfoHelper ( const UObject InObject,
TMap< const UObject *, FGCObjectInfo * > &  InOutObjectToInfoMap 
)
static

Helper function for adding info about an UObject into UObject to FGCObjectInfo map

◆ GetClass()

FGCObjectInfo * FGCObjectInfo::GetClass ( ) const
inline

◆ GetClassName()

FString FGCObjectInfo::GetClassName ( ) const
inline

◆ GetFullName()

FString FGCObjectInfo::GetFullName ( ) const

◆ GetOuter()

FGCObjectInfo * FGCObjectInfo::GetOuter ( ) const
inline

◆ GetOwnerIndex()

int32 FGCObjectInfo::GetOwnerIndex ( ) const
inline

◆ GetPathName() [1/2]

FString FGCObjectInfo::GetPathName ( ) const

◆ GetPathName() [2/2]

void FGCObjectInfo::GetPathName ( FStringBuilderBase ResultString) const

◆ GetRefCount()

int32 FGCObjectInfo::GetRefCount ( ) const
inline

◆ HasAnyFlags()

bool FGCObjectInfo::HasAnyFlags ( EObjectFlags  InFlags) const
inline

◆ HasAnyInternalFlags()

bool FGCObjectInfo::HasAnyInternalFlags ( EInternalObjectFlags  InFlags) const
inline

◆ IsDisregardForGC()

bool FGCObjectInfo::IsDisregardForGC ( ) const
inline

◆ IsGarbage()

bool FGCObjectInfo::IsGarbage ( ) const
inline

◆ IsIn()

bool FGCObjectInfo::IsIn ( const FGCObjectInfo MaybeOuter) const
inline

◆ IsNative()

bool FGCObjectInfo::IsNative ( ) const
inline

◆ IsRooted()

bool FGCObjectInfo::IsRooted ( ) const
inline

◆ IsValid()

bool FGCObjectInfo::IsValid ( ) const
inline

◆ TryResolveObject()

UObject * FGCObjectInfo::TryResolveObject ( )

Tries to find an existing object matching the stored Path.

Returns
Pointer to an object this info struct represents if the object is still alive, nullptr otherwise

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FGCObjectInfo Info)
friend

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