Class BlueprintMapLibrary
Blueprint Map Library
Inherited Members
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class BlueprintMapLibrary : BlueprintFunctionLibrary
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static BlueprintMapLibrary DefaultObject { get; }
Property Value
Type | Description |
---|---|
BlueprintMapLibrary |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }
Property Value
Type | Description |
---|---|
Class |
Methods
| Improve this Doc View SourceMap_Add(Byte, Int32, Int32)
Adds a key and value to the map.
Declaration
public static void Map_Add(byte TargetMap, int Key, int Value)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap | |
System.Int32 | Key | |
System.Int32 | Value |
Remarks
If something already uses the provided key it will be overwritten with the new value. After calling Key is guaranteed to be associated with Value until a subsequent mutation of the Map.
@param TargetMap The map to add the key and value to @param Key The key that will be used to look the value up @param Value The value to be retrieved later
Map_Clear(Byte)
Clears a map of all entries, resetting it to empty @
Declaration
public static void Map_Clear(byte TargetMap)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap |
Remarks
param TargetMap The map to clear
Map_Contains(Byte, Int32)
Checks whether key is in a provided Map @
Declaration
public static bool Map_Contains(byte TargetMap, int Key)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap | |
System.Int32 | Key |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
param TargetMap The map to perform the lookup on @param Key The key that will be used to lookup @return True if an item was found (False indicates nothing in the map uses the provided key)
Map_Find(Byte, Int32)
Finds the value associated with the provided Key @
Declaration
public static (int, bool) Map_Find(byte TargetMap, int Key)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap | |
System.Int32 | Key |
Returns
Type | Description |
---|---|
System.ValueTuple<System.Int32, System.Boolean> |
Remarks
param TargetMap The map to perform the lookup on @param Key The key that will be used to look the value up @param Value The value associated with the key, default constructed if key was not found @return True if an item was found (False indicates nothing in the map uses the provided key)
Map_Keys(Byte)
Outputs an array of all keys present in the map @
Declaration
public static IReadOnlyCollection<int> Map_Keys(byte TargetMap)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap |
Returns
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyCollection<System.Int32> |
Remarks
param TargetMap The map to get the list of keys from @param Keys All keys present in the map
Map_Length(Byte)
Determines the number of entries in a provided Map @
Declaration
public static int Map_Length(byte TargetMap)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap |
Returns
Type | Description |
---|---|
System.Int32 |
Remarks
param TargetMap The map in question @return The number of entries in the map
Map_Remove(Byte, Int32)
Removes a key and its associated value from the map.
Declaration
public static bool Map_Remove(byte TargetMap, int Key)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap | |
System.Int32 | Key |
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
@param TargetMap The map to remove the key and its associated value from @param Key The key that will be used to look the value up @return True if an item was removed (False indicates nothing in the map uses the provided key)
Map_Values(Byte)
Outputs an array of all values present in the map @
Declaration
public static IReadOnlyCollection<int> Map_Values(byte TargetMap)
Parameters
Type | Name | Description |
---|---|---|
System.Byte | TargetMap |
Returns
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyCollection<System.Int32> |
Remarks
param TargetMap The map to get the list of values from @param Values All values present in the map
New(UObject, Name)
Spawn an object of this class
Declaration
public static BlueprintMapLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type | Name | Description |
---|---|---|
UObject | obj | |
Name | name |
Returns
Type | Description |
---|---|
BlueprintMapLibrary |
SetMapPropertyByName(UObject, Name, Byte)
Not exposed to users. Supports setting a map property on an object by name.
Declaration
public static void SetMapPropertyByName(UObject UObject, Name PropertyName, byte Value)
Parameters
Type | Name | Description |
---|---|---|
UObject | UObject | |
Name | PropertyName | |
System.Byte | Value |
Operators
| Improve this Doc View SourceImplicit(IntPtr to BlueprintMapLibrary)
Convert from IntPtr to UObject
Declaration
public static implicit operator BlueprintMapLibrary(IntPtr p)
Parameters
Type | Name | Description |
---|---|---|
System.IntPtr | p |
Returns
Type | Description |
---|---|
BlueprintMapLibrary |