1. Epic GamesDeveloper
  3. UKismetArrayLibrary

UKismetArrayLibrary

API > API/Runtime > API/Runtime/Engine

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

Syntax

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

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UKismetArrayLibrary ( const FObjectInitializer& ObjectInitializer
)

   Kismet/KismetArrayLibrary.h  

Constants

Name Type Remarks Include Path
MaxSupportedArraySize int32   Kismet/KismetArrayLibrary.h
ReachedMaximumContainerSizeWarning const FName Shared warning IDs for use by other container libraries. Kismet/KismetArrayLibrary.h

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static int32 Array_Add ( const TArray< int32 >& TargetArray,
const int32& NewItem
)

 Add item to array Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Add", CompactNodeTitle="ADD", ArrayParm="TargetArray", ArrayTypeDependentParams="NewItem", AutoCreateRefTerm="NewItem")
  • Category="Utilities|Array"

static int32 Array_AddUnique ( const TArray< int32 >& TargetArray,
const int32& NewItem
)

 Add item to array (unique) Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Add Unique", CompactNodeTitle="ADDUNIQUE", ArrayParm="TargetArray", ArrayTypeDependentParams="NewItem", AutoCreateRefTerm="NewItem")
  • Category="Utilities|Array"

static void Array_Append ( const TArray< int32 >& TargetArray,
const TArray< int32 >& SourceArray
)

 Append an array to another array Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Append Array", CompactNodeTitle="APPEND", ArrayParm="TargetArray,SourceArray", ArrayTypeDependentParams="SourceArray")
  • Category="Utilities|Array"

static void Array_Clear ( const TArray< int32 >& TargetArray
)

 Clear an array, removes all content Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Clear", CompactNodeTitle="CLEAR", Keywords="empty", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static bool Array_Contains ( const TArray< int32 >& TargetArray,
const int32& ItemToFind
)

 Returns true if the array contains the given item Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Contains Item", CompactNodeTitle="CONTAINS", ArrayParm="TargetArray", ArrayTypeDependentParams="ItemToFind", AutoCreateRefTerm="ItemToFind", BlueprintThreadSafe)
  • Category="Utilities|Array"

static int32 Array_Find ( const TArray< int32 >& TargetArray,
const int32& ItemToFind
)

 Finds the index of the first instance of the item within the array Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Find Item", CompactNodeTitle="FIND", ArrayParm="TargetArray", ArrayTypeDependentParams="ItemToFind", AutoCreateRefTerm="ItemToFind", BlueprintThreadSafe)
  • Category="Utilities|Array"

static void Array_Get ( const TArray< int32 >& TargetArray,
int32 Index,
int32& Item
)

 Given an array and an index, returns a copy of the item found at that index Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(BlueprintInternalUseOnly="true", DisplayName="Get", CompactNodeTitle="GET", ArrayParm="TargetArray", ArrayTypeDependentParams="Item", BlueprintThreadSafe)
  • Category="Utilities|Array"

static bool Array_Identical ( const TArray< int32 >& ArrayA,
const TArray< int32 >& ArrayB
)

 Checks if two arrays are memberwise identical Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Identical", CompactNodeTitle="==", ArrayParm="ArrayA,ArrayB", ArrayTypeDependentParams="ArrayB")
  • Category="Utilities|Array"

static void Array_Insert ( const TArray< int32 >& TargetArray,
const int32& NewItem,
int32 Index
)

 Insert item at the given index into the array. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Insert", CompactNodeTitle="INSERT", ArrayParm="TargetArray", ArrayTypeDependentParams="NewItem", AutoCreateRefTerm="NewItem")
  • Category="Utilities|Array"

static bool Array_IsEmpty ( const TArray< int32 >& TargetArray
)

 Check if the array is empty Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Is Empty", CompactNodeTitle="IS EMPTY", ArrayParm="TargetArray", BlueprintThreadSafe)
  • Category="Utilities|Array"

static bool Array_IsNotEmpty ( const TArray< int32 >& TargetArray
)

 Check if the array has any elements Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Is Not Empty", CompactNodeTitle="IS NOT EMPTY", ArrayParm="TargetArray", BlueprintThreadSafe)
  • Category="Utilities|Array"

static bool Array_IsValidIndex ( const TArray< int32 >& TargetArray,
int32 IndexToTest
)

 Tests if IndexToTest is valid, i.e. greater than or equal to zero, and less than the number of elements in TargetArray. Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Is Valid Index", CompactNodeTitle="IS VALID INDEX", ArrayParm="TargetArray", BlueprintThreadSafe)
  • Category="Utilities|Array"

