UTypedElementRegistry

Registry of element types and their associated interfaces, along with the elements that represent their instances.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UTypedElementRegistry

References

Module	TypedElementFramework
Header	/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementRegistry.h
Include	#include "Elements/Framework/TypedElementRegistry.h"

Syntax

class UTypedElementRegistry : public UObject

Remarks

Registry of element types and their associated interfaces, along with the elements that represent their instances.

Constructors

	Name	Description
	UTypedElementRegistry()

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
FTypedElemen...	CreateElement ( const FName InElementTypeName, const FTypedHandleElementId InEleme... )	Create an element that doesn't require any additional payload data.
TTypedElemen...	CreateElement ( const FName InElementTypeName )	Create an element that has additional payload data.
FTypedElemen...	CreateElementList ( TArrayView< const TTypedElementOwne... )	Create an empty list of elements associated with this registry, populated from the given owners that are valid.
FTypedElemen...	CreateElementList ( const TArray< TTypedElementOwner< E... )	Create an empty list of elements associated with this registry, populated from the given owners that are valid.
FTypedElemen...	CreateElementList ( TArrayView< const FTypedElementHand... )	Create an empty list of elements associated with this registry, populated from the given handles that are valid.
FTypedElemen...	CreateElementList ( TArrayView< const FTypedElementId >... )	Create an empty list of elements associated with this registry, populated from the given minimal IDs that are valid.
FTypedElemen...	CreateElementList()	Create an empty list of elements associated with this registry.
void	DestroyElement ( TTypedElementOwner< ElementDataType... )	Destroy an element.
void	DestroyElement ( FTypedElementOwner& InOutElementOw... )	Destroy an element.
TTypedElemen...	GetElement ( const FTypedElementHandle& InEleme... )	Get an element that implements the given interface from its handle.
TTypedElemen...	GetElement ( const FTypedElementId& InElementId )	Get an element that implements the given interface from its minimal ID.
FTypedElemen...	GetElement ( const FTypedElementId& InElementId, const TSubclassOf< UInterface >& I... )	Get an element that implements the given interface from its minimal ID.
FTypedElemen...	GetElement ( const FTypedElementHandle& InEleme..., const TSubclassOf< UInterface >& I... )	Get an element that implements the given interface from its handle.
FTypedElemen...	GetElementHandle ( const FTypedElementId& InElementId )	Get an element handle from its minimal ID.
UObject *...	GetElementInterface ( const FTypedElementHandle& InEleme..., const TSubclassOf< UInterface > InB... )	Get the element interface supported by the given handle, or null if there is no support for this interface.
BaseInterfac...	GetElementInterface ( const FTypedElementHandle& InEleme... )	Get the element interface supported by the given handle, or null if there is no support for this interface.
BaseInterfac...	GetElementInterface ( const FTypedHandleTypeId InElementT... )	Get the element interface supported by the given type, or null if there is no support for this interface.
UTypedElemen...	GetInstance()	Get the singleton instance of the registry used in most cases.
FTypedHandle...	GetRegisteredElementTypeId ( const FName InElementTypeName )	Get the element type ID for the associated element type name, if any.
FName	GetRegisteredElementTypeName ( const FTypedHandleTypeId InElementT... )	Get the element type name for the associated element type ID, if any.
FOnElementRe...	OnElementReplaced()
FOnElementUp...	OnElementUpdated()
FSimpleMulti...	OnProcessingDeferredElementsToDestroy()	Event fired prior to processing any elements that were previously marked for deferred destruction.
void	Private_GetElementImpl ( const FTypedElementHandle& InEleme..., const TSubclassOf< UInterface >& I..., FTypedElement& OutElement )
void	Private_InitializeInstance()	Initialize the singleton instance of the registry used in most cases.
void	Private_OnElementListCreated ( FTypedElementList* InElementLi... )
void	Private_OnElementListDestroyed ( FTypedElementList* InElementLi... )
void	Private_ShutdownInstance()	Shutdown the singleton instance of the registry used in most cases.
void	ProcessDeferredElementsToDestroy()	Process any elements that were previously marked for deferred destruction.
void	RegisterElementInterface ( const FName InElementTypeName, UObject* InElementInterface, const bool InAllowOverride )	Register that an element interface is supported for the given type, which must have previously been registered via RegisterElementType.
void	RegisterElementType ( const FName InElementTypeName )	Register an element type that has additional payload data.
void	RegisterElementType ( const FName InElementTypeName )	Register an element type that doesn't require any additional payload data.
FString	RegistredElementTypesAndInterfacesToString()	Extract a string that contains name of the type elements registered.
void	ReleaseElementId ( FTypedElementId& InOutElementId )	Release an element ID that was previously acquired from an existing handle.

Overridden from UObject

		Name	Description
	void	FinishDestroy()	Called to finish destroying the object.

Classes

	Name	Description
	FDisableElementDestructionOnGC	Struct to disable auto-GC reference collection within a scope

Typedefs

Name	Description
FOnElementReplaced
FOnElementReplaced_Payload	Event fired when references to one element should be replaced with a reference to a different element.
FOnElementUpdated	Event fired when an element has been internally updated and data cached from it should be refreshed.