FTypedElementId

The most minimal representation of an element - its ID! This type is not immediately useful on its own, but can be used to find an element from the element registry or an element list.

Choose your operating system:

Windows

macOS

Linux

References

Module

TypedElementFramework

Header

/Engine/Source/Runtime/TypedElementFramework/Public/Elements/Framework/TypedElementId.h

Include

#include "Elements/Framework/TypedElementId.h"

Syntax

struct FTypedElementId

Remarks

The most minimal representation of an element - its ID! This type is not immediately useful on its own, but can be used to find an element from the element registry or an element list. @note This is ref-counted like handles themselves are, so as long as an ID is available, the handle will be too. @note IDs lack the information needed to auto-release on destruction, so must be manually released, either via the corresponding handle or their owner element registry.

Variables

Constructors

Name Description

Public function

FTypedElementId()

Public function

FTypedElementId

(
    const FTypedElementId&
)

Public function

FTypedElementId

(
    FTypedElementId&& InOther
)

Destructors

Name Description

Public function

~FTypedElementId()

Functions

Name Description

Public function Const

FTypedHandle...

 

GetCombinedId()

Access the combined value of this element ID.

Public function Const

FTypedHandle...

 

GetElementId()

Access the element ID portion of this element ID.

Public function Const

FTypedHandle...

 

GetTypeId()

Access the type ID portion of this element ID.

Public function Const

bool

 

IsSet()

Has this ID been initialized to a valid element?

Public function

void

 

Private_DestroyNoRef()

Public function

void

 

Private_InitializeNoRef

(
    const FTypedHandleTypeId InTypeId,
    const FTypedHandleElementId InEleme...
)

Operators

Name Description

Public function Const

 

operator bool()

Public function

FTypedElemen...

 

operator=

(
    const FTypedElementId&
)

Public function

FTypedElemen...

 

operator=

(
    FTypedElementId&& InOther
)

Constants

Name

Description

Unset

An unset element ID