AuxiliaryVariableSetRef

From GECK
(Redirected from AuxVarSetRef)
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Sets the ref 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.AuxiliaryVariableSetRef varName:string value:ref index:int baseForm:ref 

Or:

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

Example

RaulRef.AuxiliaryVariableSetRef "someVarName" Ammo127mm
AuxVarSetRef "someVarName" CraigBooneRef -1 ArmorCombat 

See Also