AuxiliaryVariableErase
From GECK
(Redirected from AuxVarErase)
A function added by the JIP NVSE Plugin.
Contents
Description
Erases the element at the specified index of the specified Auxiliary-Variable. If index is not specified, or equals -1, the variable, along with all its elements, will be erased. Returns the Aux Variable's new number of elements, NOT the amount of elements that were erased.
If you are making a patch for a script that is using AuxVar functions, and that patch is an ESM/ESP, the ESM/ESP will overwritte the Mod Index of the AuxVar is attached to, and the original script will lose access to the AuxVar. So if another script within the master plugin is attempting to check the AuxVar, it will not be able to, as the Mod Index has now been overwritten.
Syntax
(numElements:int) reference.AuxiliaryVariableErase varName:string index:int baseForm:ref
Or:
(numElements:int) reference.AuxVarErase varName:string index:int baseForm:ref
Example
RaulRef.AuxiliaryVariableErase "someVarName"
AuxVarErase "someVarName" 2 ArmorCombat
