UKismetArrayLibrary

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Kismet/KismetArrayLibrary.h

Include

#include "Kismet/KismetArrayLibrary.h"

Syntax

class UKismetArrayLibrary : public UBlueprintFunctionLibrary

Constructors

Name Description

Public function

UKismetArrayLibrary

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Static

int32

 

Array_Add

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

Add item to array

Public function Static

int32

 

Array_AddUnique

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

Add item to array (unique)

Public function Static

void

 

Array_Append

(
    const TArray< int32 >& TargetArray,
    const TArray< int32 >& SourceArray
)

Append an array to another array

Public function Static

void

 

Array_Clear

(
    const TArray< int32 >& TargetArray
)

Clear an array, removes all content

Public function Static

bool

 

Array_Contains

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

Returns true if the array contains the given item

Public function Static

int32

 

Array_Find

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

Finds the index of the first instance of the item within the array

Public function 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

Public function Static

bool

 

Array_Identical

(
    const TArray< int32 >& ArrayA,
    const TArray< int32 >& ArrayB
)

Checks if two arrays are memberwise identical

Public function Static

void

 

Array_Insert

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

Insert item at the given index into the array.

Public function 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.

Public function Static

int32

 

Array_LastIndex

(
    const TArray< int32 >& TargetArray
)

Get the last valid index into an array

Public function Static

int32

 

Array_Length

(
    const TArray< int32 >& TargetArray
)

Get the number of items in an array

Public function Static

void

 

Array_Random

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

Gets a random item from specified array

Public function Static

void

 

Array_RandomFromStream

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

Gets a random item from specified array (using random stream)

Public function Static

void

 

Array_Remove

(
    const TArray< int32 >& TargetArray,
    int32 IndexToRemove
)

Remove item at the given index from the array.

Public function Static

bool

 

Array_RemoveItem

(
    const TArray< int32 >& TargetArray,
    const int32& Item
)

Remove all instances of item from array.

Public function Static

void

 

Array_Resize

(
    const TArray< int32 >& TargetArray,
    int32 Size
)

Resize Array to specified size.

Public function Static

void

 

Array_Reverse

(
    const TArray< int32 >& TargetArray
)

Reverse the elements of an array

Public function 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

Public function Static

void

 

Array_Shuffle

(
    const TArray< int32 >& TargetArray
)

Shuffle (randomize) the elements of an array

Public function 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

Public function Static

void

 

FilterArray

(
    const TArray< AActor* >& Targ...,
    TSubclassOf< class AActor > FilterC...,
    TArray< AActor* >& FilteredAr...
)

Filter an array based on a Class derived from Actor.

Public function Static

int32

 

GenericArray_Add

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    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.

Public function Static

int32

 

GenericArray_AddUnique

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    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.

Public function Static

void

 

GenericArray_Append

(
    void* TargetArray,
    const FArrayProperty* TargetAr...,
    void* SourceArray,
    const FArrayProperty* SourceAr...
)

Public function Static

void

 

GenericArray_Clear

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...
)

Public function Static

int32

 

GenericArray_Find

(
    const void* TargetArray,
    const FArrayProperty* ArrayPro...,
    const void* ItemToFind
)

Public function Static

void

 

GenericArray_Get

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    int32 Index,
    void* Item
)

Public function Static

bool

 

GenericArray_Identical

(
    void* ArrayA,
    const FArrayProperty* ArrayAPr...,
    void* ArrayB,
    const FArrayProperty* ArrayBPr...
)

Public function Static

void

 

GenericArray_Insert

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    const void* NewItem,
    int32 Index
)

Public function Static

bool

 

GenericArray_IsValidIndex

(
    const void* TargetArray,
    const FArrayProperty* ArrayPro...,
    int32 IndexToTest
)

Public function Static

int32

 

GenericArray_LastIndex

(
    const void* TargetArray,
    const FArrayProperty* ArrayPro...
)

Public function Static

int32

 

GenericArray_Length

(
    const void* TargetArray,
    const FArrayProperty* ArrayPro...
)

Public function Static

void

 

GenericArray_Random

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    void* OutItem,
    int32* OutIndex
)

Public function Static

void

 

GenericArray_RandomFromStream

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    FRandomStream* RandomStream,
    void* OutItem,
    int32* OutIndex
)

Public function Static

void

 

GenericArray_Remove

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    int32 IndexToRemove
)

Public function Static

bool

 

GenericArray_RemoveItem

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    const void* Item
)

Public function Static

void

 

GenericArray_Resize

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    int32 Size
)

Public function Static

void

 

GenericArray_Reverse

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...
)

Public function Static

void

 

GenericArray_Set

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...,
    int32 Index,
    const void* NewItem,
    bool bSizeToFit
)

Public function Static

void

 

GenericArray_SetArrayPropertyByName

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

Public function Static

void

 

GenericArray_Shuffle

(
    void* TargetArray,
    const FArrayProperty* ArrayPro...
)

Public function Static

void

 

GenericArray_Swap

(
    const void* TargetArray,
    const FArrayProperty* ArrayPro...,
    int32 First,
    int32 Second
)

Public function Static

int32

 

GetLastIndex

(
    const FScriptArrayHelper& ArrayHel...
)

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

Public function 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.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss