UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Attributes | Friends | List of all members
FTypedElementId Struct Reference

#include <TypedElementId.h>

Public Member Functions

 FTypedElementId ()
 
 FTypedElementId (const FTypedElementId &)=delete
 
FTypedElementId & operator= (const FTypedElementId &)=delete
 
 FTypedElementId (FTypedElementId &&InOther)
 
FTypedElementId & operator= (FTypedElementId &&InOther)
 
 ~FTypedElementId ()
 
 operator bool () const
 
bool IsSet () const
 
FTypedHandleTypeId GetTypeId () const
 
FTypedHandleElementId GetElementId () const
 
FTypedHandleCombinedId GetCombinedId () const
 
void Private_InitializeNoRef (const FTypedHandleTypeId InTypeId, const FTypedHandleElementId InElementId)
 
void Private_DestroyNoRef ()
 

Static Public Attributes

static TYPEDELEMENTFRAMEWORK_API const FTypedElementId Unset
 

Friends

bool operator== (const FTypedElementId &InLHS, const FTypedElementId &InRHS)
 
bool operator!= (const FTypedElementId &InLHS, const FTypedElementId &InRHS)
 
uint32 GetTypeHash (const FTypedElementId &InElementId)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FTypedElementId() [1/3]

FTypedElementId::FTypedElementId ( )
inline

◆ FTypedElementId() [2/3]

FTypedElementId::FTypedElementId ( const FTypedElementId &  )
delete

◆ FTypedElementId() [3/3]

FTypedElementId::FTypedElementId ( FTypedElementId &&  InOther)
inline

◆ ~FTypedElementId()

FTypedElementId::~FTypedElementId ( )
inline

Member Function Documentation

◆ GetCombinedId()

FTypedHandleCombinedId FTypedElementId::GetCombinedId ( ) const
inline

Access the combined value of this element ID.

Note
You typically don't want to store this directly as the element ID could be re-used. It is primarily useful as a secondary cache where something is keeping a reference to an element ID or element handle (eg, how FTypedElementList uses it internally).

◆ GetElementId()

FTypedHandleElementId FTypedElementId::GetElementId ( ) const
inline

Access the element ID portion of this element ID.

◆ GetTypeId()

FTypedHandleTypeId FTypedElementId::GetTypeId ( ) const
inline

Access the type ID portion of this element ID.

◆ IsSet()

bool FTypedElementId::IsSet ( ) const
inline

Has this ID been initialized to a valid element?

◆ operator bool()

FTypedElementId::operator bool ( ) const
inlineexplicit

◆ operator=() [1/2]

FTypedElementId & FTypedElementId::operator= ( const FTypedElementId &  )
delete

◆ operator=() [2/2]

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

◆ Private_DestroyNoRef()

void FTypedElementId::Private_DestroyNoRef ( )
inline

◆ Private_InitializeNoRef()

void FTypedElementId::Private_InitializeNoRef ( const FTypedHandleTypeId  InTypeId,
const FTypedHandleElementId  InElementId 
)
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FTypedElementId &  InElementId)
friend

◆ operator!=

bool operator!= ( const FTypedElementId &  InLHS,
const FTypedElementId &  InRHS 
)
friend

◆ operator==

bool operator== ( const FTypedElementId &  InLHS,
const FTypedElementId &  InRHS 
)
friend

Member Data Documentation

◆ CombinedId

FTypedHandleCombinedId FTypedElementId::CombinedId

◆ ElementId

FTypedHandleCombinedId FTypedElementId::ElementId

◆ TypeId

FTypedHandleCombinedId FTypedElementId::TypeId

◆ Unset

const FTypedElementId FTypedElementId::Unset
static

An unset element ID

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