mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 06:48:42 +02:00
v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation
This commit is contained in:
33
doc/source/netscript/basicfunctions/run.rst
Normal file
33
doc/source/netscript/basicfunctions/run.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
run() Netscript Function
|
||||
========================
|
||||
|
||||
.. js:function:: run(script, [numThreads=1], [args...])
|
||||
|
||||
:param string script: Filename of script to run
|
||||
:param number numThreads: Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer
|
||||
:param args...:
|
||||
Additional arguments to pass into the new script that is being run. Note that if any arguments are being
|
||||
passed into the new script, then the second argument *numThreads* must be filled in with a value.
|
||||
:RAM cost: 1 GB
|
||||
|
||||
Run a script as a separate process. This function can only be used to run scripts located on the current server (the server
|
||||
running the script that calls this function).
|
||||
|
||||
Returns true if the script is successfully started, and false otherwise.
|
||||
|
||||
Running this function with a *numThreads* argument of 0 will return false without running the script.
|
||||
However, running this function with a negative *numThreads* argument will cause a runtime error.
|
||||
|
||||
The simplest way to use the *run* command is to call it with just the script name. The following example will run
|
||||
'foo.script' single-threaded with no arguments::
|
||||
|
||||
run("foo.script");
|
||||
|
||||
The following example will run 'foo.script' but with 5 threads instead of single-threaded::
|
||||
|
||||
run("foo.script", 5);
|
||||
|
||||
This next example will run 'foo.script' single-threaded, and will pass the string 'foodnstuff' into the script
|
||||
as an argument::
|
||||
|
||||
run("foo.script", 1, 'foodnstuff');
|
||||
Reference in New Issue
Block a user