AuxiliaryVariableGetAll

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns a StringMap matrix containing all Auxiliary Variables of the specified class, and their elements' values, owned by the specified Object.

AuxVar Classes:

0	Permanent-Private
1	Temporary-Private
2	Permanent-Public
3	Temporary-Public
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]
(array_var) reference.AuxiliaryVariableGetAll varClass:int{0-3} baseForm:ref 

Or:

(array_var) reference.AuxVarGetAll varClass:int{0-3} baseForm:ref

Example

let aVarMap := RaulRef.AuxiliaryVariableGetAll 0
let aVarMap := AuxVarGetAll 1 ArmorCombat