work to make documentation unified.

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

View File

@@ -1,20 +1,24 @@
spawn() Netscript Function
==========================
.. js:function:: spawn(script, numThreads, [args...])
.. 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 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.
:RAM cost: 2 GB
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.
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.
Because this function immediately terminates the script, it does not have a return value.
The following example will execute the script 'foo.script' with 10 threads and the arguments 'foodnstuff' and 90::
Example:
spawn('foo.script', 10, 'foodnstuff', 90);
.. code-block:: javascript
spawn('foo.script', 10, 'foodnstuff', 90); // "run foo.script 10 foodnstuff 90" in 10 seconds.