Show / Hide Table of Contents

Class KismetArrayLibrary

Kismet Array Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
KismetArrayLibrary
Inherited Members
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class KismetArrayLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static KismetArrayLibrary DefaultObject { get; }
Property Value
Type Description
KismetArrayLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

Array_Add(Byte, Int32)

Add item to array @

Declaration
public static int Array_Add(byte TargetArray, int NewItem)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 NewItem
Returns
Type Description
System.Int32
Remarks

param TargetArray The array to add item to @param NewItem The item to add to the array @return The index of the newly added item

| Improve this Doc View Source

Array_AddUnique(Byte, Int32)

Add item to array (unique) @

Declaration
public static int Array_AddUnique(byte TargetArray, int NewItem)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 NewItem
Returns
Type Description
System.Int32
Remarks

param TargetArray The array to add item to @param NewItem The item to add to the array @return The index of the newly added item, or INDEX_NONE if the item is already present in the array

| Improve this Doc View Source

Array_Append(Byte, Byte)

Append an array to another array @

Declaration
public static void Array_Append(byte TargetArray, byte SourceArray)
Parameters
Type Name Description
System.Byte TargetArray
System.Byte SourceArray
Remarks

param TargetArray The array to add the source array to @param SourceArray The array to add to the target array

| Improve this Doc View Source

Array_Clear(Byte)

*Clear an array, removes all content * *@

Declaration
public static void Array_Clear(byte TargetArray)
Parameters
Type Name Description
System.Byte TargetArray
Remarks

param TargetArray The array to clear

| Improve this Doc View Source

Array_Contains(Byte, Int32)

*Returns true if the array contains the given item * *@

Declaration
public static bool Array_Contains(byte TargetArray, int ItemToFind)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 ItemToFind
Returns
Type Description
System.Boolean
Remarks

param TargetArray The array to search for the item *@param ItemToFind The item to look for *@return True if the item was found within the array

| Improve this Doc View Source

Array_Find(Byte, Int32)

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

Declaration
public static int Array_Find(byte TargetArray, int ItemToFind)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 ItemToFind
Returns
Type Description
System.Int32
Remarks

param TargetArray The array to search for the item *@param ItemToFind The item to look for *@return The index the item was found at, or -1 if not found

| Improve this Doc View Source

Array_Get(Byte, Int32)

*Given an array and an index, returns a copy of the item found at that index * *@

Declaration
public static int Array_Get(byte TargetArray, int Index)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 Index
Returns
Type Description
System.Int32
Remarks

param TargetArray The array to get an item from *@param Index The index in the array to get an item from *@return A copy of the item stored at the index

| Improve this Doc View Source

Array_Insert(Byte, Int32, Int32)

*Insert item at the given index into the array.

Declaration
public static void Array_Insert(byte TargetArray, int NewItem, int Index)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 NewItem
System.Int32 Index
Remarks

*@param TargetArray The array to insert into *@param NewItem The item to insert into the array *@param Index The index at which to insert the item into the array

| Improve this Doc View Source

Array_IsValidIndex(Byte, Int32)

*Tests if IndexToTest is valid, i.

Declaration
public static bool Array_IsValidIndex(byte TargetArray, int IndexToTest)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 IndexToTest
Returns
Type Description
System.Boolean
Remarks

e. greater than or equal to zero, and less than the number of elements in TargetArray. * *@param TargetArray Array to use for the IsValidIndex test *@param IndexToTest The Index, that we want to test for being valid *@return True if the Index is Valid, i.e. greater than or equal to zero, and less than the number of elements in TargetArray.

| Improve this Doc View Source

Array_LastIndex(Byte)

*Get the last valid index into an array * *@

Declaration
public static int Array_LastIndex(byte TargetArray)
Parameters
Type Name Description
System.Byte TargetArray
Returns
Type Description
System.Int32
Remarks

param TargetArray The array to perform the operation on *@return The last valid index of the array

