AuxiliaryVariableSetString

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Sets the string value of the element at the specified index (optional; default is 0) of the specified Auxiliary-Variable. If index equals -1, the value will be appended as a new element, at the end.

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]
(success:bool) reference.AuxiliaryVariableSetString varName:string value:string index:int baseForm:ref 

Or:

(success:bool) reference.AuxVarSetStr varName:string value:string index:int baseForm:ref

Example

RaulRef.AuxiliaryVariableSetString "someVarName" "Snivelling, dim-witted weasel."
AuxVarSetStr "someVarName" "Toffee-nosed git." -1 ArmorCombat
player.AuxVarSetStr "*someVarName" $SomeStringVariable -1 

See Also