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

Doc update

Browse Source 
* Added notes about whether ns API layers contain spoilers.
* Add some more info to checkFactionInvitation doc
This commit is contained in:
omuretsu 2023-03-08 01:39:05 -05:00
parent d7380a9243
commit 057aeaea83
13 changed files with 62 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4,7 +4,7 @@
## NS.bladeburner property ## NS.bladeburner property
Namespace for bladeburner functions. Namespace for bladeburner functions. Contains spoilers.
**Signature:** **Signature:**

7
markdown/bitburner.ns.corporation.md
View File

@ -4,10 +4,15 @@
## NS.corporation property ## NS.corporation property
Namespace for corporation functions. RAM cost: 1022.4 GB Namespace for corporation functions. Contains spoilers.
**Signature:** **Signature:**
```typescript ```typescript
readonly corporation: Corporation; readonly corporation: Corporation;
``` ```
## Remarks
RAM cost: 0 GB

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

@ -4,7 +4,7 @@
## NS.gang property ## NS.gang property
Namespace for gang functions. Namespace for gang functions. Contains spoilers.
**Signature:** **Signature:**

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

@ -4,7 +4,7 @@
## NS.grafting property ## NS.grafting property
Namespace for grafting functions. Namespace for grafting functions. Contains spoilers.
**Signature:** **Signature:**

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

@ -4,7 +4,7 @@
## NS.hacknet property ## NS.hacknet property
Namespace for hacknet functions. Namespace for hacknet functions. Some of this API contains spoilers.
**Signature:** **Signature:**

7
markdown/bitburner.ns.infiltration.md
View File

@ -4,10 +4,15 @@
## NS.infiltration property ## NS.infiltration property
Namespace for infiltration functions. RAM cost: 0 GB Namespace for infiltration functions.
**Signature:** **Signature:**
```typescript ```typescript
readonly infiltration: Infiltration; readonly infiltration: Infiltration;
``` ```
## Remarks
RAM cost: 0 GB

20
markdown/bitburner.ns.md
View File

