AuxiliaryVariableGetString

A function added by the JIP NVSE Plugin.

Description

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

Syntax

[help]

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

Or:

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

Example

let sValue := RaulRef.AuxiliaryVariableGetString "someVarName"

let sValue := AuxVarGetStr "someVarName" 2 ArmorCombat 

Notes

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

See Also

• AuxiliaryVariableSetString
• AuxiliaryVariableSetFloat / AuxiliaryVariableGetFloat
• AuxiliaryVariableSetRef / AuxiliaryVariableGetRef