bitburner-src/markdown/bitburner.ns.run.md

Home > bitburner > NS > run

NS.run() method

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). Requires a significant amount of RAM to run this command.

If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0.

PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer.

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.

Signature:

run(script: Script, numThreads?: number, ...args: string[]): number;

Parameters

Parameter	Type	Description
script	Script	Filename of script to run.
numThreads	number	Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer.
args	string[]	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:

number

Returns the PID of a successfully started script, and 0 otherwise.

Remarks

1 GB

Example 1

//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:
run("foo.script");

Example 2

//The following example will run ‘foo.script’ but with 5 threads instead of single-threaded:
run("foo.script", 5);

Example 3

//This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument:
run("foo.script", 1, 'foodnstuff');