Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
A representation of an element that includes its handle data. This type is the most standard way that an element is passed through to interfaces, and also the type that is stored in element lists. C++ code may choose to use TTypedElement instead, which is a combination of an element handle and its associated element interface.
Handles auto-release on destruction.
| Name | FTypedElementHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementHandle.h |
| Include Path | #include "Elements/Framework/TypedElementHandle.h" |
Syntax
struct FTypedElementHandle
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTypedElementHandle
(
FTypedElementHandle&& InOther |
Elements/Framework/TypedElementHandle.h | ||
FTypedElementHandle
(
const FTypedElementHandle& InOther |
Elements/Framework/TypedElementHandle.h | ||
| Elements/Framework/TypedElementHandle.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FTypedElementHandle() |
Elements/Framework/TypedElementHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataPtr | const FTypedElementInternalData * | Elements/Framework/TypedElementHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Acquire a copy of the ID that this element represents. | Elements/Framework/TypedElementHandle.h | ||
const ElementDataType * GetData
(
const bool bSilent |
Attempt to access the data stored within this handle as the given type, returning null if it isn't possible and logging an access error for scripting. | Elements/Framework/TypedElementHandle.h | |
const ElementDataType & GetDataChecked () |
Attempt to access the data stored within this handle as the given type, asserting if it isn't possible. | Elements/Framework/TypedElementHandle.h | |
const FTypedElementId & GetId() |
Get the ID that this element represents. | Elements/Framework/TypedElementHandle.h | |
bool IsDataOfType () |
Test to see whether the data stored within this handle is of the given type. | Elements/Framework/TypedElementHandle.h | |
bool IsSet() |
Has this handle been initialized to a valid element? | Elements/Framework/TypedElementHandle.h | |
void Private_DestroyNoRef() |
Elements/Framework/TypedElementHandle.h | ||
void Private_DestroyReleaseRef() |
Elements/Framework/TypedElementHandle.h | ||
const FTypedElementInternalData * Private_GetInternalData() |
Elements/Framework/TypedElementHandle.h | ||
void Private_InitializeAddRef
(
const FTypedElementInternalData& InData |
Elements/Framework/TypedElementHandle.h | ||
void Private_InitializeNoRef
(
const FTypedElementInternalData& InData |
Elements/Framework/TypedElementHandle.h | ||
void Release() |
Release this handle and set it back to an empty state. | Elements/Framework/TypedElementHandle.h | |
void ReleaseId
(
FTypedElementId& InOutElementId |
Release a copy of the ID that this element represents. | Elements/Framework/TypedElementHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Elements/Framework/TypedElementHandle.h | ||
FTypedElementHandle & operator=
(
FTypedElementHandle&& InOther |
Elements/Framework/TypedElementHandle.h | ||
FTypedElementHandle & operator=
(
const FTypedElementHandle& InOther |
Elements/Framework/TypedElementHandle.h |