1. Epic GamesDeveloper
  3. TMap

TMap

A [TMapBase](API\Runtime\Core\TMapBase) specialization that only allows a single value associated with each key.

API > API/Runtime > API/Runtime/Core

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

   
Name TMap
Type class
Header File /Engine/Source/Runtime/Core/Public/Containers/Map.h
Include Path #include "Containers/Map.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

TMap derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

TMap ( std::initializer_list< TPairInitializer< const KeyType&, const ValueType& > > InitList
)

 Constructor which gets its elements from a native initializer list Containers/Map.h  

TMap ()

   Containers/Map.h  

TMap ( TMap&&
)

   Containers/Map.h  

TMap ( const TMap&
)

   Containers/Map.h  

TMap ( TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other
)

 Constructor for moving elements from a TMap with a different SetAllocator Containers/Map.h  

TMap ( const TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other
)

 Constructor for copying elements from a TMap with a different SetAllocator Containers/Map.h  
  Containers/Map.h  

Typedefs

Name Type Remarks Include Path
IntrusiveUnsetOptionalStateType TMap   Containers/Map.h
KeyConstPointerType Super::KeyConstPointerType   Containers/Map.h
KeyFuncsType KeyFuncs   Containers/Map.h
KeyInitType Super::KeyInitType   Containers/Map.h
KeyType InKeyType   Containers/Map.h
SetAllocatorType SetAllocator   Containers/Map.h
Super TSortableMapBase< KeyType, ValueType, SetAllocator, KeyFuncs >   Containers/Map.h
ValueType InValueType   Containers/Map.h

Constants

Name Type Remarks Include Path
bHasIntrusiveUnsetOptionalState bool Start - intrusive TOptional state //. Containers/Map.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

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. Containers/Map.h  

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). Containers/Map.h  

ValueType FindAndRemoveChecked ( KeyConstPointerType Key
)

 Find a pair with the specified key, removes it from the map, and returns the value part of the pair. Containers/Map.h  

bool RemoveAndCopyValue ( KeyInitType Key,
ValueType& OutRemovedValue
)

 Remove the pair with the specified key and copies the value that was removed to the ref parameter Containers/Map.h  

bool RemoveAndCopyValueByHash ( uint32 KeyHash,
const ComparableKey& Key,
ValueType& OutRemovedValue
)

 See RemoveAndCopyValue() and class documentation section on ByHash() functions Containers/Map.h  

Operators

Name Remarks Include Path Unreal Specifiers

ValueType & operator[] ( KeyConstPointerType Key
)

   Containers/Map.h  

const ValueType & operator[] ( KeyConstPointerType Key
) const

   Containers/Map.h  

TMap & operator= ( std::initializer_list< TPairInitializer< const KeyType&, const ValueType& > > InitList
)

 Assignment operator which gets its elements from a native initializer list Containers/Map.h  

TMap & operator= ( const TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >& Other
)

 Assignment operator for copying elements from a TMap with a different SetAllocator Containers/Map.h  

TMap & operator= ( TMap< KeyType, ValueType, OtherSetAllocator, KeyFuncs >&& Other
)

 End - intrusive TOptional state //. Containers/Map.h  

TMap & operator= ( const TMap&
)

   Containers/Map.h  

TMap & operator= ( TMap&&
)

   Containers/Map.h  

bool operator== ( FIntrusiveUnsetOptionalState Tag
) const

   Containers/Map.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page