UKismetArrayLibrary

class Engine Blueprint Since unknown

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetArrayLibrary

#include "Kismet/KismetArrayLibrary.h"

Description

Blueprint function library exposing generic array operations (add, remove, shuffle, sort, search, and more) that work against any wildcard array type. Backs the 'Utilities|Array' category nodes in the Blueprint graph editor.

Caveats & Gotchas

• The class carries BlueprintThreadSafe at the UCLASS level, but individual functions are implemented via CustomThunk against a wildcard TArray<int32> placeholder type — the declared int32 signatures do not reflect the actual element type used at a given call site.
• Because these are wildcard/generic nodes, C++ code should generally prefer calling TArray's own member functions directly rather than going through UKismetArrayLibrary, which exists primarily to back the Blueprint graph nodes.

Functions (32)

Array 32

Array

32 ▼

Access	Type	Name	Description
public	function	UKismetArrayLibrary::Array_Add	Appends an item to the end of an array and returns the index of the newly added element.
public	function	UKismetArrayLibrary::Array_AddUnique	Adds an item to the array only if an equal item isn't already present, returning the index of the item.
public	function	UKismetArrayLibrary::Array_Append	Appends all elements of one array onto the end of another array in place.
public	function	UKismetArrayLibrary::Array_Clear	Removes all elements from an array, leaving it empty.
public	function	UKismetArrayLibrary::Array_Contains	Returns true if the array contains at least one instance of a value.
public	function	UKismetArrayLibrary::Array_Find	Returns the index of the first instance of a value in an array, or -1 if it isn't found.
public	function	UKismetArrayLibrary::Array_Get	Returns a copy of the array element at the given index via an output parameter.
public	function	UKismetArrayLibrary::Array_Insert	Inserts an item into an array at the given index, shifting later elements up by one.
public	function	UKismetArrayLibrary::Array_IsEmpty	Returns true if the array has no elements.
public	function	UKismetArrayLibrary::Array_IsNotEmpty	Returns true if the array has at least one element.
public	function	UKismetArrayLibrary::Array_Length	Returns the number of elements in an array.
public	function	UKismetArrayLibrary::Array_Random	Picks a random element from an array using the global random stream and returns both the value and its index.
public	function	UKismetArrayLibrary::Array_Remove	Removes the element at the given index from an array, shifting later elements down by one.
public	function	UKismetArrayLibrary::Array_RemoveItem	Removes all instances of a value from an array and reports whether anything was removed.
public	function	UKismetArrayLibrary::Array_Set	Assigns a value to the array element at the given index, optionally growing the array to fit.
public	function	UKismetArrayLibrary::Array_Shuffle	Randomizes the order of the elements in an array in place using the engine's global random stream.
public	function	UKismetArrayLibrary::SortFloatArray	Sorts an array of floating-point values in place by numeric value.
public	function	UKismetArrayLibrary::SortIntArray	Sorts an array of 32-bit integers in place by numeric value.
public	function	UKismetArrayLibrary::SortStringArray	Sorts an array of strings in place, alphabetically by default.
public	function	UKismetArrayLibrary::Array_Identical	Checks whether two arrays are memberwise identical — same length and equal elements at every index, in order.
public	function	UKismetArrayLibrary::Array_IsValidIndex	Returns true if the given index is within bounds for the array — greater than or equal to zero and less than its length.
public	function	UKismetArrayLibrary::Array_LastIndex	Returns the index of the last element in an array.
public	function	UKismetArrayLibrary::Array_RandomFromStream	Picks a random element from an array using a caller-supplied FRandomStream, producing reproducible results for a given seed.
public	function	UKismetArrayLibrary::Array_Resize	Resizes an array to the given size, truncating extra elements or appending default-constructed ones as needed.
public	function	UKismetArrayLibrary::Array_Reverse	Reverses the order of the elements in an array, in place.
public	function	UKismetArrayLibrary::Array_ShuffleFromStream	Randomizes the order of the elements in an array in place, drawing randomness from the given FRandomStream for deterministic results.
public	function	UKismetArrayLibrary::Array_Swap	Swaps the elements at two indices in an array.
public	function	UKismetArrayLibrary::FilterArray	Returns a new array containing only the actors from TargetArray that are instances of FilterClass.
public	function	UKismetArrayLibrary::SortByteArray	Sorts an array of bytes (uint8) in place by numeric value.
public	function	UKismetArrayLibrary::SortInt64Array	Sorts an array of 64-bit integers in place by numeric value.
public	function	UKismetArrayLibrary::SortNameArray	Sorts an array of FNames in place.
public	function	UKismetArrayLibrary::SetArrayPropertyByName	Assigns a value to a named array property on an object using reflection.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?