1. Epic GamesDeveloper
  3. UBlueprintMapLibrary

UBlueprintMapLibrary

API > API/Runtime > API/Runtime/Engine

   
Name UBlueprintMapLibrary
Type class
Header File /Engine/Source/Runtime/Engine/Classes/Kismet/BlueprintMapLibrary.h
Include Path #include "Kismet/BlueprintMapLibrary.h"

Syntax

UCLASS (Meta=(BlueprintThreadSafe), MinimalAPI)  
class UBlueprintMapLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
MaxSupportedMapSize int32   Kismet/BlueprintMapLibrary.h

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void GenericMap_Add ( const void* TargetMap,
const FMapProperty* MapProperty,
const void* KeyPtr,
const void* ValuePtr
)

   Kismet/BlueprintMapLibrary.h  

static void GenericMap_Clear ( const void* TargetMap,
const FMapProperty* MapProperty
)

   Kismet/BlueprintMapLibrary.h  

static bool GenericMap_Find ( const void* TargetMap,
const FMapProperty* MapProperty,
const void* KeyPtr,
void* ValuePtr
)

   Kismet/BlueprintMapLibrary.h  

static void GenericMap_GetKeyValueByIndex ( const void* TargetMap,
const FMapProperty* MapProperty,
int32 Index,
void* KeyPtr,
void* ValuePtr
)

   Kismet/BlueprintMapLibrary.h  

static int32 GenericMap_GetLastIndex ( const void* TargetMap,
const FMapProperty* MapProperty
)

   Kismet/BlueprintMapLibrary.h  

static bool GenericMap_IsEmpty ( const void* TargetMap,
const FMapProperty* MapProperty
)

   Kismet/BlueprintMapLibrary.h  

static bool GenericMap_IsNotEmpty ( const void* TargetMap,
const FMapProperty* MapProperty
)

   Kismet/BlueprintMapLibrary.h  

static void GenericMap_Keys ( const void* MapAddr,
const FMapProperty* MapProperty,
const void* ArrayAddr,
const FArrayProperty* ArrayProperty
)

   Kismet/BlueprintMapLibrary.h  

static int32 GenericMap_Length ( const void* TargetMap,
const FMapProperty* MapProperty
)

   Kismet/BlueprintMapLibrary.h  

static bool GenericMap_Remove ( const void* TargetMap,
const FMapProperty* MapProperty,
const void* KeyPtr
)

   Kismet/BlueprintMapLibrary.h  

static void GenericMap_SetMapPropertyByName ( UObject* OwnerObject,
FName MapPropertyName,
const void* SrcMapAddr
)

   Kismet/BlueprintMapLibrary.h  

static void GenericMap_Values ( const void* MapAddr,
const FMapProperty* MapProperty,
const void* ArrayAddr,
const FArrayProperty* ArrayProperty
)

   Kismet/BlueprintMapLibrary.h  

static void Map_Add ( const TMap< int32, int32 >& TargetMap,
const int32& Key,
const int32& Value
)

 Adds a key and value to the map. Kismet/BlueprintMapLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Add", CompactNodeTitle="ADD", MapParam="TargetMap", MapKeyParam="Key", MapValueParam="Value", AutoCreateRefTerm="Key, Value")
  • Category="Utilities|Map"

static void Map_Clear ( const TMap< int32, int32 >& TargetMap
)

 Clears a map of all entries, resetting it to empty Kismet/BlueprintMapLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Clear", CompactNodeTitle="CLEAR", MapParam="TargetMap")
  • Category="Utilities|Map"

static bool Map_Contains ( const TMap< int32, int32 >& TargetMap,
const int32& Key
)

 Checks whether key is in a provided Map Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Contains", CompactNodeTitle="CONTAINS", MapParam="TargetMap", MapKeyParam="Key", AutoCreateRefTerm="Key", BlueprintThreadSafe)
  • Category="Utilities|Map"

static bool Map_Find ( const TMap< int32, int32 >& TargetMap,
const int32& Key,
int32& Value
)

 Finds the value associated with the provided Key Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Find", CompactNodeTitle="FIND", MapParam="TargetMap", MapKeyParam="Key", MapValueParam="Value", AutoCreateRefTerm="Key, Value", BlueprintThreadSafe)
  • Category="Utilities|Map"

static void Map_GetKeyValueByIndex ( const TMap< int32, int32 >& TargetMap,
int32 Index,
int32& Key,
int32& Value
)

 Given a map and an index, returns a copy of the key and value found at that index. Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Get Key Value By Index", CompactNodeTitle="GET KEY VALUE BY INDEX", MapParam="TargetMap", MapKeyParam="Key", MapValueParam="Value", AutoCreateRefTerm="Key, Value", BlueprintThreadSafe)
  • Category="Utilities|Map"

static int32 Map_GetLastIndex ( const TMap< int32, int32 >& TargetMap
)

 Determines the last valid index for a map Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Get Last Index", CompactNodeTitle="GET LAST INDEX", MapParam="TargetMap", BlueprintThreadSafe)
  • Category="Utilities|Map"

static bool Map_IsEmpty ( const TMap< int32, int32 >& TargetMap
)

 Check if the map does not have any entires Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Is Empty", CompactNodeTitle="IS EMPTY", MapParam="TargetMap")
  • Category="Utilities|Map"

static bool Map_IsNotEmpty ( const TMap< int32, int32 >& TargetMap
)

 Check if the map has any entries Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Is Not Empty", CompactNodeTitle="IS NOT EMPTY", MapParam="TargetMap")
  • Category="Utilities|Map"

static void Map_Keys ( const TMap< int32, int32 >& TargetMap,
TArray< int32 >& Keys
)

 Outputs an array of all keys present in the map Kismet/BlueprintMapLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Keys", CompactNodeTitle="KEYS", MapParam="TargetMap", MapKeyParam="Keys", AutoCreateRefTerm="Keys")
  • Category="Utilities|Map"

static int32 Map_Length ( const TMap< int32, int32 >& TargetMap
)

 Determines the number of entries in a provided Map Kismet/BlueprintMapLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Length", CompactNodeTitle="LENGTH", MapParam="TargetMap", Keywords="num size count", BlueprintThreadSafe)
  • Category="Utilities|Map"

static bool Map_Remove ( const TMap< int32, int32 >& TargetMap,
const int32& Key
)

 Removes a key and its associated value from the map. Kismet/BlueprintMapLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Remove", CompactNodeTitle="REMOVE", MapParam="TargetMap", MapKeyParam="Key", AutoCreateRefTerm="Key")
  • Category="Utilities|Map"

static void Map_Values ( const TMap< int32, int32 >& TargetMap,
TArray< int32 >& Values
)

 Outputs an array of all values present in the map Kismet/BlueprintMapLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Values", CompactNodeTitle="VALUES", MapParam="TargetMap", MapValueParam="Values", AutoCreateRefTerm="Values")
  • Category="Utilities|Map"

static void SetMapPropertyByName ( UObject* Object,
FName PropertyName,
const TMap< int32, int32 >& Value
)

 Not exposed to users. Supports setting a map property on an object by name. Kismet/BlueprintMapLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(BlueprintInternalUseOnly="true", MapParam="Value")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page