bitburner-src/markdown/bitburner.ns.spawn.md
Olivier Gagnon 23342f6dcc regen doc
2022-08-23 11:33:29 -04:00

55 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [spawn](./bitburner.ns.spawn.md)
## NS.spawn() method
Terminate current script and start another in 10s.
<b>Signature:</b>
```typescript
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. |
<b>Returns:</b>
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
```ts
// 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
```ts
// 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);
```