FTypedElementHandle

A representation of an element that includes its handle data.

Choose your operating system:

Windows

macOS

Linux

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. @note Handles auto-release on destruction.

Constructors

Name Description

Public function

FTypedElementHandle()

Public function

FTypedElementHandle

(
    const FTypedElementHandle& InOther
)

Public function

FTypedElementHandle

(
    FTypedElementHandle&& InOther
)

Destructors

Name Description

Public function

~FTypedElementHandle()

Functions

Name Description

Public function Const

FTypedElemen...

 

AcquireId()

Acquire a copy of the ID that this element represents.

Public function Const

const Elemen...

 

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.

Public function Const

const Elemen...

 

GetDataChecked()

Attempt to access the data stored within this handle as the given type, asserting if it isn't possible.

Public function Const

const FTyped...

 

GetId()

Get the ID that this element represents.

Public function Const

bool

 

IsDataOfType()

Test to see whether the data stored within this handle is of the given type.

Public function Const

bool

 

IsSet()

Has this handle been initialized to a valid element?

Public function

void

 

Private_DestroyNoRef()

Public function

void

 

Private_DestroyReleaseRef()

Public function Const

const FTyped...

 

Private_GetInternalData()

Public function

void

 

Private_InitializeAddRef

(
    const FTypedElementInternalData& I...
)

Public function

void

 

Private_InitializeNoRef

(
    const FTypedElementInternalData& I...
)

Public function

void

 

Release()

Release this handle and set it back to an empty state.

Public function Const

void

 

ReleaseId

(
    FTypedElementId& InOutElementId
)

Release a copy of the ID that this element represents.

Operators

Name Description

Public function Const

 

operator bool()

Public function

FTypedElemen...

 

operator=

(
    FTypedElementHandle&& InOther
)

Public function

FTypedElemen...

 

operator=

(
    const FTypedElementHandle& InOther
)