mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-30 03:23:48 +01:00
57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [run](./bitburner.ns.run.md)
|
||
|
||
## NS.run() method
|
||
|
||
Start another script on the current server.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
run(script: string, threadOrOptions?: number | RunOptions, ...args: (string | number | boolean)[]): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
| Parameter | Type | Description |
|
||
| --- | --- | --- |
|
||
| script | string | Filename of script to run. |
|
||
| threadOrOptions | number \| [RunOptions](./bitburner.runoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. |
|
||
| args | (string \| number \| boolean)\[\] | 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
|
||
|
||
RAM cost: 1 GB
|
||
|
||
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.
|
||
|
||
The second argument is either a thread count, or a [RunOptions](./bitburner.runoptions.md) object that can also specify the number of threads (among other things).
|
||
|
||
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 0 or fewer threads will cause a runtime error.
|
||
|
||
## Example
|
||
|
||
|
||
```js
|
||
//The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.js’ single-threaded with no arguments:
|
||
ns.run("foo.js");
|
||
|
||
//The following example will run ‘foo.js’ but with 5 threads instead of single-threaded:
|
||
ns.run("foo.js", {threads: 5});
|
||
|
||
//This next example will run ‘foo.js’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument:
|
||
ns.run("foo.js", 1, 'foodnstuff');
|
||
```
|
||
|