Class UDictPointBlueprintLibrary

Defined in File DictPointBlueprintLibrary.h

Inheritance Relationships

Base Type

public UBlueprintFunctionLibrary

class UDictPointBlueprintLibrary : public UBlueprintFunctionLibrary

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Dependencies: FDictPoint

Blueprint oriented helper functions for creating & inspecting Dict Point InstancedStructs.

This library provides utility functions for creating and manipulating Dictionary Point instances from within Blueprints. These return TInstancedStruct<FDictPoint>.

Public Static Functions

Symbol	Details
`MapToDictPoint`	Converts a map to a dictionary point.
`DictPointToMap`	Converts a dictionary point to a map of sub-points.
`DictPoint_Add`	Adds or updates a sub-point inside a dictionary point.
`DictPoint_Find`	Finds a sub-point in a dictionary point by key.
`DictPoint_Contains`	Checks if a dictionary point contains a specific key.
`DictPoint_Remove`	Removes a sub-point from a dictionary point by key.
`DictPoint_Length`	Gets the number of entries in a dictionary point.
`DictPoint_Clear`	Removes all entries from a dictionary point.
`DictPoint_Keys`	Gets all keys from a dictionary point.
`DictPoint_Values`	Gets all values from a dictionary point.

MapToDictPoint

static TInstancedStruct&lt;FDictPoint&gt;
MapToDictPoint(const TMap&lt;FString, FInstancedStruct&gt; &InPoints)

Converts a map to a dictionary point.

Parameters

InPoints – [in] Map of key-value pairs where keys are strings and values are sub-points.

Returns:

A new dictionary point instance that can hold named sub-points.

#	Direction	Name	Type	Description
1	—	`InPoints`	`const TMap< FString, FInstancedStruct > &`	Map of key-value pairs where keys are strings and values are sub-points.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPointToMap

static TMap&lt;FString, FInstancedStruct&gt;
DictPointToMap(const TInstancedStruct&lt;FDictPoint&gt; &InDictPoint)

Converts a dictionary point to a map of sub-points.

Parameters

InDictPoint – [in] The dictionary point to convert.

Returns:

Map of named sub-points from the dictionary point.

#	Direction	Name	Type	Description
1	—	`InDictPoint`	`const TInstancedStruct< FDictPoint > &`	The dictionary point to convert.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Add

static bool DictPoint_Add(TInstancedStruct&lt;FDictPoint&gt; &InOutDictPoint,
                          const FString &InKey, const FInstancedStruct &InValue)

Adds or updates a sub-point inside a dictionary point.

Parameters

InOutDictPoint – [inout] The dictionary point to modify (passed by reference).
InKey – [in] The key name for the sub-point.
InValue – [in] The sub-point to store.

Returns:

True if the operation succeeded, false otherwise.

#	Direction	Name	Type	Description
1	—	`InOutDictPoint`	`TInstancedStruct< FDictPoint > &`	The dictionary point to modify (passed by reference).
2	—	`InKey`	`const FString &`	The key name for the sub-point.
3	—	`InValue`	`const FInstancedStruct &`	The sub-point to store.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Find

static bool DictPoint_Find(TInstancedStruct&lt;FDictPoint&gt; &InDictPoint,
                           const FString &InKey, FInstancedStruct &OutValue)

Finds a sub-point in a dictionary point by key.

Parameters

InDictPoint – [in] The dictionary point to query.
InKey – [in] The key name of the sub-point to retrieve.
OutValue – [out] Output parameter that receives the sub-point if found.

Returns:

True if the sub-point was found, false otherwise.

#	Direction	Name	Type	Description
1	—	`InDictPoint`	`TInstancedStruct< FDictPoint > &`	The dictionary point to query.
2	—	`InKey`	`const FString &`	The key name of the sub-point to retrieve.
3	—	`OutValue`	`FInstancedStruct &`	Output parameter that receives the sub-point if found.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Contains

static bool DictPoint_Contains(const TInstancedStruct&lt;FDictPoint&gt; &InDictPoint,
                               const FString &InKey)

Checks if a dictionary point contains a specific key.

Parameters

InDictPoint – [in] The dictionary point to query.
InKey – [in] The key name to check for.

Returns:

True if the key exists in the dictionary, false otherwise.

#	Direction	Name	Type	Description
1	—	`InDictPoint`	`const TInstancedStruct< FDictPoint > &`	The dictionary point to query.
2	—	`InKey`	`const FString &`	The key name to check for.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Remove

static bool DictPoint_Remove(TInstancedStruct&lt;FDictPoint&gt; &InOutDictPoint,
                             const FString &InKey)

Removes a sub-point from a dictionary point by key.

Parameters

InOutDictPoint – [inout] The dictionary point to modify (passed by reference).
InKey – [in] The key name of the sub-point to remove.

Returns:

The number of elements removed (0 or 1).

#	Direction	Name	Type	Description
1	—	`InOutDictPoint`	`TInstancedStruct< FDictPoint > &`	The dictionary point to modify (passed by reference).
2	—	`InKey`	`const FString &`	The key name of the sub-point to remove.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Length

static int32 DictPoint_Length(const TInstancedStruct&lt;FDictPoint&gt; &InDictPoint)

Gets the number of entries in a dictionary point.

Parameters

InDictPoint – [in] The dictionary point to query.

Returns:

The number of entries in the dictionary.

#	Direction	Name	Type	Description
1	—	`InDictPoint`	`const TInstancedStruct< FDictPoint > &`	The dictionary point to query.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Clear

static void DictPoint_Clear(TInstancedStruct&lt;FDictPoint&gt; &InOutDictPoint)

Removes all entries from a dictionary point.

Parameters

InOutDictPoint – [inout] The dictionary point to clear (passed by reference).

#	Direction	Name	Type	Description
1	—	`InOutDictPoint`	`TInstancedStruct< FDictPoint > &`	The dictionary point to clear (passed by reference).

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Keys

static void DictPoint_Keys(const TInstancedStruct&lt;FDictPoint&gt; &InDictPoint,
                           TArray&lt;FString&gt; &OutKeys)

Gets all keys from a dictionary point.

Parameters

InDictPoint – [in] The dictionary point to query.
OutKeys – [out] Output parameter that receives the array of keys.

#	Direction	Name	Type	Description
1	—	`InDictPoint`	`const TInstancedStruct< FDictPoint > &`	The dictionary point to query.
2	—	`OutKeys`	`TArray< FString > &`	Output parameter that receives the array of keys.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp

DictPoint_Values

static void DictPoint_Values(const TInstancedStruct&lt;FDictPoint&gt; &InDictPoint,
                             TArray&lt;FInstancedStruct&gt; &OutValues)

Gets all values from a dictionary point.

Parameters

InDictPoint – [in] The dictionary point to query.
OutValues – [out] Output parameter that receives the array of sub-points.

#	Direction	Name	Type	Description
1	—	`InDictPoint`	`const TInstancedStruct< FDictPoint > &`	The dictionary point to query.
2	—	`OutValues`	`TArray< FInstancedStruct > &`	Output parameter that receives the array of sub-points.

Attributes: static

Source: Source/Schola/Public/Common/Points/Blueprint/DictPointBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Points/Blueprint/DictPointBlueprintLibrary.cpp