FReferenceCollector

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/UObjectGlobals.h

Include

#include "UObject/UObjectGlobals.h"

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

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

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

Public function

void

 

AddReferencedObject

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

Adds object reference.

Public function

void

 

AddReferencedObjects

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

Adds references to a map of objects.

Public function

void

 

AddReferencedObjects

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

Adds references to a set of objects.

Public function

void

 

AddReferencedObjects

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

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

Public function

void

 

AddReferencedObjects

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

Adds references to an array of objects.

Public function

void

 

AddReferencedObjects

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

Public function

void

 

AddReferencedObjects

(
    TMapBase< KeyType*, ValueType ...,
    const UObject* ReferencingObje...,
    const FProperty* 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

FProperty &#...

 

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 FProperty* InReferencing...
)

Handle object reference. Called by AddReferencedObject.

Protected function Virtual

void

 

HandleObjectReferences

(
    UObject** InObjects,
    const int32 ObjectNum,
    const UObject* InReferencingOb...,
    const FProperty* 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

(
    FProperty* Inproperty
)

Sets the property that is currently being serialized

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss