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

#include <IndexedHandle.h>

+ Inheritance diagram for FIndexedHandleBase:

Public Member Functions

 FIndexedHandleBase ()=default
 
 FIndexedHandleBase (int32 InIndex, uint32 InSerialNumber)
 
bool operator== (const FIndexedHandleBase &Other) const
 
bool operator!= (const FIndexedHandleBase &Other) const
 
uint32 GetSerialNumber () const
 
void SetSerialNumber (uint32 InSerialNumber)
 
- Public Member Functions inherited from FSimpleIndexedHandleBase
 FSimpleIndexedHandleBase ()=default
 
 FSimpleIndexedHandleBase (int32 InIndex)
 
bool operator== (const FSimpleIndexedHandleBase &Other) const
 
bool operator!= (const FSimpleIndexedHandleBase &Other) const
 
int32 GetIndex () const
 
bool IsValid () const
 
 operator bool () const
 
void Invalidate ()
 
void SetIndex (int32 InIndex)
 

Public Attributes

uint32 ManagerID = 0
 

Protected Attributes

uint32 SerialNumber = 0
 
- Protected Attributes inherited from FSimpleIndexedHandleBase
int32 Index = INDEX_NONE
 

Friends

uint32 GetTypeHash (const FIndexedHandleBase &Handle)
 

Detailed Description

Index based handle that has a serial number to verify stale handles. For fast safe access in to index based data structures

Constructor & Destructor Documentation

◆ FIndexedHandleBase() [1/2]

FIndexedHandleBase::FIndexedHandleBase ( )
default

◆ FIndexedHandleBase() [2/2]

FIndexedHandleBase::FIndexedHandleBase ( int32  InIndex,
uint32  InSerialNumber 
)
inline
Note
passing INDEX_NONE as index will make this handle Invalid

Member Function Documentation

◆ GetSerialNumber()

uint32 FIndexedHandleBase::GetSerialNumber ( ) const
inline

◆ operator!=()

bool FIndexedHandleBase::operator!= ( const FIndexedHandleBase Other) const
inline

◆ operator==()

bool FIndexedHandleBase::operator== ( const FIndexedHandleBase Other) const
inline

◆ SetSerialNumber()

void FIndexedHandleBase::SetSerialNumber ( uint32  InSerialNumber)
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FIndexedHandleBase Handle)
friend

Member Data Documentation

◆ ManagerID

uint32 FIndexedHandleBase::ManagerID = 0

◆ SerialNumber

uint32 FIndexedHandleBase::SerialNumber = 0
protected

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