FReferenceCollector

[FReferenceCollector](API\Runtime\CoreUObject\UObject\FReferenceCollector).

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class FReferenceCollector

Remarks

FReferenceCollector. Helper class used by the garbage collector to collect object references.

Constructors

Name Description

Public function

FReferenceCollector()

Destructors

Name Description

Public function Virtual

~FReferenceCollector()

Functions

Name Description

Public function

void

 

AddReferencedObject

(
    UObjectType*& Object,
    const UObject* ReferencingObje...,
    const UProperty* ReferencingPr...
)

Adds object reference.

Public function

void

 

AddReferencedObjects

(
    TMapBase< KeyType*, ValueType,...,
    const UObject* ReferencingObje...,
    const UProperty* ReferencingPr...
)

Adds references to a map of objects.

Public function

void

 

AddReferencedObjects

(
    TSet< UObjectType* >& ObjectS...,
    const UObject* ReferencingObje...,
    const UProperty* ReferencingPr...
)

Adds references to a set of objects.

Public function

void

 

AddReferencedObjects

(
    TArray< UObjectType* >& Objec...,
    const UObject* ReferencingObje...,
    const UProperty* ReferencingPr...
)

Adds references to an array of objects.

Public function

void

 

AddReferencedObjects

(
    TMapBase< KeyType, ValueType*,...,
    const UObject* ReferencingObje...,
    const UProperty* ReferencingPr...
)

Public function

void

 

AddReferencedObjects

(
    TMapBase< KeyType*, ValueType ...,
    const UObject* ReferencingObje...,
    const UProperty* ReferencingPr...
)

Public function Virtual

void

 

AllowEliminatingReferences

(
    bool bAllow
)

Allows reference elimination by this collector.

Public function

FReferenceCo...

 

GetInternalPersistentFrameReferenceCollectorArchive()

INTERNAL USE ONLY: returns the persistent frame collector archive associated with this collector.

Public function Virtual Const

UProperty &#...

 

GetSerializedProperty()

Gets the property that is currently being serialized

Public function

FReferenceCo...

 

GetVerySlowReferenceCollectorArchive()

Returns the collector archive associated with this collector.

Protected function

void

 

HandleObjectReference

(
    UObject*& InObject,
    const UObject* InReferencingOb...,
    const UProperty* InReferencing...
)

Handle object reference. Called by AddReferencedObject.

Protected function Virtual

void

 

HandleObjectReferences

(
    UObject** InObjects,
    const int32 ObjectNum,
    const UObject* InReferencingOb...,
    const UProperty* InReferencing...
)

Handle multiple object references.

Public function Const

bool

 

IsIgnoringArchetypeRef()

If true archetype references should not be added to this collector.

Public function Const

bool

 

IsIgnoringTransient()

If true transient objects should not be added to this collector.

Public function Virtual

bool

 

MarkWeakObjectReferenceForClearing

(
    UObject** WeakReference
)

Marks a specific object reference as a weak reference.

Public function Virtual

void

 

SetSerializedProperty

(
    UProperty* Inproperty
)

Sets the property that is currently being serialized

References

Module

CoreUObject

Header

Runtime/CoreUObject/Public/UObject/UObjectGlobals.h

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback