FUObjectAnnotationSparseSearchable

[FUObjectAnnotationSparseSearchable](API\Runtime\CoreUObject\UObject\FUObjectAnnotationSparseSearchab-) 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.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

CoreUObject

Header

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

Include

#include "UObject/UObjectAnnotation.h"

Syntax

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

Remarks

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

Destructors

Name Description

Public function Virtual

~FUObjectAnnotationSparseSearchable()

Destructor, removes all annotations, which removes the annotation as a uobject destruction listener

Functions

Name Description

Public function

void

 

AddAnnotation

(
    const UObjectBase* Object,
    const TAnnotation& Annotation
)

Add an annotation to the annotation list.

Public function

void

 

AddAnnotation

(
    const UObjectBase* Object,
    TAnnotation&& Annotation
)

Public function

UObject *...

 

Find

(
    const TAnnotation& Annotation
)

Find the UObject associated with a given annotation

Public function

void

 

RemoveAllAnnotations()

Removes all annotation from the annotation list.

Public function

void

 

RemoveAnnotation

(
    const UObjectBase* Object
)

Removes an annotation from the annotation list.

Overridden from FUObjectAnnotationSparse

Name Description

Public function Virtual

void

 

NotifyUObjectDeleted

(
    const UObjectBase* Object,
    int32 Index
)

Interface for FUObjectAllocator::FUObjectDeleteListener

Overridden from FUObjectDeleteListener

Name Description

Public function Virtual

void

 

OnUObjectArrayShutdown()

Called when UObject Array is being shut down, this is where all listeners should be removed from it

Typedefs

Name

Description

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