| Improve this Doc View Source

Array_Length(Byte)

*Get the number of items in an array * *@

Declaration
public static int Array_Length(byte TargetArray)
Parameters
Type Name Description
System.Byte TargetArray
Returns
Type Description
System.Int32
Remarks

param TargetArray The array to get the length of *@return The length of the array

| Improve this Doc View Source

Array_Remove(Byte, Int32)

*Remove item at the given index from the array.

Declaration
public static void Array_Remove(byte TargetArray, int IndexToRemove)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 IndexToRemove
Remarks

*@param TargetArray The array to remove from *@param IndexToRemove The index into the array to remove from

| Improve this Doc View Source

Array_RemoveItem(Byte, Int32)

*Remove all instances of item from array.

Declaration
public static bool Array_RemoveItem(byte TargetArray, int Item)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 Item
Returns
Type Description
System.Boolean
Remarks

*@param TargetArray The array to remove from *@param Item The item to remove from the array *@return True if one or more items were removed

| Improve this Doc View Source

Array_Resize(Byte, Int32)

*Resize Array to specified size.

Declaration
public static void Array_Resize(byte TargetArray, int Size)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 Size
Remarks

*@param TargetArray The array to resize *@param Size The new size of the array

| Improve this Doc View Source

Array_Set(Byte, Int32, Int32, Boolean)

*Given an array and an index, assigns the item to that array element * *@

Declaration
public static void Array_Set(byte TargetArray, int Index, int Item, bool bSizeToFit)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 Index
System.Int32 Item
System.Boolean bSizeToFit
Remarks

param TargetArray The array to perform the operation on *@param Index The index to assign the item to *@param Item The item to assign to the index of the array *@param bSizeToFit If true, the array will expand if Index is greater than the current size of the array

| Improve this Doc View Source

Array_Shuffle(Byte)

Shuffle (randomize) the elements of an array @

Declaration
public static void Array_Shuffle(byte TargetArray)
Parameters
Type Name Description
System.Byte TargetArray
Remarks

param TargetArray The array to shuffle

| Improve this Doc View Source

Array_Swap(Byte, Int32, Int32)

*Swaps the elements at the specified positions in the specified array *If the specified positions are equal, invoking this method leaves the array unchanged * *@

Declaration
public static void Array_Swap(byte TargetArray, int FirstIndex, int SecondIndex)
Parameters
Type Name Description
System.Byte TargetArray
System.Int32 FirstIndex
System.Int32 SecondIndex
Remarks

param TargetArray The array to perform the operation on *@param FirstIndex The index of one element to be swapped *@param SecondIndex The index of the other element to be swapped

| Improve this Doc View Source

FilterArray(Byte, SubclassOf<Actor>)

*Filter an array based on a Class derived from Actor.

Declaration
public static IReadOnlyCollection<Actor> FilterArray(byte TargetArray, SubclassOf<Actor> FilterClass)
Parameters
Type Name Description
System.Byte TargetArray
SubclassOf<Actor> FilterClass
Returns
Type Description
System.Collections.Generic.IReadOnlyCollection<Actor>
Remarks

*@param TargetArray The array to filter from *@param FilterClass The Actor sub-class type that acts as the filter, only objects derived from it will be returned. *@return An array containing only those objects which are derived from the class specified.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static KismetArrayLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
KismetArrayLibrary
| Improve this Doc View Source

SetArrayPropertyByName(UObject, Name, Byte)

Not exposed to users. Supports setting an array property on an object by name.

Declaration
public static void SetArrayPropertyByName(UObject UObject, Name PropertyName, byte Value)
Parameters
Type Name Description
UObject UObject
Name PropertyName
System.Byte Value

Operators

| Improve this Doc View Source

Implicit(IntPtr to KismetArrayLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator KismetArrayLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
KismetArrayLibrary
  • Improve this Doc
  • View Source
Back to top Generated by DocFX