1. Epic GamesDeveloper
  3. FReferenceCollector

FReferenceCollector

Used by garbage collector to collect references via virtual AddReferencedObjects calls

Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject

Inheritance Hierarchy

References

   
Module CoreUObject
Header /Engine/Source/Runtime/CoreUObject/Public/UObject/UObjectGlobals.h
Include #include "UObject/UObjectGlobals.h"

Syntax

class FReferenceCollector

Remarks

Used by garbage collector to collect references via virtual AddReferencedObjects calls

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddPropertyReferences ( const UStruct* Struct,
void* Instance,
const UObject* ReferencingObject
)

 Adds all strong property references from a struct instance, but not the struct itself.
Public function void

AddPropertyReferencesLimitedToObjectProperties ( const UStruct* Struct,
void* Instance,
const UObject* ReferencingObject
)

 Internal use only.
Public function void

AddPropertyReferencesWithStructARO ( const UClass* Class,
void* Instance,
const UObject* ReferencingObject
)

 Same as AddPropertyReferences but also calls AddStructReferencedObjects on all nested structs
Public function void

AddPropertyReferencesWithStructARO ( const UScriptStruct* Struct,
void* Instance,
const UObject* ReferencingObject
)

 Same as AddPropertyReferences but also calls AddStructReferencedObjects on Struct and all nested structs
Public function void

AddReferencedObject ( TObjectPtr< const UObjectType >& Object,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds const object reference, this reference can still be nulled out if forcefully collected.
Public function void

AddReferencedObject ( TObjectPtr< UObjectType >& Object,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds object reference.
Public function void

AddReferencedObject ( const UObjectType*& Object,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds const object reference, this reference can still be nulled out if forcefully collected.
Public function void

AddReferencedObject ( UObjectType*& Object,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds object reference.
Public function void

AddReferencedObject ( TWeakObjectPtr< T >& P,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObject ( FWeakObjectPtr& P,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( TSet< TObjectPtr< UObjectType > >& ObjectSet,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to a set of objects.
Public function void

AddReferencedObjects ( TMapBase< KeyType*, ValueType*, Allocator, KeyFuncs >& Map,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( TMapBase< KeyType, ValueType*, Allocator, KeyFuncs >& Map,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( TMapBase< KeyType*, ValueType, Allocator, KeyFuncs >& Map,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to a map of objects.
Public function void

AddReferencedObjects ( TArray< const UObjectType* >& ObjectArray,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to an array of const objects, these objects can still be nulled out if forcefully collected.
Public function void

AddReferencedObjects ( TMapBase< TObjectPtr< KeyType >, ValueType, Allocator, KeyFuncs >& Map,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to a map of objects.
Public function void

AddReferencedObjects ( TMapBase< KeyType, TObjectPtr< ValueType >, Allocator, KeyFuncs >& Map,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( TMapBase< TObjectPtr< KeyType >, TObjectPtr< ValueType >, Allocator, KeyFuncs >& Map,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( const UScriptStruct*& ScriptStruct,
void* Instance,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds all strong property references from a UScriptStruct instance including the struct itself
Public function void

AddReferencedObjects ( TObjectPtr< const UScriptStruct >& ScriptStruct,
void* Instance,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( TWeakObjectPtr< const UScriptStruct >& ScriptStruct,
void* Instance,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

  
Public function void

AddReferencedObjects ( TArray< TObjectPtr< const UObjectType > >& ObjectArray,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to an array of const objects, these objects can still be nulled out if forcefully collected.
Public function void

AddReferencedObjects ( TArray< TObjectPtr< UObjectType > >& ObjectArray,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to an array of objects.
Public function void

AddReferencedObjects ( TSet< UObjectType* >& ObjectSet,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to a set of objects.
Public function void

AddReferencedObjects ( TArray< UObjectType* >& ObjectArray,
const UObject* ReferencingObject,
const FProperty* ReferencingProperty
)

 Adds references to an array of objects.
Public function void

AddStableReference ( TObjectPtr< UObjectType >* Object
)

  
Public function Virtual void Preferred way to add a reference that allows batching.
Public function Virtual void Preferred way to add a reference that allows batching.
Public function void

AddStableReference ( UObjectType** Object
)

  
Public function Virtual void Preferred way to add a reference array that allows batching.
Public function Virtual void Preferred way to add a reference array that allows batching.
Public function void

AddStableReferenceArray ( TArray< TObjectPtr< UObjectType > >* Objects
)

  
Public function void

AddStableReferenceArray ( TArray< UObjectType* >* Objects
)

  
Public function FORCEINLINE_DEBUGGABLE void

AddStableReferenceMap ( TMapBase< KeyType, ValueType, Allocator, KeyFuncs >& Map
)

  
Public function Virtual void Preferred way to add a reference set that allows batching. Can't be used for temporary/stack set.
Public function Virtual void Preferred way to add a reference set that allows batching. Can't be used for temporary/stack set.
Public function void

AddStableReferenceSet ( TSet< UObjectType* >* Objects
)

  
Public function void

AddStableReferenceSet ( TSet< TObjectPtr< UObjectType > >* Objects
)

  
Public function Virtual void

AllowEliminatingReferences ( bool bAllow
)

 Allows reference elimination by this collector.
Public function Virtual Const FProperty * Gets the property that is currently being serialized
Public function FReferenceCollectorArchive & Get archive to collect references via SerializeBin / Serialize.
Protected function void

HandleObjectReference ( UObject*& InObject,
const UObject* InReferencingObject,
const FProperty* InReferencingProperty
)

 Handle object reference. Called by AddReferencedObject.
Protected function Virtual void

HandleObjectReferences ( FObjectPtr* InObjects,
const int32 ObjectNum,
const UObject* InReferencingObject,
const FProperty* InReferencingProperty
)

 Handle multiple object references.
Protected function Virtual void

HandleObjectReferences ( UObject** InObjects,
const int32 ObjectNum,
const UObject* InReferencingObject,
const FProperty* InReferencingProperty
)

 Handle multiple object references.
Public function Const bool If true archetype references should not be added to this collector.
Public function Const bool If true transient objects should not be added to this collector.
Public function Virtual Const bool If true, this collector is currently processing native references (true by default).
Public function Virtual bool

MarkWeakObjectReferenceForClearing ( UObject** WeakReference,
UObject* ReferenceOwner
)

 Marks a specific object reference as a weak reference.
Public function Virtual Const bool Used by parallel reachability analysis to pre-collect and then exclude some initial FGCObject references
Public function Virtual Const bool Make Add[OnlyObject]PropertyReference/AddReferencedObjects(UScriptStruct) use AddReferencedObjects(UObject*&) callbacks with ReferencingObject and ReferencingProperty context supplied and check for null references before making a callback.
Public function Virtual void

SetIsProcessingNativeReferences ( bool bIsNative
)

 Sets whether this collector is currently processing native references or not.
Public function Virtual void Sets the property that is currently being serialized

Classes

  Type Name Description
Public struct AROPrivate    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.