FUObjectAnnotationSparseSearchable | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/CoreUObject

FUObjectAnnotationSparseSearchable is a helper class that is used to store sparse, slow, temporary, editor only, external or other low priority information about UObjects...and also provides the ability to find a object based on the unique annotation.

All of the restrictions mentioned for FUObjectAnnotationSparse apply


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

Syntax

template<typename TAnnotation, bool bAutoRemove>  
class FUObjectAnnotationSparseSearchable : public FUObjectAnnotationSparse< TAnnotation, bAutoRemove >

Inheritance Hierarchy

FUObjectArray::FUObjectDeleteListener → FUObjectAnnotationSparse → FUObjectAnnotationSparseSearchable

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FUObjectAnnotationSparseSearchable()	Destructor, removes all annotations, which removes the annotation as a uobject destruction listener	UObject/UObjectAnnotation.h

Typedefs

Name	Type	Remarks	Include Path
Super	FUObjectAnnotationSparse< TAnnotation, bAutoRemove >		UObject/UObjectAnnotation.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
InverseAnnotationMap	TMap< TAnnotation, const UObjectBase * >	Inverse Map annotation to live object	UObject/UObjectAnnotation.h
InverseAnnotationMapCritical	FTransactionallySafeCriticalSection		UObject/UObjectAnnotation.h

Functions

Public

Name	Remarks	Include Path
void AddAnnotation ( const UObjectBase* Object, const TAnnotation& Annotation )	Add an annotation to the annotation list.	UObject/UObjectAnnotation.h
void AddAnnotation ( const UObjectBase* Object, TAnnotation&& Annotation )		UObject/UObjectAnnotation.h
UObject * Find ( const TAnnotation& Annotation )	Find the UObject associated with a given annotation	UObject/UObjectAnnotation.h
void RemoveAllAnnotations()	Removes all annotation from the annotation list.	UObject/UObjectAnnotation.h
void RemoveAnnotation ( const UObjectBase* Object )	Removes an annotation from the annotation list.	UObject/UObjectAnnotation.h

Overridden from FUObjectAnnotationSparse

Name	Remarks	Include Path	Unreal Specifiers
virtual void NotifyUObjectDeleted ( const UObjectBase* Object, int32 Index )	Interface for FUObjectAllocator::FUObjectDeleteListener	UObject/UObjectAnnotation.h

Overridden from FUObjectDeleteListener

Name	Remarks	Include Path	Unreal Specifiers
virtual SIZE_T GetAllocatedSize()	Returns the size of heap memory allocated internally by this listener	UObject/UObjectAnnotation.h
virtual void OnUObjectArrayShutdown()	Called when UObject Array is being shut down, this is where all listeners should be removed from it	UObject/UObjectAnnotation.h

Navigation