Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Registry of element types and their associated interfaces, along with the elements that represent their instances.
| Name | UTypedElementRegistry |
| Type | class |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementRegistry.h |
| Include Path | #include "Elements/Framework/TypedElementRegistry.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UTypedElementRegistry : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UTypedElementRegistry
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UTypedElementRegistry() |
Elements/Framework/TypedElementRegistry.h |
Structs
| Name | Remarks |
|---|---|
| FDisableElementDestructionOnGC | Struct to disable auto-GC reference collection within a scope |
| FRegisteredElementType | |
| TRegisteredElementType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnElementReplaced | TMulticastDelegate_OneParam< void, FOnElementReplaced_Payload > | Elements/Framework/TypedElementRegistry.h | |
| FOnElementReplaced_Payload | TArrayView< const TTuple< FTypedElementHandle, FTypedElementHandle > > | Event fired when references to one element should be replaced with a reference to a different element. | Elements/Framework/TypedElementRegistry.h |
| FOnElementUpdated | TMulticastDelegate_OneParam< void, TArrayView< const FTypedElementHandle > > | Event fired when an element has been internally updated and data cached from it should be refreshed. | Elements/Framework/TypedElementRegistry.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveElementLists | TSet< FTypedElementList * > | Elements/Framework/TypedElementRegistry.h | ||
| ActiveElementListsCS | FCriticalSection | Elements/Framework/TypedElementRegistry.h | ||
| ActiveScriptElementLists | TSet< FScriptTypedElementList * > | Elements/Framework/TypedElementRegistry.h | ||
| bIsWithinFrame | bool | Elements/Framework/TypedElementRegistry.h | ||
| DisableElementDestructionOnGCCount | uint8 | Elements/Framework/TypedElementRegistry.h | ||
| OnElementReplacedDelegate | FOnElementReplaced | Elements/Framework/TypedElementRegistry.h | ||
| OnElementUpdatedDelegate | FOnElementUpdated | Elements/Framework/TypedElementRegistry.h | ||
| OnProcessingDeferredElementsToDestroyDelegate | FSimpleMulticastDelegate | Elements/Framework/TypedElementRegistry.h | ||
| RegisteredElementTypes | TUniquePtr< FRegisteredElementType > | Elements/Framework/TypedElementRegistry.h | ||
| RegisteredElementTypesNameToId | TSortedMap< FName, FTypedHandleTypeId, FDefaultAllocator, FNameFastLess > | Elements/Framework/TypedElementRegistry.h | ||
| RegisteredElementTypesRW | FTransactionallySafeRWLock | Elements/Framework/TypedElementRegistry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TTypedElementOwner< ElementDataType > CreateElement
(
const FName InElementTypeName |
Create an element that has additional payload data. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementOwner CreateElement
(
const FName InElementTypeName, |
Create an element that doesn't require any additional payload data. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementListRef CreateElementList () |
Create an empty list of elements associated with this registry. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementListRef CreateElementList
(
TArrayView< const FTypedElementId > InElementIds |
Create an empty list of elements associated with this registry, populated from the given minimal IDs that are valid. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementListRef CreateElementList
(
TArrayView< const FTypedElementHandle > InElementHandles |
Create an empty list of elements associated with this registry, populated from the given handles that are valid. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementListRef CreateElementList
(
const TArray< TTypedElementOwner< ElementDataType > >& InElementOwners |
Create an empty list of elements associated with this registry, populated from the given owners that are valid. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementListRef CreateElementList
(
TArrayView< const TTypedElementOwner< ElementDataType > > InElementOwners |
Create an empty list of elements associated with this registry, populated from the given owners that are valid. | Elements/Framework/TypedElementRegistry.h | |
FScriptTypedElementListRef CreateScriptElementList() |
Create an empty list of script elements associated with this registry. | Elements/Framework/TypedElementRegistry.h | |
FScriptTypedElementHandle CreateScriptHandle
(
const FTypedElementId& InElementId |
Create a script handle. This should only be use for the script exposure apis. | Elements/Framework/TypedElementRegistry.h | |
void DestroyElement
(
FTypedElementOwner& InOutElementOwner |
Destroy an element. | Elements/Framework/TypedElementRegistry.h | |
void DestroyElement
(
TTypedElementOwner< ElementDataType >& InOutElementOwner |
Destroy an element. | Elements/Framework/TypedElementRegistry.h | |
FTypedElement GetElement
(
const FTypedElementHandle& InElementHandle, |
Get an element that implements the given interface from its handle. | Elements/Framework/TypedElementRegistry.h | |
TTypedElement< BaseInterfaceType > GetElement
(
const FTypedElementHandle& InElementHandle |
Get an element that implements the given interface from its handle. | Elements/Framework/TypedElementRegistry.h | |
FTypedElement GetElement
(
const FTypedElementId& InElementId, |
Get an element that implements the given interface from its minimal ID. | Elements/Framework/TypedElementRegistry.h | |
TTypedElement< BaseInterfaceType > GetElement
(
const FTypedElementId& InElementId |
Get an element that implements the given interface from its minimal ID. | Elements/Framework/TypedElementRegistry.h | |
FTypedElementHandle GetElementHandle
(
const FTypedElementId& InElementId |
Get an element handle from its minimal ID. | Elements/Framework/TypedElementRegistry.h | |
BaseInterfaceType * GetElementInterface
(
const FTypedHandleTypeId InElementTypeId |
Get the element interface supported by the given type, or null if there is no support for this interface. | Elements/Framework/TypedElementRegistry.h | |
UObject * GetElementInterface
(
const FScriptTypedElementHandle& InElementHandle, |
Get the element interface supported by the given handle, or null if there is no support for this interface or if the handle is invalid. | Elements/Framework/TypedElementRegistry.h |
|
UObject * GetElementInterface
(
const FTypedElementHandle& InElementHandle, |
Get the element interface supported by the given handle, or null if there is no support for this interface. | Elements/Framework/TypedElementRegistry.h | |
BaseInterfaceType * GetElementInterface
(
const FTypedElementHandle& InElementHandle |
Get the element interface supported by the given handle, or null if there is no support for this interface. | Elements/Framework/TypedElementRegistry.h | |
FTypedHandleTypeId GetRegisteredElementTypeId
(
const FName InElementTypeName |
Get the element type ID for the associated element type name, if any. | Elements/Framework/TypedElementRegistry.h | |
FName GetRegisteredElementTypeName
(
const FTypedHandleTypeId InElementTypeId |
Get the element type name for the associated element type ID, if any. | Elements/Framework/TypedElementRegistry.h | |
FOnElementReplaced & OnElementReplaced() |
Elements/Framework/TypedElementRegistry.h | ||
FOnElementUpdated & OnElementUpdated() |
Elements/Framework/TypedElementRegistry.h | ||
FSimpleMulticastDelegate & OnProcessingDeferredElementsToDestroy () |
Event fired prior to processing any elements that were previously marked for deferred destruction. | Elements/Framework/TypedElementRegistry.h | |
void Private_GetElementImpl
(
const FTypedElementHandle& InElementHandle, |
Note: Access for FTypedElementList. | Elements/Framework/TypedElementRegistry.h | |
void Private_OnElementListCreated
(
FTypedElementList* InElementList |
Elements/Framework/TypedElementRegistry.h | ||
void Private_OnElementListCreated
(
FScriptTypedElementList* InElementList |
Elements/Framework/TypedElementRegistry.h | ||
void Private_OnElementListDestroyed
(
FTypedElementList* InElementList |
Elements/Framework/TypedElementRegistry.h | ||
void Private_OnElementListDestroyed
(
FScriptTypedElementList* InElementList |
Elements/Framework/TypedElementRegistry.h | ||
void ProcessDeferredElementsToDestroy () |
Process any elements that were previously marked for deferred destruction. | Elements/Framework/TypedElementRegistry.h | |
| Register that an element interface is supported for the given type, which must have previously been registered via RegisterElementType. | Elements/Framework/TypedElementRegistry.h | ||
void RegisterElementType
(
const FName InElementTypeName |
Register an element type that has additional payload data. | Elements/Framework/TypedElementRegistry.h | |
void RegisterElementType
(
const FName InElementTypeName, |
Register an element type that doesn't require any additional payload data. | Elements/Framework/TypedElementRegistry.h | |
| Extract a string that contains name of the type elements registered. | Elements/Framework/TypedElementRegistry.h | ||
void ReleaseElementId
(
FTypedElementId& InOutElementId |
Release an element ID that was previously acquired from an existing handle. | Elements/Framework/TypedElementRegistry.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void FinishDestroy() |
Elements/Framework/TypedElementRegistry.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddReferencedObjects
(
UObject* InThis, |
Elements/Framework/TypedElementRegistry.h | ||
static UTypedElementRegistry * GetInstance() |
Get the singleton instance of the registry used in most cases. | Elements/Framework/TypedElementRegistry.h |
|
static void Private_InitializeInstance() |
Initialize the singleton instance of the registry used in most cases. | Elements/Framework/TypedElementRegistry.h | |
static void Private_ShutdownInstance() |
Shutdown the singleton instance of the registry used in most cases. | Elements/Framework/TypedElementRegistry.h |