AuxiliaryVariableGetFloat

A function added by the JIP NVSE Plugin.

Description

Returns the float value of the element at the specified index (optional; default is 0) of the specified Auxiliary-Variable.

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]

(value:float) reference.AuxiliaryVariableGetFloat varName:string index:int baseForm:ref 

Or:

(value:float) reference.AuxVarGetFlt varName:string index:int baseForm:ref

Example

set fValue to RaulRef.AuxiliaryVariableGetFloat "someVarName"

set fValue to AuxVarGetFlt "someVarName" 2 ArmorCombat 

Notes

• The function will (presumably) return 0 if the variable is not defined/has no element at index/element is not of type float. When necessary, verify using AuxiliaryVariableGetType.

See Also

• AuxiliaryVariableSetFloat
• AuxiliaryVariableSetString / AuxiliaryVariableGetString
• AuxiliaryVariableSetRef / AuxiliaryVariableGetRef