1. Epic GamesDeveloper
  3. FReferenceChainSearch

FReferenceChainSearch

API > API/Runtime > API/Runtime/CoreUObject

   
Name FReferenceChainSearch
Type class
Header File /Engine/Source/Runtime/CoreUObject/Public/UObject/ReferenceChainSearch.h
Include Path #include "UObject/ReferenceChainSearch.h"

Syntax

class FReferenceChainSearch

Constructors

Name Remarks Include Path Unreal Specifiers

FReferenceChainSearch ( TConstArrayView< UObject* > InObjectsToFindReferencesTo,
EReferenceChainSearchMode Mode,
ELogVerbosity::Type InVerbosityForPrint
)

   UObject/ReferenceChainSearch.h  

FReferenceChainSearch ( UObject* InObjectToFindReferencesTo,
EReferenceChainSearchMode Mode,
ELogVerbosity::Type InVerbosityForPrint
)

 Constructs a new search engine and finds references to the specified object UObject/ReferenceChainSearch.h  
Constructs a new search engine but does not find references to any objects until one of the PerformSearch*() functions is called UObject/ReferenceChainSearch.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FReferenceChainSearch()

 Destructor UObject/ReferenceChainSearch.h  

Classes

Name Remarks
FReferenceChain Reference chain.

Structs

Name Remarks
FCallbackParams Parameters passed to callback function when printing results
FGraphNode Single node in the reference graph
TReferenceInfo Extended information about a reference

Enums

Public

Name Remarks
EReferenceType Type of reference

Typedefs

Name Type Remarks Include Path
FNodeReferenceInfo TReferenceInfo< FGraphNode >   UObject/ReferenceChainSearch.h
FObjectReferenceInfo TReferenceInfo< FGCObjectInfo > Convenience type definitions to avoid template hell UObject/ReferenceChainSearch.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllNodes TMap< FGCObjectInfo *, FGraphNode * > All nodes created during the search UObject/ReferenceChainSearch.h  
ObjectInfosToFindReferencesTo TArray< FGCObjectInfo * > The objects we're going to look for references to UObject/ReferenceChainSearch.h  
ObjectToInfoMap TMap< const UObject *, FGCObjectInfo * > Maps UObject pointers to object info structs UObject/ReferenceChainSearch.h  
ReferenceChains TArray< FReferenceChain * > All reference chain found during the search, one per entry in ObjectsToFindReferencesTo UObject/ReferenceChainSearch.h  
SearchMode EReferenceChainSearchMode Search mode and options UObject/ReferenceChainSearch.h  
SuspendGameThreadHitch FDisableHitchDetectorScope   UObject/ReferenceChainSearch.h  
SuspendHeartBeat FSlowHeartBeatScope Reference chain searching is a very slow operation. UObject/ReferenceChainSearch.h  
VerbosityForPrint ELogVerbosity::Type   UObject/ReferenceChainSearch.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int64 GetAllocatedSize()

   UObject/ReferenceChainSearch.h  

const TArray< FReferenceChain * > & GetReferenceChains()

 Returns all reference chains UObject/ReferenceChainSearch.h  

FString GetRootPath ( UObject* TargetObject
) const

 Returns a string with a short report explaining the root path, will contain newlines UObject/ReferenceChainSearch.h  

FString GetRootPath ( TFunctionRef< bool(FCallbackParams&Params)> ReferenceCallback,
UObject* TargetObject
) const

 Returns a string with a short report explaining the root path, will contain newlines UObject/ReferenceChainSearch.h  

void PerformSearchFromGCSnapshot ( UObject* InObjectToFindReferencesTo,
FGCSnapshot& InSnapshot
)

 Searches for references in a previous GC run snapshot temporarily acquiring its object info UObject/ReferenceChainSearch.h  

void PerformSearchFromGCSnapshot ( TConstArrayView< UObject* > InObjectsToFindReferencesTo,
FGCSnapshot& InSnapshot
)

   UObject/ReferenceChainSearch.h  

int32 PrintResults ( bool bDumpAllChains,
UObject* TargetObject,
ELogVerbosity::Type VerbosityForPrint
) const

 Dumps results to log UObject/ReferenceChainSearch.h  

int32 PrintResults ( TFunctionRef< bool(FCallbackParams&Params)> ReferenceCallback,
bool bDumpAllChains,
UObject* TargetObject,
ELogVerbosity::Type VerbosityForPrint
) const

 Dumps results to log UObject/ReferenceChainSearch.h  

void SetVerbosityForPrint ( ELogVerbosity::Type Verbosity
)

   UObject/ReferenceChainSearch.h  

Static

Name Remarks Include Path Unreal Specifiers

static void DumpChain ( FReferenceChainSearch::FReferenceChain* Chain,
TFunctionRef< bool(FCallbackParams&Params)> ReferenceCallback,
TMap< uint64, FString >& CallstackCache,
FOutputDevice& Out,
ELogVerbosity::Type InVerbosityForPrint
)

 Dumps a reference chain to log UObject/ReferenceChainSearch.h  

static FString FindAndPrintStaleReferencesToObject ( UObject* ObjectToFindReferencesTo,
EPrintStaleReferencesOptions Options
)

 Attempts to find a reference chain leading to a world that should have been garbage collected UObject/ReferenceChainSearch.h  

static TArray< FString > FindAndPrintStaleReferencesToObjects ( TConstArrayView< UObject* > ObjectsToFindReferencesTo,
EPrintStaleReferencesOptions Options
)

   UObject/ReferenceChainSearch.h  

static FString GetObjectFlags ( const FGCObjectInfo& InObject
)

 Returns a string with all flags (we care about) set on an object UObject/ReferenceChainSearch.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page