Difference between revisions of "AddScriptVariable"

Latest revision as of 16:52, 5 April 2015

< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Adds a new variable to either an object script (when called by an object reference), or a quest script (when called on a quest).

(added:0/1) reference.AddScriptVariable varName:string quest:ref

RaulRef.AddScriptVariable "NewVar"

AddScriptVariable "NewVar" VERNovac01

The new variable has no explicit type, and can store either a numeric (float) value, or a reference.
To retrieve/set the value of the new variable, use any of GetVariable/GetRefVariable/SetVariable/SetRefVariable.
The new variable is saved with the game.

@@ Line 3: / Line 3: @@
  |summary = Adds a new variable to either an object script (when called by an object reference), or a quest script (when called on a quest).
  |name = AddScriptVariable
+ |returnType = added:0/1
  |referenceType = reference
  |arguments =
@@ Line 20: / Line 21: @@
 *The new variable has no explicit type, and can store either a numeric (float) value, or a reference.
 *To retrieve/set the value of the new variable, use any of [[GetVariable]]/[[GetRefVariable]]/[[SetVariable]]/[[SetRefVariable]].
-*The new variable remains valid only for the duration of the current game-session, and is lost when the game is restarted.
+*The new variable is saved with the game.
 ==See Also==
+*[[RemoveScriptVariable]]
+*[[RemoveAllAddedVariables]]
+*[[HasVariableAdded]]
+*[[GetVariable]]
+*[[GetRefVariable]]
+*[[SetVariable]]
+*[[SetRefVariable]]
 [[Category:Functions_(JIP)]]
+[[Category:Script Functions (JIP)]]