Difference between revisions of "RunScript"

Latest revision as of 16:51, 9 March 2015

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

Runs a script, which may be passed literally or attached to a form. This allows scripts to be run without a reference. Added by NVSE V4.1*.

(none) RunScript Script:Script-or-ScriptedForm

RunScript MyScript ; to run script MyScript

; or
RunScript MyToken ; to run the script attached to the item, MyToken

As of NVSE 4.6.3, this function seems to run the first block of the script once, and only if it is appropriate (eg: first block is GameMode).

@@ Line 1: / Line 1: @@
 {{Function
   |origin = NVSE
-  |summary = Adds the script attached to the passed form to the list of active scripts. This should allow one to start a script that is not attached to any reference. The script may keep running indefinitely, unless it crashes. Added by NVSE V4.1.
+  |summary = Runs a script, which may be passed literally or attached to a form. This allows scripts to be run without a reference. Added by NVSE V4.1*.
   |name = RunScript
   |returnType = none
   |arguments = {{FunctionArgument
-    |Name = Scripted
+    |Name = Script
-    |Type = baseform
+    |Type = Script-or-ScriptedForm
    }}
   |referenceType =
 }}
+==Example==
+<pre>
+RunScript MyScript ; to run script MyScript
+; or
+RunScript MyToken ; to run the script attached to the item, MyToken
+</pre>
+==Unreliable?==
+*As of NVSE 4.6.3, this function seems to run the first block of the script once, and only if it is appropriate (eg: first block is GameMode).
-==Broken?==
-*As of NVSE 4.5.6, this function does not appear to do anything.
 ==See Also==
 *[[GetCurrentScript]]