AuxiliaryVariableGetRef

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Description

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

Syntax

[help]
(value:ref) reference.AuxiliaryVariableGetRef varName:string index:int baseForm:ref 

Or: 

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

Example

set rValue to RaulRef.AuxiliaryVariableGetRef "someVarName"

set rValue to AuxVarGetRef "someVarName" 2 ArmorCombat

Notes

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

See Also

Retrieved from "https://geck.uesp.net/w/index.php?title=AuxiliaryVariableGetRef&oldid=4517"