felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 07:18:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

work to make documentation unified.

Browse Source
This commit is contained in:
Olivier Gagnon
2021-03-12 02:51:56 -05:00
parent a00c253dcb
commit 2ce6ff2041
176 changed files with 1325 additions and 916 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/source/netscript/basicfunctions/run.rst
View File

@@ -1,38 +1,44 @@
run() Netscript Function
========================
.. js:function:: run(script, [numThreads=1], [args...])
.. 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
: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.
:returns: The process id of the new process or 0 on failure.
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).
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).
If the script was successfully started, then this functions returns the PID
of that script. Otherwise, it returns 0.
.. warning:: Running this function with a ``numThreads`` argument of 0 will
return 0 without running the script. However, running this function with
a negative ``numThreads`` argument will cause a runtime error.
.. note:: PID stands for Process ID. The PID is a unique identifier for each script.
The PID will always be a positive integer.
The simplest way to use the :doc:`run<run>` command is to call it with just
the script name. The following example will run ``foo.script``
single-threaded with no arguments:
.. warning:: Running this function with a *numThreads* argument of 0 will return 0 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::
.. code-block:: javascript
run("foo.script");
The following example will run 'foo.script' but with 5 threads instead of single-threaded::
The following example will run 'foo.script' but with 5 threads instead of
single-threaded:
.. code-block:: javascript
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::
This next example will run ``foo.script`` single-threaded, and will pass the
string ``foodnstuff`` into the script as an argument:
.. code-block:: javascript
run("foo.script", 1, 'foodnstuff');