1. Epic GamesDeveloper
  3. TScriptMap

TScriptMap

Untyped map type for accessing [TMap](API\Runtime\Core\TMap) data, like [FScriptArray](API\Runtime\Core\FScriptArray) for [TArray](API\Runtime\Core\TArray).

API > API/Runtime > API/Runtime/Core

Untyped map type for accessing TMap data, like FScriptArray for TArray. Must have the same memory representation as a TMap.

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

Syntax

template<typename AllocatorType, typename InDerivedType>  
class TScriptMap

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  Containers/Map.h  
  Containers/Map.h  

TScriptMap ( const TScriptMap&
)

 These should really be private, because they shouldn't be called, but there's a bunch of code that needs to be fixed first. Containers/Map.h  

Typedefs

Name Type Remarks Include Path
DerivedType std::conditional_t< std::is_void_v< InDerivedType >, TScriptMap, InDerivedType >   Containers/Map.h
IntrusiveUnsetOptionalStateType TScriptMap   Containers/Map.h

Constants

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

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Pairs TScriptSet< AllocatorType >   Containers/Map.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Add ( const void* Key,
const void* Value,
const FScriptMapLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> KeyEqualityFn,
TFunctionRef< void(void*)> KeyConstructAndAssignFn,
TFunctionRef< void(void*)> ValueConstructAndAssignFn,
TFunctionRef< void(void*)> ValueAssignFn,
TFunctionRef< void(void*)> DestructKeyFn,
TFunctionRef< void(void*)> DestructValueFn
)

 Adds the (key, value) pair to the map Containers/Map.h  

int32 AddUninitialized ( const FScriptMapLayout& Layout
)

 Adds an uninitialized object to the map. Containers/Map.h  

void CommitAllUninitialized ( const FScriptMapLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash
)

   Containers/Map.h  

void CommitLastUninitialized ( const FScriptMapLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash
)

   Containers/Map.h  

void Empty ( int32 Slack,
const FScriptMapLayout& Layout
)

   Containers/Map.h  

void * FindOrAdd ( const void* Key,
const FScriptMapLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> KeyEqualityFn,
TFunctionRef< void(void*, void*)> ConstructPairFn
)

 Constructs a new key-value pair if key didn't exist Containers/Map.h  

int32 FindPairIndex ( const void* Key,
const FScriptMapLayout& MapLayout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> KeyEqualityFn
) const

 Finds the associated key, value from hash of Key, rather than linearly searching Containers/Map.h  

uint8 * FindValue ( const void* Key,
const FScriptMapLayout& MapLayout,
TFunctionRef< uint32(const void*)> GetKeyHash,
TFunctionRef< bool(const void*, const void*)> KeyEqualityFn
)

 Finds the associated value from hash of Key, rather than linearly searching Containers/Map.h  

const void * GetData ( int32 Index,
const FScriptMapLayout& Layout
) const

   Containers/Map.h  

void * GetData ( int32 Index,
const FScriptMapLayout& Layout
)

   Containers/Map.h  

int32 GetMaxIndex()

   Containers/Map.h  

bool IsEmpty()

   Containers/Map.h  

bool IsValidIndex ( int32 Index
) const

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

int32 Max()

   Containers/Map.h  

void MoveAssign ( DerivedType& Other,
const FScriptMapLayout& Layout
)

   Containers/Map.h  

int32 Num()

   Containers/Map.h  

int32 NumUnchecked()

   Containers/Map.h  

void Rehash ( const FScriptMapLayout& Layout,
TFunctionRef< uint32(const void*)> GetKeyHash
)

   Containers/Map.h  

void RemoveAt ( int32 Index,
const FScriptMapLayout& Layout
)

   Containers/Map.h  

void RemoveAtUninitialized ( const FScriptMapLayout& Layout,
int32 Index
)

   Containers/Map.h  

Static

Name Remarks Include Path Unreal Specifiers

static void CheckConstraints()

 This function isn't intended to be called, just to be compiled to validate the correctness of the type. Containers/Map.h  

static FScriptMapLayout GetScriptLayout ( int32 KeySize,
int32 KeyAlignment,
int32 ValueSize,
int32 ValueAlignment
)

   Containers/Map.h  

Operators

Name Remarks Include Path Unreal Specifiers

void operator= ( const TScriptMap&
)

   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