Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-18 12:15:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

regen doc

Browse Source
This commit is contained in:
Olivier Gagnon 2022-08-23 11:33:29 -04:00
parent 1d1890497f
commit 23342f6dcc
5 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
dist/bitburner.d.ts vendored
View File

@ -3433,8 +3433,7 @@ export declare interface NS {
* PID stands for Process ID. The PID is a unique identifier for each script. * PID stands for Process ID. The PID is a unique identifier for each script.
* The PID will always be a positive integer. * The PID will always be a positive integer.
* *
* Running this function with a numThreads argument of 0 will return 0 without running the script. * Running this function with a numThreads argument of 0 or less will cause a runtime error.
* However, running this function with a negative numThreads argument will cause a runtime error.
* *
* @example * @example
* ```ts * ```ts
@ -3481,7 +3480,7 @@ export declare interface NS {
* PID stands for Process ID. The PID is a unique identifier for each script. * PID stands for Process ID. The PID is a unique identifier for each script.
* The PID will always be a positive integer. * The PID will always be a positive integer.
* *
* Running this function with 0 or a negative numThreads argument will cause a runtime error. * Running this function with a numThreads argument of 0 or less will cause a runtime error.
* *
* @example * @example
* ```ts * ```ts
@ -3527,6 +3526,8 @@ export declare interface NS {
* *
* Because this function immediately terminates the script, it does not have a return value. * 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 * @example
* ```ts * ```ts
* // NS1: * // NS1:
@ -6757,7 +6758,6 @@ export declare interface TIX {
/** /**
* Short stocks. * Short stocks.
* @remarks * @remarks
* @deprecated use sellShort
* RAM cost: 2.5 GB * RAM cost: 2.5 GB
* Attempts to purchase a short position of a stock using a Market Order. * Attempts to purchase a short position of a stock using a Market Order.
* *

2
markdown/bitburner.ns.exec.md
View File

@ -37,7 +37,7 @@ If the script was successfully started, then this functions returns the PID of t
PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. 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 a negative numThreads argument will cause a runtime error. Running this function with a numThreads argument of 0 or less will cause a runtime error.
## Example 1 ## Example 1

2
markdown/bitburner.ns.run.md
View File

@ -36,7 +36,7 @@ If the script was successfully started, then this functions returns the PID of t
PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. 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 a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. Running this function with a numThreads argument of 0 or less will cause a runtime error.
## Example 1 ## Example 1

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

@ -32,6 +32,8 @@ Terminates the current script, and then after a delay of about 10 seconds it wil
Because this function immediately terminates the script, it does not have a return value. 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 ## Example 1

3
markdown/bitburner.singularity.md
View File

@ -9,7 +9,7 @@ Singularity API
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
export interface Singularity export interface Singularity
``` ```
## Remarks ## Remarks
@ -17,6 +17,7 @@ export interface Singularity
This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels. This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels.
## Methods ## Methods
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | | [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. |