UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FScriptTypedElementHandle Struct Reference

#include <TypedElementHandle.h>

Public Member Functions

 FScriptTypedElementHandle ()=default
 
 FScriptTypedElementHandle (const FScriptTypedElementHandle &InOther)
 
 FScriptTypedElementHandle (FScriptTypedElementHandle &&InOther)
 
FScriptTypedElementHandleoperator= (const FScriptTypedElementHandle &InOther)
 
FScriptTypedElementHandleoperator= (FScriptTypedElementHandle &&InOther)
 
bool operator== (const FScriptTypedElementHandle &InOther) const
 
bool operator!= (const FScriptTypedElementHandle &InOther) const
 
 operator bool () const
 
bool IsSet () const
 
void Release ()
 
void Private_Initialize (FScriptTypedElementInternalDataPtr &&InInternalData)
 
const FTypedElementIdGetId () const
 
FTypedElementHandle GetTypedElementHandle () const
 

Detailed Description

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).

Constructor & Destructor Documentation

◆ FScriptTypedElementHandle() [1/3]

FScriptTypedElementHandle::FScriptTypedElementHandle ( )
default

◆ FScriptTypedElementHandle() [2/3]

FScriptTypedElementHandle::FScriptTypedElementHandle ( const FScriptTypedElementHandle InOther)
inline

◆ FScriptTypedElementHandle() [3/3]

FScriptTypedElementHandle::FScriptTypedElementHandle ( FScriptTypedElementHandle &&  InOther)
inline

Member Function Documentation

◆ GetId()

const FTypedElementId & FScriptTypedElementHandle::GetId ( ) const
inline

◆ GetTypedElementHandle()

FTypedElementHandle FScriptTypedElementHandle::GetTypedElementHandle ( ) const
inline

Return typed element handle from the script typed element handle If this script handle is invalid it will return a invalid TypedElementHandle

◆ IsSet()

bool FScriptTypedElementHandle::IsSet ( ) const
inline

◆ operator bool()

FScriptTypedElementHandle::operator bool ( ) const
inlineexplicit

◆ operator!=()

bool FScriptTypedElementHandle::operator!= ( const FScriptTypedElementHandle InOther) const
inline

◆ operator=() [1/2]

FScriptTypedElementHandle & FScriptTypedElementHandle::operator= ( const FScriptTypedElementHandle InOther)
inline

◆ operator=() [2/2]

FScriptTypedElementHandle & FScriptTypedElementHandle::operator= ( FScriptTypedElementHandle &&  InOther)
inline

◆ operator==()

bool FScriptTypedElementHandle::operator== ( const FScriptTypedElementHandle InOther) const
inline

◆ Private_Initialize()

void FScriptTypedElementHandle::Private_Initialize ( FScriptTypedElementInternalDataPtr &&  InInternalData)
inline

◆ Release()

void FScriptTypedElementHandle::Release ( )
inline

The documentation for this struct was generated from the following file: