FCompactIndexedHandleBase Struct Reference

#include <IndexedHandle.h>

Public Member Functions
	FCompactIndexedHandleBase ()=default
	FCompactIndexedHandleBase (const int32 InIndex, const uint32 InSerialNumber)
bool	operator== (const FCompactIndexedHandleBase &Other) const
bool	operator!= (const FCompactIndexedHandleBase &Other) const
int16	GetIndex () const
bool	IsValid () const
	operator bool () const
void	Invalidate ()
void	SetIndex (int16 InIndex)
uint16	GetSerialNumber () const
void	SetSerialNumber (int16 InSerialNumber)

Public Attributes
uint32	ManagerID = 0

Protected Attributes
int16	Index = INDEX_NONE
uint16	SerialNumber = 0

Friends
uint32	GetTypeHash (const FCompactIndexedHandleBase &Handle)

Detailed Description

Compact 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

FCompactIndexedHandleBase() [1/2]

FCompactIndexedHandleBase::FCompactIndexedHandleBase ( )

default

FCompactIndexedHandleBase() [2/2]

FCompactIndexedHandleBase::FCompactIndexedHandleBase ( const int32  InIndex, const uint32  InSerialNumber  )

inline

Note

passing INDEX_NONE as index will make this handle Invalid

Member Function Documentation

GetIndex()

int16 FCompactIndexedHandleBase::GetIndex ( ) const

inline

Returns

INDEX_NONE if invalid or >=0 for a potentially valid handle

GetSerialNumber()

uint16 FCompactIndexedHandleBase::GetSerialNumber ( ) const

inline

Invalidate()

void FCompactIndexedHandleBase::Invalidate ( )

inline

Makes the handle Invalid

IsValid()

bool FCompactIndexedHandleBase::IsValid ( ) const

inline

Returns

true if this handle is valid, this doesn't check that it's in the correct range for the underlying resource it's providing a handle for

operator bool()

FCompactIndexedHandleBase::operator bool ( ) const

inline

boolean operator useful when embedding declaration in if statement

Returns

same as IsValid()

See also

IsValid

operator!=()

bool FCompactIndexedHandleBase::operator!= ( const FCompactIndexedHandleBase &  Other ) const

inline

operator==()

bool FCompactIndexedHandleBase::operator== ( const FCompactIndexedHandleBase &  Other ) const

inline

SetIndex()

void FCompactIndexedHandleBase::SetIndex ( int16  InIndex )

inline

Parameters

InIndex

- passing INDEX_NONE will make this handle Invalid

SetSerialNumber()

void FCompactIndexedHandleBase::SetSerialNumber ( int16  InSerialNumber )

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FCompactIndexedHandleBase &  Handle )

friend

Member Data Documentation

Index

int16 FCompactIndexedHandleBase::Index = INDEX_NONE

protected

ManagerID

uint32 FCompactIndexedHandleBase::ManagerID = 0

SerialNumber

uint16 FCompactIndexedHandleBase::SerialNumber = 0

protected

---

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

• Engine/Source/Runtime/AIModule/Public/IndexedHandle.h