Difference between revisions of "RunBatchScript"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Scruggs
(add filename param and example)
imported>Scruggs
(update with optional second param)
 
Line 2: Line 2:


'''Syntax:'''
'''Syntax:'''
(nothing) RunBatchScript filename:string
(nothing) ''ref.''RunBatchScript filename:string ''runOnRef:bool''


'''Example:'''
'''Example:'''
RunBatchScript "myScripts\script.txt" ; runs script contained in Oblivion\myScripts\script.txt
RunBatchScript "myScripts\script.txt" ; runs script contained in Oblivion\myScripts\script.txt


Runs a specified text file under the Oblivion directory as a script.
Runs a specified text file under the Oblivion directory as a script. If the second argument is non-zero, executes the script as if it had been called from the console while the calling reference was selected.


==Notes==
==Notes==

Latest revision as of 17:18, 31 August 2010

A command for Oblivion Script Extender

Syntax:

(nothing) ref.RunBatchScript filename:string runOnRef:bool

Example:

 RunBatchScript "myScripts\script.txt" ; runs script contained in Oblivion\myScripts\script.txt

Runs a specified text file under the Oblivion directory as a script. If the second argument is non-zero, executes the script as if it had been called from the console while the calling reference was selected.

Notes[edit | edit source]

  • Because the batch script runs on a temporary script object, it behaves as if each script line was called from the console. Therefore, variable declarations are ignored, and reference functions require an explicit calling reference.
  • Every line in the batch file will run before control passes back to the calling script.