- Found in:
- Dylbills PE
intfunctionRemoveFromArray(stringakHandle, stringsScriptName, stringsArrayPropertyName, intindex=-1, boolremoveAll=false)NativeGlobal
Description
Documentation Comment
Remove the element at the index from the array.
If the removeAll parameter is true, removes all elements from the array that match the element at the index
A value of -1 for the index (default) means the last element in the array.
Returns the amount of elements removed, if it returns 0 it means the index wasn't valid (>= array.length)
Caveats
Parameters
stringakHandle
stringsScriptName
stringsArrayPropertyName
intindex=-1
boolremoveAll=false
Examples
Auto-Generated Example
string myString__akHandle
string myString__sScriptName
string myString__sArrayPropertyName
int myInt__index
bool myBool__removeAll
int returnedValue = PapyrusUtilEx.RemoveFromArray(myString__akHandle, myString__sScriptName, myString__sArrayPropertyName, myInt__index, myBool__removeAll)