bitburner-src/markdown/bitburner.ns.spawn.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

1.7 KiB
Raw Blame History

Home > bitburner > NS > spawn

NS.spawn() method

Terminate current script and start another in 10 seconds.

Signature:

spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void;

Parameters

Parameter Type Description
script string Filename of script to execute.
numThreads number Number of threads to spawn new script with. Will be rounded to nearest integer.
args (string | number | boolean)[] Additional arguments to pass into the new script that is being run.

Returns:

void

Remarks

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.

Because this function immediately terminates the script, it does not have a return value.

Running this function with a numThreads argument of 0 or less will cause a runtime error.

Example 1

// NS1:
//The following example will execute the script foo.script with 10 threads and the arguments foodnstuff and 90:
spawn('foo.script', 10, 'foodnstuff', 90);

Example 2

// NS2:
//The following example will execute the script foo.script with 10 threads and the arguments foodnstuff and 90:
ns.spawn('foo.script', 10, 'foodnstuff', 90);