felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-17 14:59:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

API: Added spawnDelay parameter to ns.spawn options, allowing user defined delay (#807)

Browse Source
This commit is contained in:
muesli4brekkies
2023-09-27 06:31:47 +01:00
committed by GitHub
parent 7fad6e0778
commit c5e2f65cb0
10 changed files with 78 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
markdown/bitburner.ns.spawn.md
View File

@@ -4,12 +4,12 @@
## NS.spawn() method
Terminate current script and start another in 10 seconds.
Terminate current script and start another in a defined number of milliseconds.
**Signature:**
```typescript
spawn(script: string, threadOrOptions?: number | RunOptions, ...args: (string | number | boolean)[]): void;
spawn(script: string, threadOrOptions?: number | SpawnOptions, ...args: (string | number | boolean)[]): void;
```
## Parameters
@@ -17,7 +17,7 @@ spawn(script: string, threadOrOptions?: number | RunOptions, ...args: (string |
| Parameter | Type | Description |
| --- | --- | --- |
| script | string | Filename of script to execute. |
| 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. |
| threadOrOptions | number \| [SpawnOptions](./bitburner.spawnoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [SpawnOptions](./bitburner.spawnoptions.md) object. Threads defaults to 1. |
| args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. |
**Returns:**
@@ -28,7 +28,7 @@ void
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.
Terminates the current script, and then after a defined delay 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.
@@ -38,7 +38,7 @@ Running this function with 0 or fewer threads will cause a runtime error.
```js
//The following example will execute the script ‘foo.js’ with 10 threads and the arguments ‘foodnstuff’ and 90:
ns.spawn('foo.js', 10, 'foodnstuff', 90);
//The following example will execute the script ‘foo.js’ with 10 threads, in 500 milliseconds and the arguments ‘foodnstuff’ and 90:
ns.spawn('foo.js', 10, 500, 'foodnstuff', 90);
```