bitburner-src/doc/source/netscript/basicfunctions/spawn.rst
MageKing17 ae15914efa Update netscript documentation.
Unfortunately, I haven't used most of the specialty APIs yet, so I'm not intimately familiar with where their documentation might be wrong. I figured some fixes were better than no fixes, and I can always make more fixes later.

Fixes #1023.
2021-07-06 00:18:22 -07:00

27 lines
1004 B
ReStructuredText

spawn() Netscript Function
==========================
.. js:function:: spawn(script, numThreads[, args...])
:RAM cost: 2 GB
:param string script: Filename of script to execute
:param number numThreads: Number of threads to spawn new script with. Will
be rounded to nearest integer.
:param args...:
Additional arguments to pass into the new script that is being run.
Terminates the current script, and then after a delay of about 10 seconds it
will execute the newly-specified script. The purpose of this function is to
execute a new script without being constrained by the RAM usage of the
current one. This function can only be used to run scripts on the local
server.
.. warning:: Running this function with a ``numThreads`` argument of 0 or
less will cause a runtime error.
Example:
.. code-block:: javascript
spawn('foo.script', 10, 'foodnstuff', 90); // "run foo.script 10 foodnstuff 90" in 10 seconds.