TMap | Unreal Engine 5.5 Documentation | Epic Developer Community

Unreal Engine C++ API Reference > Runtime > Core > Containers

Inheritance Hierarchy

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Containers/Map.h
Include	#include "Containers/Map.h"

Syntax

template<typename InKeyType, typename InValueType, typename SetAllocator, typename KeyFuncs>  
class TMap : public TSortableMapBase< InKeyType, InValueType, SetAllocator, KeyFuncs >

Remarks

A TMapBase specialization that only allows a single value associated with each key.

Constructors

	Type	Name	Description
		TMap ()
		TMap ( TMap&& )
		TMap ( const TMap& )
		TMap ( TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other )	Constructor for moving elements from a TMap with a different SetAllocator
		TMap ( const TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other )	Constructor for copying elements from a TMap with a different SetAllocator
		TMap ( std::initializer_list< TPairInitializer< const KeyType&, const ValueType& > > InitList )	Constructor which gets its elements from a native initializer list
		TMap ( FIntrusiveUnsetOptionalState Tag )

Functions

Type	Name	Description
void	Append ( TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& OtherMap )	Move all items from another map into our map (if any keys are in both, the value from the other map wins) and empty the other map.
void	Append ( const TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& OtherMap )	Add all items from another map to our map (if any keys are in both, the value from the other map wins).
ValueType	FindAndRemoveChecked ( KeyConstPointerType Key )	Find a pair with the specified key, removes it from the map, and returns the value part of the pair.
bool	RemoveAndCopyValue ( KeyInitType Key, ValueType& OutRemovedValue )	Remove the pair with the specified key and copies the value that was removed to the ref parameter
bool	RemoveAndCopyValueByHash ( uint32 KeyHash, const ComparableKey& Key, ValueType& OutRemovedValue )	See RemoveAndCopyValue() and class documentation section on ByHash() functions

Operators

Type	Name	Description
ValueType &	operator[] ( KeyConstPointerType Key )
const ValueType &	operator[] ( KeyConstPointerType Key )
TMap &	operator= ( std::initializer_list< TPairInitializer< const KeyType&, const ValueType& > > InitList )	Assignment operator which gets its elements from a native initializer list
TMap &	operator= ( const TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other )	Assignment operator for copying elements from a TMap with a different SetAllocator
TMap &	operator= ( TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other )	End - intrusive TOptional state //.
TMap &	operator= ( const TMap& )
TMap &	operator= ( TMap&& )
bool	operator== ( FIntrusiveUnsetOptionalState Tag )