FTypedElementHandle | Unreal Engine 4.27 Documentation

Unreal Engine C++ API Reference > Runtime > TypedElementFramework > Elements > Framework

Inheritance Hierarchy

References


Module	TypedElementFramework
Header	/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementHandle.h
Include	#include "Elements/Framework/TypedElementHandle.h"

Syntax

struct FTypedElementHandle

Remarks

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.

Constructors

	Type	Name	Description
		FTypedElementHandle ()
		FTypedElementHandle ( const FTypedElementHandle& InOther )
		FTypedElementHandle ( FTypedElementHandle&& InOther )

Destructors

	Type	Name	Description
		~FTypedElementHandle ()

Functions

Type	Name	Description
FTypedElementId	AcquireId ()	Acquire a copy of the ID that this element represents.
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.
const ElementDataType &	GetDataChecked ()	Attempt to access the data stored within this handle as the given type, asserting if it isn't possible.
const FTypedElementId &	GetId ()	Get the ID that this element represents.
bool	IsDataOfType ()	Test to see whether the data stored within this handle is of the given type.
bool	IsSet ()	Has this handle been initialized to a valid element?
void	Private_DestroyNoRef ()
void	Private_DestroyReleaseRef ()
const FTypedElementInternalData *	Private_GetInternalData ()
void	Private_InitializeAddRef ( const FTypedElementInternalData& InData )
void	Private_InitializeNoRef ( const FTypedElementInternalData& InData )
void	Release ()	Release this handle and set it back to an empty state.
void	ReleaseId ( FTypedElementId& InOutElementId )	Release a copy of the ID that this element represents.