AuxVarGetFltCond

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

A modified form of AuxiliaryVariableGetFloat that works as a Condition. Returns the float value of the element at index 0 of the specified Auxiliary-Variable for the calling ref.

The Aux Var's Name is specified in the Parameter window, where one must select a Quest which has a Quest Script that contains a String Variable. The contents of this String will be used as the Name. The Integer field indicates on what index this string variable has in the script.

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.

This function can only be used as a Condition.

Syntax

[help]
AuxVarGetFltCond Quest:string Integer:int 

Notes

  • Integer in the parameters is The variable's index (visible in xEdit, NOT directly based on where the variable is line-wise).
  • The function will return 0 if the variable is not defined / has no element at index = 0 / element is not of type float.