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

#include <KeyHandle.h>

Public Member Functions

 FKeyHandleMap ()
 
 FKeyHandleMap (const FKeyHandleMap &Other)
 
void operator= (const FKeyHandleMap &Other)
 
void Initialize (TArrayView< const FKeyHandle > InKeyHandles)
 
void Add (const FKeyHandle &InHandle, int32 InIndex)
 
void Empty (int32 ExpectedNumElements=0)
 
void Remove (const FKeyHandle &InHandle)
 
void Reserve (int32 NumElements)
 
const int32Find (const FKeyHandle &InHandle) const
 
const FKeyHandleFindKey (int32 KeyIndex) const
 
int32 Num () const
 
TArray< FKeyHandle >::TConstIterator CreateConstIterator () const
 
const TMap< FKeyHandle, int32 > & GetMap () const
 
void SetKeyHandles (int32 Num)
 
bool Serialize (FArchive &Ar)
 
bool operator== (const FKeyHandleMap &Other) const
 
bool operator!= (const FKeyHandleMap &Other) const
 
void EnsureAllIndicesHaveHandles (int32 NumIndices)
 
void EnsureIndexHasAHandle (int32 KeyIndex)
 

Friends

FArchiveoperator<< (FArchive &Ar, FKeyHandleMap &P)
 

Detailed Description

Represents a mapping of key handles to key index that may be serialized

Constructor & Destructor Documentation

◆ FKeyHandleMap() [1/2]

FKeyHandleMap::FKeyHandleMap ( )
inline

◆ FKeyHandleMap() [2/2]

FKeyHandleMap::FKeyHandleMap ( const FKeyHandleMap Other)
inline

Member Function Documentation

◆ Add()

void FKeyHandleMap::Add ( const FKeyHandle InHandle,
int32  InIndex 
)

TMap functionality

◆ CreateConstIterator()

TArray< FKeyHandle >::TConstIterator FKeyHandleMap::CreateConstIterator ( ) const
inline

◆ Empty()

void FKeyHandleMap::Empty ( int32  ExpectedNumElements = 0)

◆ EnsureAllIndicesHaveHandles()

void FKeyHandleMap::EnsureAllIndicesHaveHandles ( int32  NumIndices)

◆ EnsureIndexHasAHandle()

void FKeyHandleMap::EnsureIndexHasAHandle ( int32  KeyIndex)

◆ Find()

const int32 * FKeyHandleMap::Find ( const FKeyHandle InHandle) const
inline

◆ FindKey()

const FKeyHandle * FKeyHandleMap::FindKey ( int32  KeyIndex) const

◆ GetMap()

const TMap< FKeyHandle, int32 > & FKeyHandleMap::GetMap ( ) const
inline

◆ Initialize()

void FKeyHandleMap::Initialize ( TArrayView< const FKeyHandle InKeyHandles)

◆ Num()

int32 FKeyHandleMap::Num ( ) const
inline

◆ operator!=()

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

◆ operator=()

void FKeyHandleMap::operator= ( const FKeyHandleMap Other)
inline

◆ operator==()

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

◆ Remove()

void FKeyHandleMap::Remove ( const FKeyHandle InHandle)

◆ Reserve()

void FKeyHandleMap::Reserve ( int32  NumElements)

◆ Serialize()

bool FKeyHandleMap::Serialize ( FArchive Ar)

ICPPStructOps implementation

◆ SetKeyHandles()

void FKeyHandleMap::SetKeyHandles ( int32  Num)

Friends And Related Symbol Documentation

◆ operator<<

FArchive & operator<< ( FArchive Ar,
FKeyHandleMap P 
)
friend

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