work on doc

This commit is contained in:
Olivier Gagnon
2021-10-30 12:34:14 -04:00
parent f99c3fd0cd
commit 43fc5dfd48
589 changed files with 63720 additions and 1168 deletions
+40
View File
@@ -0,0 +1,40 @@
<!-- 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
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: Script, numThreads?: number, ...args: string[]): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| script | [Script](./bitburner.script.md) | 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
2 GB
## Example
```js
//The following example will execute the script foo.script with 10 threads and the arguments foodnstuff and 90:
spawn('foo.script', 10, 'foodnstuff', 90);
```