@ -41,21 +41,21 @@ export async function main(ns) {
| Property | Modifiers | Type | Description | | Property | Modifiers | Type | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [args](./bitburner.ns.args.md) | <code>readonly</code> | (string \| number \| boolean)\[\] | Arguments passed into the script. | | [args](./bitburner.ns.args.md) | <code>readonly</code> | (string \| number \| boolean)\[\] | Arguments passed into the script. |
| [bladeburner](./bitburner.ns.bladeburner.md) | <code>readonly</code> | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. | | [bladeburner](./bitburner.ns.bladeburner.md) | <code>readonly</code> | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. Contains spoilers. |
| [codingcontract](./bitburner.ns.codingcontract.md) | <code>readonly</code> | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. | | [codingcontract](./bitburner.ns.codingcontract.md) | <code>readonly</code> | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. |
| [corporation](./bitburner.ns.corporation.md) | <code>readonly</code> | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 1022.4 GB | | [corporation](./bitburner.ns.corporation.md) | <code>readonly</code> | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. Contains spoilers. |
| [enums](./bitburner.ns.enums.md) | | [NSEnums](./bitburner.nsenums.md) | | | [enums](./bitburner.ns.enums.md) | | [NSEnums](./bitburner.nsenums.md) | |
| [formulas](./bitburner.ns.formulas.md) | <code>readonly</code> | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | | [formulas](./bitburner.ns.formulas.md) | <code>readonly</code> | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. |
| [gang](./bitburner.ns.gang.md) | <code>readonly</code> | [Gang](./bitburner.gang.md) | Namespace for gang functions. | | [gang](./bitburner.ns.gang.md) | <code>readonly</code> | [Gang](./bitburner.gang.md) | Namespace for gang functions. Contains spoilers. |
| [grafting](./bitburner.ns.grafting.md) | <code>readonly</code> | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. | | [grafting](./bitburner.ns.grafting.md) | <code>readonly</code> | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. Contains spoilers. |
| [hacknet](./bitburner.ns.hacknet.md) | <code>readonly</code> | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | | [hacknet](./bitburner.ns.hacknet.md) | <code>readonly</code> | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. Some of this API contains spoilers. |
| [infiltration](./bitburner.ns.infiltration.md) | <code>readonly</code> | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB | | [infiltration](./bitburner.ns.infiltration.md) | <code>readonly</code> | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. |
| [pid](./bitburner.ns.pid.md) | <code>readonly</code> | number | The current script's PID | | [pid](./bitburner.ns.pid.md) | <code>readonly</code> | number | The current script's PID |
| [singularity](./bitburner.ns.singularity.md) | <code>readonly</code> | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB | | [singularity](./bitburner.ns.singularity.md) | <code>readonly</code> | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. Contains spoilers. |
| [sleeve](./bitburner.ns.sleeve.md) | <code>readonly</code> | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | | [sleeve](./bitburner.ns.sleeve.md) | <code>readonly</code> | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. Contains spoilers. |
| [stanek](./bitburner.ns.stanek.md) | <code>readonly</code> | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | | [stanek](./bitburner.ns.stanek.md) | <code>readonly</code> | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. Contains spoilers. |
| [stock](./bitburner.ns.stock.md) | <code>readonly</code> | [TIX](./bitburner.tix.md) | Namespace for stock functions. | | [stock](./bitburner.ns.stock.md) | <code>readonly</code> | [TIX](./bitburner.tix.md) | Namespace for stock functions. |
| [ui](./bitburner.ns.ui.md) | <code>readonly</code> | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB | | [ui](./bitburner.ns.ui.md) | <code>readonly</code> | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. |
## Methods ## Methods

7
markdown/bitburner.ns.singularity.md
View File

@ -4,10 +4,15 @@
## NS.singularity property ## NS.singularity property
Namespace for singularity functions. RAM cost: 0 GB Namespace for singularity functions. Contains spoilers.
**Signature:** **Signature:**
```typescript ```typescript
readonly singularity: Singularity; readonly singularity: Singularity;
``` ```
## Remarks
RAM cost: 0 GB

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

@ -4,7 +4,7 @@
## NS.sleeve property ## NS.sleeve property
Namespace for sleeve functions. Namespace for sleeve functions. Contains spoilers.
**Signature:** **Signature:**

7
markdown/bitburner.ns.stanek.md
View File

@ -4,10 +4,15 @@
## NS.stanek property ## NS.stanek property
Namespace for stanek functions. RAM cost: 0 GB Namespace for stanek functions. Contains spoilers.
**Signature:** **Signature:**
```typescript ```typescript
readonly stanek: Stanek; readonly stanek: Stanek;
``` ```
## Remarks
RAM cost: 0 GB

7
markdown/bitburner.ns.ui.md
View File

@ -4,10 +4,15 @@
## NS.ui property ## NS.ui property
Namespace for user interface functions. RAM cost: 0 GB Namespace for user interface functions.
**Signature:** **Signature:**
```typescript ```typescript
readonly ui: UserInterface; readonly ui: UserInterface;
``` ```
## Remarks
RAM cost: 0 GB

2
markdown/bitburner.singularity.checkfactioninvitations.md
View File

@ -21,5 +21,5 @@ Array with the name of all Factions you currently have outstanding invitations f
RAM cost: 3 GB \* 16/4/1 RAM cost: 3 GB \* 16/4/1
Returns an array with the name of all Factions you currently have outstanding invitations from. Performs an immediate check for which factions you qualify for invites from, then returns an array with the name of all Factions you have outstanding invitations from.

31
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -1787,7 +1787,8 @@ export interface Singularity {
* RAM cost: 3 GB * 16/4/1 * RAM cost: 3 GB * 16/4/1
* *
* *
* Returns an array with the name of all Factions you currently have outstanding invitations from. * Performs an immediate check for which factions you qualify for invites from, then returns an array with the name
* of all Factions you have outstanding invitations from.
* *
* @returns Array with the name of all Factions you currently have outstanding invitations from. * @returns Array with the name of all Factions you currently have outstanding invitations from.
*/ */
@ -4499,13 +4500,13 @@ interface UserInterface {
*/ */
export interface NS { export interface NS {
/** /**
* Namespace for hacknet functions. * Namespace for hacknet functions. Some of this API contains spoilers.
* @remarks RAM cost: 4 GB * @remarks RAM cost: 4 GB.
*/ */
readonly hacknet: Hacknet; readonly hacknet: Hacknet;
/** /**
* Namespace for bladeburner functions. * Namespace for bladeburner functions. Contains spoilers.
* @remarks RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly bladeburner: Bladeburner; readonly bladeburner: Bladeburner;
@ -4517,13 +4518,13 @@ export interface NS {
readonly codingcontract: CodingContract; readonly codingcontract: CodingContract;
/** /**
* Namespace for gang functions. * Namespace for gang functions. Contains spoilers.
* @remarks RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly gang: Gang; readonly gang: Gang;
/** /**
* Namespace for sleeve functions. * Namespace for sleeve functions. Contains spoilers.
* @remarks RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly sleeve: Sleeve; readonly sleeve: Sleeve;
@ -4541,37 +4542,37 @@ export interface NS {
readonly formulas: Formulas; readonly formulas: Formulas;
/** /**
* Namespace for stanek functions. * Namespace for stanek functions. Contains spoilers.
* RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly stanek: Stanek; readonly stanek: Stanek;
/** /**
* Namespace for infiltration functions. * Namespace for infiltration functions.
* RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly infiltration: Infiltration; readonly infiltration: Infiltration;
/** /**
* Namespace for corporation functions. * Namespace for corporation functions. Contains spoilers.
* RAM cost: 1022.4 GB * @remarks RAM cost: 0 GB
*/ */
readonly corporation: Corporation; readonly corporation: Corporation;
/** /**
* Namespace for user interface functions. * Namespace for user interface functions.
* RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly ui: UserInterface; readonly ui: UserInterface;
/** /**
* Namespace for singularity functions. * Namespace for singularity functions. Contains spoilers.
* RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly singularity: Singularity; readonly singularity: Singularity;
/** /**
* Namespace for grafting functions. * Namespace for grafting functions. Contains spoilers.
* @remarks RAM cost: 0 GB * @remarks RAM cost: 0 GB
*/ */
readonly grafting: Grafting; readonly grafting: Grafting;