Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Script exposure for the typed element handle struct type Act as a weak handle to simplify the scripting use of the typed element framework and making it safer to use by avoiding crash in case of a bad usage. This type is the standard way that an element is passed through to interfaces for a script (Blueprint or Python), and also the type that is stored in the script element lists. C++ code may choose to use TTypedElement instead, which is a combination of an element handle and its associated element interface.
Note: This type shouldn't be used in the engine code as it come with a performance and memory overhead that we want to avoid when compare to the native handles (FTypedElementHandle).
| Name | FScriptTypedElementHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementHandle.h |
| Include Path | #include "Elements/Framework/TypedElementHandle.h" |
Syntax
USTRUCT (BlueprintType )
struct FScriptTypedElementHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Elements/Framework/TypedElementHandle.h | |||
FScriptTypedElementHandle
(
const FScriptTypedElementHandle& InOther |
Elements/Framework/TypedElementHandle.h | ||
FScriptTypedElementHandle
(
FScriptTypedElementHandle&& InOther |
Elements/Framework/TypedElementHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InternalData | FScriptTypedElementInternalDataPtr | Elements/Framework/TypedElementHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FTypedElementId & GetId() |
Elements/Framework/TypedElementHandle.h | ||
FTypedElementHandle GetTypedElementHandle() |
Return typed element handle from the script typed element handle If this script handle is invalid it will return a invalid TypedElementHandle | Elements/Framework/TypedElementHandle.h | |
bool IsSet() |
Elements/Framework/TypedElementHandle.h | ||
void Private_Initialize
(
FScriptTypedElementInternalDataPtr&& InInternalData |
Elements/Framework/TypedElementHandle.h | ||
void Release() |
Elements/Framework/TypedElementHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Elements/Framework/TypedElementHandle.h | ||
bool operator!=
(
const FScriptTypedElementHandle& InOther |
Elements/Framework/TypedElementHandle.h | ||
FScriptTypedElementHandle & operator=
(
const FScriptTypedElementHandle& InOther |
Elements/Framework/TypedElementHandle.h | ||
FScriptTypedElementHandle & operator=
(
FScriptTypedElementHandle&& InOther |
Elements/Framework/TypedElementHandle.h | ||
bool operator==
(
const FScriptTypedElementHandle& InOther |
Elements/Framework/TypedElementHandle.h |