Background for Skyrim SE
Member of the clib script
Actor[]functioncArrayRemoveIndexActor(Actor[]aArray, intindexToRemove=0, boolusePapUtil=true)Global

Description

Documentation String

Requirements: None, PapyrusUtil:Soft

Documentation Comment

'fill' empty values
--> cArrayReplace.(replaceThis = (None,0,0.0,""), withThis = filler)
Clear all values
--> 'clear' == cArrayReplace.
(replaceThis = (irrelevant), withThis = (None,0,0.0,""), forceAll = TRUE)
OR
--> 'clear' == cArrayCreate.()
Add new value to end
--> 'push' == cArrayResize.
(newSize = aArray.length + 1, filler = new value)
Remove Index [allows Pop & Shift behavior] (returns new array)
--> 'shift' mimic cArrayRemoveIndex.(indexToRemove == 0)
--> 'pop' mimic cArrayRemoveIndex.
(indexToRemove == aArray.length)
Add new index 'unshift'
--> use cArrayMerge.*


Parameters

  1. Actor[]aArray

  2. intindexToRemove=0

  3. boolusePapUtil=true


Examples

Auto-Generated Example

Actor[] myActorArray__aArray
int myInt__indexToRemove
bool myBool__usePapUtil

Actor[] returnedValue = clib.cArrayRemoveIndexActor(myActorArray__aArray, myInt__indexToRemove, myBool__usePapUtil)
Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.