Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Kismet
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UBlueprintFunctionLibrary
- UKismetArrayLibrary
References
Module | Engine |
Header | /Engine/Source/Runtime/Engine/Classes/Kismet/KismetArrayLibrary.h |
Include | #include "Kismet/KismetArrayLibrary.h" |
Syntax
class UKismetArrayLibrary : public UBlueprintFunctionLibrary
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UKismetArrayLibrary
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
int32 | Add item to array | |
![]() ![]() |
int32 | Array_AddUnique
(
const TArray< int32 >& TargetArray, |
Add item to array (unique) |
![]() ![]() |
void | Array_Append
(
const TArray< int32 >& TargetArray, |
Append an array to another array |
![]() ![]() |
void | Array_Clear
(
const TArray< int32 >& TargetArray |
Clear an array, removes all content |
![]() ![]() |
bool | Array_Contains
(
const TArray< int32 >& TargetArray, |
Returns true if the array contains the given item |
![]() ![]() |
int32 | Array_Find
(
const TArray< int32 >& TargetArray, |
Finds the index of the first instance of the item within the array |
![]() ![]() |
void | Given an array and an index, returns a copy of the item found at that index | |
![]() ![]() |
bool | Array_Identical
(
const TArray< int32 >& ArrayA, |
Checks if two arrays are memberwise identical |
![]() ![]() |
void | Array_Insert
(
const TArray< int32 >& TargetArray, |
Insert item at the given index into the array. |
![]() ![]() |
bool | Array_IsEmpty
(
const TArray< int32 >& TargetArray |
Check if the array is empty |
![]() ![]() |
bool | Array_IsNotEmpty
(
const TArray< int32 >& TargetArray |
Check if the array has any elements |
![]() ![]() |
bool | Array_IsValidIndex
(
const TArray< int32 >& TargetArray, |
Tests if IndexToTest is valid, i.e. greater than or equal to zero, and less than the number of elements in TargetArray. |
![]() ![]() |
int32 | Array_LastIndex
(
const TArray< int32 >& TargetArray |
Get the last valid index into an array |
![]() ![]() |
int32 | Array_Length
(
const TArray< int32 >& TargetArray |
Get the number of items in an array |
![]() ![]() |
void | Array_Random
(
const TArray< int32 >& TargetArray, |
Gets a random item from specified array |
![]() ![]() |
void | Array_RandomFromStream
(
const TArray< int32 >& TargetArray, |
Gets a random item from specified array (using random stream) |
![]() ![]() |
void | Array_Remove
(
const TArray< int32 >& TargetArray, |
Remove item at the given index from the array. |
![]() ![]() |
bool | Array_RemoveItem
(
const TArray< int32 >& TargetArray, |
Remove all instances of item from array. |
![]() ![]() |
void | Array_Resize
(
const TArray< int32 >& TargetArray, |
Resize Array to specified size. |
![]() ![]() |
void | Array_Reverse
(
const TArray< int32 >& TargetArray |
Reverse the elements of an array |
![]() ![]() |
void | Given an array and an index, assigns the item to that array element | |
![]() ![]() |
void | Array_Shuffle
(
const TArray< int32 >& TargetArray |
Shuffle (randomize) the elements of an array |
![]() ![]() |
void | Array_ShuffleFromStream
(
const TArray< int32 >& TargetArray, |
Shuffle (randomize) the elements of an array from a specific stream of random data, useful for achieving determinism |
![]() ![]() |
void | Array_Swap
(
const TArray< int32 >& TargetArray, |
Swaps the elements at the specified positions in the specified array If the specified positions are equal, invoking this method leaves the array unchanged |
![]() ![]() |
void | FilterArray
(
const TArray< AActor* >& TargetArray, |
Filter an array based on a Class derived from Actor. |
![]() ![]() |
int32 | GenericArray_Add
(
void* TargetArray, |
Native functions that will be called by the below custom thunk layers, which read off the property address, and call the appropriate native handler. |
![]() ![]() |
int32 | GenericArray_AddUnique
(
void* TargetArray, |
Native functions that will be called by the below custom thunk layers, which read off the property address, and call the appropriate native handler. |
![]() ![]() |
void | GenericArray_Append
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Clear
(
void* TargetArray, |
|
![]() ![]() |
int32 | GenericArray_Find
(
const void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Get
(
void* TargetArray, |
|
![]() ![]() |
bool | GenericArray_Identical
(
void* ArrayA, |
|
![]() ![]() |
void | GenericArray_Insert
(
void* TargetArray, |
|
![]() ![]() |
bool | GenericArray_IsEmpty
(
const void* TargetArray, |
|
![]() ![]() |
bool | GenericArray_IsNotEmpty
(
const void* TargetArray, |
|
![]() ![]() |
bool | GenericArray_IsValidIndex
(
const void* TargetArray, |
|
![]() ![]() |
int32 | GenericArray_LastIndex
(
const void* TargetArray, |
|
![]() ![]() |
int32 | GenericArray_Length
(
const void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Random
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_RandomFromStream
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Remove
(
void* TargetArray, |
|
![]() ![]() |
bool | GenericArray_RemoveItem
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Resize
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Reverse
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Set
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_SetArrayPropertyByName
(
UObject* OwnerObject, |
|
![]() ![]() |
void | GenericArray_Shuffle
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_ShuffleFromStream
(
void* TargetArray, |
|
![]() ![]() |
void | GenericArray_Swap
(
const void* TargetArray, |
|
![]() ![]() |
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. |
![]() ![]() |
void | SetArrayPropertyByName
(
UObject* Object, |
Not exposed to users. Supports setting an array property on an object by name. |
Constants
Name | Description |
---|---|
MaxSupportedArraySize | |
ReachedMaximumContainerSizeWarning | Shared warning IDs for use by other container libraries. |