AuxiliaryVariableGetSize

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the number of elements of the specified Auxiliary-Variable (or 0 if the variable is not defined).

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]
(size:int) reference.AuxiliaryVariableGetSize varName:string baseForm:ref 

Or:

(size:int) reference.AuxVarSize varName:string baseForm:ref

Example

set iSize to RaulRef.AuxiliaryVariableGetSize "someVarName"
set iSize to AuxVarSize "someVarName" ArmorCombat