static int32 Array_LastIndex ( const TArray< int32 >& TargetArray
)

 Get the last valid index into an array Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Last Index", CompactNodeTitle="LAST INDEX", ArrayParm="TargetArray", BlueprintThreadSafe)
  • Category="Utilities|Array"

static int32 Array_Length ( const TArray< int32 >& TargetArray
)

 Get the number of items in an array Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Length", CompactNodeTitle="LENGTH", ArrayParm="TargetArray", Keywords="num size count", BlueprintThreadSafe)
  • Category="Utilities|Array"

static void Array_Random ( const TArray< int32 >& TargetArray,
int32& OutItem,
int32& OutIndex
)

 Gets a random item from specified array Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Random Array Item", CompactNodeTitle="RANDOM", ArrayParm="TargetArray", ArrayTypeDependentParams="OutItem")
  • Category="Utilities|Array"

static void Array_RandomFromStream ( const TArray< int32 >& TargetArray,
FRandomStream& RandomStream,
int32& OutItem,
int32& OutIndex
)

 Gets a random item from specified array (using random stream) Kismet/KismetArrayLibrary.h
  • BlueprintPure
  • CustomThunk
  • Meta=(DisplayName="Random Array Item from Stream", ArrayParm="TargetArray", ArrayTypeDependentParams="OutItem")
  • Category="Utilities|Array"

static void Array_Remove ( const TArray< int32 >& TargetArray,
int32 IndexToRemove
)

 Remove item at the given index from the array. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Remove Index", CompactNodeTitle="REMOVE INDEX", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static bool Array_RemoveItem ( const TArray< int32 >& TargetArray,
const int32& Item
)

 Remove all instances of item from array. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Remove Item", CompactNodeTitle="REMOVE", ArrayParm="TargetArray", ArrayTypeDependentParams="Item", AutoCreateRefTerm="Item")
  • Category="Utilities|Array"

static void Array_Resize ( const TArray< int32 >& TargetArray,
int32 Size
)

 Resize Array to specified size. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Resize", CompactNodeTitle="RESIZE", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static void Array_Reverse ( const TArray< int32 >& TargetArray
)

 Reverse the elements of an array Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Reverse", CompactNodeTitle="REVERSE", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static void Array_Set ( const TArray< int32 >& TargetArray,
int32 Index,
const int32& Item,
bool bSizeToFit
)

 Given an array and an index, assigns the item to that array element Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Set Array Elem", ArrayParm="TargetArray", ArrayTypeDependentParams="Item", AutoCreateRefTerm="Item")
  • Category="Utilities|Array"

static void Array_Shuffle ( const TArray< int32 >& TargetArray
)

 Shuffle (randomize) the elements of an array Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Shuffle", CompactNodeTitle="SHUFFLE", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static void Array_ShuffleFromStream ( const TArray< int32 >& TargetArray,
FRandomStream& RandomStream
)

 Shuffle (randomize) the elements of an array from a specific stream of random data, useful for achieving determinism Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Shuffle from Stream", CompactNodeTitle="SHUFFLE", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static void Array_Swap ( const TArray< int32 >& TargetArray,
int32 FirstIndex,
int32 SecondIndex
)

 Swaps the elements at the specified positions in the specified array If the specified positions are equal, invoking this method leaves the array unchanged Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(DisplayName="Swap Array Elements", CompactNodeTitle="SWAP", ArrayParm="TargetArray")
  • Category="Utilities|Array"

static void FilterArray ( const TArray< AActor* >& TargetArray,
TSubclassOf< class AActor > FilterClass,
TArray< AActor* >& FilteredArray
)

 Filter an array based on a Class derived from Actor. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Meta=(DisplayName="Filter Array", DeterminesOutputType="FilterClass", DynamicOutputParam="FilteredArray")
  • Category="Utilities|Array"

static int32 GenericArray_Add ( void* TargetArray,
const FArrayProperty* ArrayProp,
const void* NewItem
)

 Native functions that will be called by the below custom thunk layers, which read off the property address, and call the appropriate native handler. Kismet/KismetArrayLibrary.h  

