AuxiliaryVariableEraseAll

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Erases all Auxiliary Variables of the specified class, owned by the specified Object.

AuxVar Classes:

0	Permanent-Private
1	Temporary-Private
2	Permanent-Public
3	Temporary-Public

When erasing Private Auxiliary Variables, only the ones belonging to the calling mod will be erased.
Otherwise, when erasing Public AuxVars, all of them will be 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

[help]
reference.AuxiliaryVariableEraseAll varClass:int{0-3} baseForm:ref 

Or:

reference.AuxVarEraseAll varClass:int{0-3} baseForm:ref

Example

RaulRef.AuxiliaryVariableEraseAll 0
AuxVarEraseAll 1 ArmorCombat