Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
The most minimal representation of an element - its ID! This type is not immediately useful on its own, but can be used to find an element from the element registry or an element list.
This is ref-counted like handles themselves are, so as long as an ID is available, the handle will be too.
IDs lack the information needed to auto-release on destruction, so must be manually released, either via the corresponding handle or their owner element registry.
| Name | FTypedElementId |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementId.h |
| Include Path | #include "Elements/Framework/TypedElementId.h" |
Syntax
struct FTypedElementId
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Elements/Framework/TypedElementId.h | |||
FTypedElementId
(
const FTypedElementId& |
Elements/Framework/TypedElementId.h | ||
FTypedElementId
(
FTypedElementId&& InOther |
Elements/Framework/TypedElementId.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FTypedElementId() |
Elements/Framework/TypedElementId.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Unset | const FTypedElementId | An unset element ID | Elements/Framework/TypedElementId.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CombinedId | FTypedHandleCombinedId | Elements/Framework/TypedElementId.h | ||
| ElementId | FTypedHandleCombinedId | Note: These are arranged in this order to give CombinedId better hash distribution for GetTypeHash! | Elements/Framework/TypedElementId.h | |
| TypeId | FTypedHandleCombinedId | Elements/Framework/TypedElementId.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FTypedElementId | union FTypedElementId | Elements/Framework/TypedElementId.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTypedHandleCombinedId GetCombinedId () |
Access the combined value of this element ID. | Elements/Framework/TypedElementId.h | |
FTypedHandleElementId GetElementId() |
Access the element ID portion of this element ID. | Elements/Framework/TypedElementId.h | |
FTypedHandleTypeId GetTypeId() |
Access the type ID portion of this element ID. | Elements/Framework/TypedElementId.h | |
bool IsSet() |
Has this ID been initialized to a valid element? | Elements/Framework/TypedElementId.h | |
void Private_DestroyNoRef() |
Elements/Framework/TypedElementId.h | ||
void Private_InitializeNoRef
(
const FTypedHandleTypeId InTypeId, |
Elements/Framework/TypedElementId.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Elements/Framework/TypedElementId.h | ||
FTypedElementId & operator=
(
const FTypedElementId& |
Elements/Framework/TypedElementId.h | ||
FTypedElementId & operator=
(
FTypedElementId&& InOther |
Elements/Framework/TypedElementId.h |