static int32 GenericArray_AddUnique ( void* TargetArray,
const FArrayProperty* ArrayProp,
const void* NewItem
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Append ( void* TargetArray,
const FArrayProperty* TargetArrayProp,
void* SourceArray,
const FArrayProperty* SourceArrayProperty
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Clear ( void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static int32 GenericArray_Find ( const void* TargetArray,
const FArrayProperty* ArrayProperty,
const void* ItemToFind
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Get ( void* TargetArray,
const FArrayProperty* ArrayProp,
int32 Index,
void* Item
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_HandleBool ( const FProperty* Property,
void* ItemPtr
)

   Kismet/KismetArrayLibrary.h  

static bool GenericArray_Identical ( void* ArrayA,
const FArrayProperty* ArrayAProp,
void* ArrayB,
const FArrayProperty* ArrayBProperty
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Insert ( void* TargetArray,
const FArrayProperty* ArrayProp,
const void* NewItem,
int32 Index
)

   Kismet/KismetArrayLibrary.h  

static bool GenericArray_IsEmpty ( const void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static bool GenericArray_IsNotEmpty ( const void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static bool GenericArray_IsValidIndex ( const void* TargetArray,
const FArrayProperty* ArrayProp,
int32 IndexToTest
)

   Kismet/KismetArrayLibrary.h  

static int32 GenericArray_LastIndex ( const void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static int32 GenericArray_Length ( const void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Random ( void* TargetArray,
const FArrayProperty* ArrayProp,
void* OutItem,
int32* OutIndex
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_RandomFromStream ( void* TargetArray,
const FArrayProperty* ArrayProp,
FRandomStream* RandomStream,
void* OutItem,
int32* OutIndex
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Remove ( void* TargetArray,
const FArrayProperty* ArrayProp,
int32 IndexToRemove
)

   Kismet/KismetArrayLibrary.h  

static bool GenericArray_RemoveItem ( void* TargetArray,
const FArrayProperty* ArrayProp,
const void* Item
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Resize ( void* TargetArray,
const FArrayProperty* ArrayProp,
int32 Size
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Reverse ( void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Set ( void* TargetArray,
const FArrayProperty* ArrayProp,
int32 Index,
const void* NewItem,
bool bSizeToFit
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_SetArrayPropertyByName ( UObject* OwnerObject,
FName ArrayPropertyName,
const void* SrcArrayAddr
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Shuffle ( void* TargetArray,
const FArrayProperty* ArrayProp
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_ShuffleFromStream ( void* TargetArray,
const FArrayProperty* ArrayProp,
FRandomStream* RandomStream
)

   Kismet/KismetArrayLibrary.h  

static void GenericArray_Swap ( const void* TargetArray,
const FArrayProperty* ArrayProp,
int32 First,
int32 Second
)

   Kismet/KismetArrayLibrary.h  

static int32 GetLastIndex ( const FScriptArrayHelper& ArrayHelper
)

 Helper function to get the last valid index of the array for error reporting, or 0 if the array is empty. Kismet/KismetArrayLibrary.h  

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

 Not exposed to users. Supports setting an array property on an object by name. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • CustomThunk
  • Meta=(BlueprintInternalUseOnly="true", ArrayParm="Value", ArrayTypeDependentParams="Value")

static void SortByteArray ( TArray< uint8 >& TargetArray,
bool bStableSort,
EArraySortOrder SortOrder
)

 Sorts an array of bytes. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Category="Utilities|Array|Sort"
  • Meta=(AdvancedDisplay="bStableSort,SortOrder")

static void SortFloatArray ( TArray< double >& TargetArray,
bool bStableSort,
EArraySortOrder SortOrder
)

 Sorts an array of doubles. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Category="Utilities|Array|Sort"
  • Meta=(AdvancedDisplay="bStableSort,SortOrder")

static void SortInt64Array ( TArray< int64 >& TargetArray,
bool bStableSort,
EArraySortOrder SortOrder
)

 Sorts an array of 64-bit integers. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Category="Utilities|Array|Sort"
  • Meta=(DisplayName="Sort Integer64 Array", AdvancedDisplay="bStableSort,SortOrder")

static void SortIntArray ( TArray< int32 >& TargetArray,
bool bStableSort,
EArraySortOrder SortOrder
)

 Sorts an array of integers. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Category="Utilities|Array|Sort"
  • Meta=(DisplayName="Sort Integer Array", AdvancedDisplay="bStableSort,SortOrder")

static void SortNameArray ( TArray< FName >& TargetArray,
bool bStableSort,
bool bLexicalSort,
EArraySortOrder SortOrder
)

 Sorts an array of FNames. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Category="Utilities|Array|Sort"
  • Meta=(AdvancedDisplay="bStableSort,bLexicalSort,SortOrder")

static void SortStringArray ( TArray< FString >& TargetArray,
bool bStableSort,
EArraySortOrder SortOrder
)

 Sorts an array of strings alphabetically. Kismet/KismetArrayLibrary.h
  • BlueprintCallable
  • Category="Utilities|Array|Sort"
  • Meta=(AdvancedDisplay="bStableSort,SortOrder")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page