mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-14 03:33:52 +01:00
41 lines
1.3 KiB
Markdown
41 lines
1.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) > [spawn](./bitburner.ns.spawn.md)
|
||
|
||
## NS.spawn() method
|
||
|
||
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.
|
||
|
||
<b>Signature:</b>
|
||
|
||
```typescript
|
||
spawn(script: string, numThreads?: number, ...args: string[]): 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\[\] | Additional arguments to pass into the new script that is being run. |
|
||
|
||
<b>Returns:</b>
|
||
|
||
void
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 2 GB
|
||
|
||
## Example
|
||
|
||
|
||
```ts
|
||
//The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90:
|
||
spawn('foo.script', 10, 'foodnstuff', 90);
|
||
```
|
||
|