Class UDictSpaceBlueprintLibrary

Defined in File DictSpaceBlueprintLibrary.h

Inheritance Relationships

Base Type

public UBlueprintFunctionLibrary

class UDictSpaceBlueprintLibrary : public UBlueprintFunctionLibrary

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Dependencies: FDictSpace

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

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

Public Static Functions

Symbol	Details
`MapToDictSpace`	Converts a map to a dictionary space.
`DictSpaceToMap`	Converts a dictionary space to a map of sub-spaces.
`DictSpace_Add`	Adds or updates a sub-space inside a dictionary space.
`DictSpace_Find`	Finds a sub-space in a dictionary space by key.
`DictSpace_Contains`	Checks if a dictionary space contains a specific key.
`DictSpace_Remove`	Removes a sub-space from a dictionary space by key.
`DictSpace_Length`	Gets the number of entries in a dictionary space.
`DictSpace_Clear`	Removes all entries from a dictionary space.
`DictSpace_Keys`	Gets all keys from a dictionary space.
`DictSpace_Values`	Gets all values from a dictionary space.

MapToDictSpace

static TInstancedStruct&lt;FDictSpace&gt;
MapToDictSpace(const TMap&lt;FString, FInstancedStruct&gt; &InSpaces)

Converts a map to a dictionary space.

Parameters

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

Returns:

A new dictionary space that can hold named sub-spaces.

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

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpaceToMap

static TMap&lt;FString, FInstancedStruct&gt;
DictSpaceToMap(const TInstancedStruct&lt;FDictSpace&gt; &InDictSpace)

Converts a dictionary space to a map of sub-spaces.

Parameters

InDictSpace – [in] The dictionary space to convert.

Returns:

Map of named sub-spaces from the dictionary space.

#	Direction	Name	Type	Description
1	—	`InDictSpace`	`const TInstancedStruct< FDictSpace > &`	The dictionary space to convert.

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Add

static bool DictSpace_Add(TInstancedStruct&lt;FDictSpace&gt; &InOutDictSpace,
                          const FString &InKey, const FInstancedStruct &InValue)

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

Parameters

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

Returns:

True if the operation succeeded, false otherwise.

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

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Find

static bool DictSpace_Find(const TInstancedStruct&lt;FDictSpace&gt; &InDictSpace,
                           const FString &InKey, FInstancedStruct &OutValue)

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

Parameters

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

Returns:

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

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

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Contains

static bool DictSpace_Contains(const TInstancedStruct&lt;FDictSpace&gt; &InDictSpace,
                               const FString &InKey)

Checks if a dictionary space contains a specific key.

Parameters

InDictSpace – [in] The dictionary space 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	—	`InDictSpace`	`const TInstancedStruct< FDictSpace > &`	The dictionary space to query.
2	—	`InKey`	`const FString &`	The key name to check for.

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Remove

static bool DictSpace_Remove(TInstancedStruct&lt;FDictSpace&gt; &InOutDictSpace,
                             const FString &InKey)

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

Parameters

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

Returns:

The number of elements removed (0 or 1).

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

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Length

static int32 DictSpace_Length(const TInstancedStruct&lt;FDictSpace&gt; &InDictSpace)

Gets the number of entries in a dictionary space.

Parameters

InDictSpace – [in] The dictionary space to query.

Returns:

The number of entries in the dictionary.

#	Direction	Name	Type	Description
1	—	`InDictSpace`	`const TInstancedStruct< FDictSpace > &`	The dictionary space to query.

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Clear

static void DictSpace_Clear(TInstancedStruct&lt;FDictSpace&gt; &InOutDictSpace)

Removes all entries from a dictionary space.

Parameters

InOutDictSpace – [inout] The dictionary space to clear (passed by reference).

#	Direction	Name	Type	Description
1	—	`InOutDictSpace`	`TInstancedStruct< FDictSpace > &`	The dictionary space to clear (passed by reference).

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Keys

static void DictSpace_Keys(const TInstancedStruct&lt;FDictSpace&gt; &InDictSpace,
                           TArray&lt;FString&gt; &OutKeys)

Gets all keys from a dictionary space.

Parameters

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

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

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp

DictSpace_Values

static void DictSpace_Values(const TInstancedStruct&lt;FDictSpace&gt; &InDictSpace,
                             TArray&lt;FInstancedStruct&gt; &OutValues)

Gets all values from a dictionary space.

Parameters

InDictSpace – [in] The dictionary space to query.
OutValues – [out] Output parameter that receives the array of sub-spaces.

#	Direction	Name	Type	Description
1	—	`InDictSpace`	`const TInstancedStruct< FDictSpace > &`	The dictionary space to query.
2	—	`OutValues`	`TArray< FInstancedStruct > &`	Output parameter that receives the array of sub-spaces.

Attributes: static

Source: Source/Schola/Public/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.h

Implementation: Source/Schola/Private/Common/Spaces/Blueprint/DictSpaceBlueprintLibrary.cpp