bitburner-src/doc/source/netscript/basicfunctions/spawn.rst

27 lines
1002 B
ReStructuredText
Raw Normal View History

spawn() Netscript Function
==========================
2021-03-12 08:51:56 +01:00
.. js:function:: spawn(script, numThreads[, args...])
2021-03-12 08:51:56 +01:00
:RAM cost: 2 GB
:param string script: Filename of script to execute
2021-03-12 08:51:56 +01:00
: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.
2021-03-12 08:51:56 +01:00
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.
2021-03-12 08:51:56 +01:00
Example:
2021-03-12 08:51:56 +01:00
.. code-block:: javascript
2023-01-06 13:43:09 +01:00
ns.spawn('foo.js', 10, 'foodnstuff', 90); // "run foo.js foodnstuff 90 -t 10" in 10 seconds.