mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-08 16:53:54 +01:00
doc
This commit is contained in:
parent
d2ec38753b
commit
69cf98ff34
17
dist/bitburner.d.ts
vendored
17
dist/bitburner.d.ts
vendored
@ -856,13 +856,13 @@ export declare interface Corporation extends WarehouseAPI, OfficeAPI {
|
|||||||
* Create a Corporation
|
* Create a Corporation
|
||||||
* @param divisionName - Name of the division
|
* @param divisionName - Name of the division
|
||||||
* @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3
|
* @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3
|
||||||
* @returns true if created and false if not
|
* @returns true if created and false if not
|
||||||
*/
|
*/
|
||||||
createCorporation(corporationName: string, selfFund: boolean): boolean;
|
createCorporation(corporationName: string, selfFund: boolean): boolean;
|
||||||
/**
|
/**
|
||||||
* Check if you have a one time unlockable upgrade
|
* Check if you have a one time unlockable upgrade
|
||||||
* @param upgradeName - Name of the upgrade
|
* @param upgradeName - Name of the upgrade
|
||||||
* @returns true if unlocked and false if not
|
* @returns true if unlocked and false if not
|
||||||
*/
|
*/
|
||||||
hasUnlockUpgrade(upgradeName: string): boolean;
|
hasUnlockUpgrade(upgradeName: string): boolean;
|
||||||
/**
|
/**
|
||||||
@ -4434,14 +4434,17 @@ export declare interface NS extends Singularity {
|
|||||||
flags(schema: [string, string | number | boolean | string[]][]): any;
|
flags(schema: [string, string | number | boolean | string[]][]): any;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Share your computer with your factions. Increasing your rep gain for a short duration.
|
* Share your computer with your factions.
|
||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 2.4 GB
|
* RAM cost: 2.4 GB
|
||||||
|
*
|
||||||
|
* Increases your rep gain of hacking contracts while share is called.
|
||||||
|
* Scales with thread count.
|
||||||
*/
|
*/
|
||||||
share(): Promise<void>;
|
share(): Promise<void>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calculate your share power.
|
* Calculate your share power. Based on all the active share calls.
|
||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 0.2 GB
|
* RAM cost: 0.2 GB
|
||||||
*/
|
*/
|
||||||
@ -4751,10 +4754,10 @@ export declare interface Product {
|
|||||||
pCost: number;
|
pCost: number;
|
||||||
/** Sell cost, can be "MP+5" */
|
/** Sell cost, can be "MP+5" */
|
||||||
sCost: string | number;
|
sCost: string | number;
|
||||||
/** Data refers to the production, sale, and quantity of the products
|
/** Data refers to the production, sale, and quantity of the products
|
||||||
* These values are specific to a city
|
* These values are specific to a city
|
||||||
* For each city, the data is [qty, prod, sell] */
|
* For each city, the data is [qty, prod, sell] */
|
||||||
cityData: {[key: string]:number[]};
|
cityData: { [key: string]: number[] };
|
||||||
/** Creation progress - A number between 0-100 representing percentage */
|
/** Creation progress - A number between 0-100 representing percentage */
|
||||||
developmentProgress: number;
|
developmentProgress: number;
|
||||||
}
|
}
|
||||||
|
@ -18440,7 +18440,7 @@
|
|||||||
{
|
{
|
||||||
"kind": "MethodSignature",
|
"kind": "MethodSignature",
|
||||||
"canonicalReference": "bitburner!NS#getSharePower:member(1)",
|
"canonicalReference": "bitburner!NS#getSharePower:member(1)",
|
||||||
"docComment": "/**\n * Calculate your share power.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n */\n",
|
"docComment": "/**\n * Calculate your share power. Based on all the active share calls.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n */\n",
|
||||||
"excerptTokens": [
|
"excerptTokens": [
|
||||||
{
|
{
|
||||||
"kind": "Content",
|
"kind": "Content",
|
||||||
@ -20475,7 +20475,7 @@
|
|||||||
{
|
{
|
||||||
"kind": "MethodSignature",
|
"kind": "MethodSignature",
|
||||||
"canonicalReference": "bitburner!NS#share:member(1)",
|
"canonicalReference": "bitburner!NS#share:member(1)",
|
||||||
"docComment": "/**\n * Share your computer with your factions. Increasing your rep gain for a short duration.\n *\n * @remarks\n *\n * RAM cost: 2.4 GB\n */\n",
|
"docComment": "/**\n * Share your computer with your factions.\n *\n * @remarks\n *\n * RAM cost: 2.4 GB\n *\n * Increases your rep gain of hacking contracts while share is called. Scales with thread count.\n */\n",
|
||||||
"excerptTokens": [
|
"excerptTokens": [
|
||||||
{
|
{
|
||||||
"kind": "Content",
|
"kind": "Content",
|
||||||
@ -25657,7 +25657,7 @@
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"kind": "Content",
|
"kind": "Content",
|
||||||
"text": "{[key: string]:number[]}"
|
"text": "{ [key: string]: number[] }"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"kind": "Content",
|
"kind": "Content",
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## NS.getSharePower() method
|
## NS.getSharePower() method
|
||||||
|
|
||||||
Calculate your share power.
|
Calculate your share power. Based on all the active share calls.
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
@ -107,7 +107,7 @@ export async function main(ns) {
|
|||||||
| [getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) | Returns the required hacking level of the target server. |
|
| [getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) | Returns the required hacking level of the target server. |
|
||||||
| [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Get server security level. |
|
| [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Get server security level. |
|
||||||
| [getServerUsedRam(host)](./bitburner.ns.getserverusedram.md) | Get the used RAM on a server. |
|
| [getServerUsedRam(host)](./bitburner.ns.getserverusedram.md) | Get the used RAM on a server. |
|
||||||
| [getSharePower()](./bitburner.ns.getsharepower.md) | Calculate your share power. |
|
| [getSharePower()](./bitburner.ns.getsharepower.md) | Calculate your share power. Based on all the active share calls. |
|
||||||
| [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. |
|
| [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. |
|
||||||
| [getWeakenTime(host)](./bitburner.ns.getweakentime.md) | Get the execution time of a weaken() call. |
|
| [getWeakenTime(host)](./bitburner.ns.getweakentime.md) | Get the execution time of a weaken() call. |
|
||||||
| [grow(host, opts)](./bitburner.ns.grow.md) | Spoof money in a servers bank account, increasing the amount available. |
|
| [grow(host, opts)](./bitburner.ns.grow.md) | Spoof money in a servers bank account, increasing the amount available. |
|
||||||
@ -145,7 +145,7 @@ export async function main(ns) {
|
|||||||
| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. |
|
| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. |
|
||||||
| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. |
|
| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. |
|
||||||
| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. |
|
| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. |
|
||||||
| [share()](./bitburner.ns.share.md) | Share your computer with your factions. Increasing your rep gain for a short duration. |
|
| [share()](./bitburner.ns.share.md) | Share your computer with your factions. |
|
||||||
| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. |
|
| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. |
|
||||||
| [spawn(script, numThreads, args)](./bitburner.ns.spawn.md) | Terminate current script and start another in 10s. |
|
| [spawn(script, numThreads, args)](./bitburner.ns.spawn.md) | Terminate current script and start another in 10s. |
|
||||||
| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Format a string. |
|
| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Format a string. |
|
||||||
|
@ -4,7 +4,7 @@
|
|||||||
|
|
||||||
## NS.share() method
|
## NS.share() method
|
||||||
|
|
||||||
Share your computer with your factions. Increasing your rep gain for a short duration.
|
Share your computer with your factions.
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
@ -19,3 +19,5 @@ Promise<void>
|
|||||||
|
|
||||||
RAM cost: 2.4 GB
|
RAM cost: 2.4 GB
|
||||||
|
|
||||||
|
Increases your rep gain of hacking contracts while share is called. Scales with thread count.
|
||||||
|
|
||||||
|
@ -9,5 +9,5 @@ Data refers to the production, sale, and quantity of the products These values a
|
|||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
cityData: {[key: string]:number[]};
|
cityData: { [key: string]: number[] };
|
||||||
```
|
```
|
||||||
|
@ -16,7 +16,7 @@ interface Product
|
|||||||
|
|
||||||
| Property | Type | Description |
|
| Property | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [cityData](./bitburner.product.citydata.md) | {\[key: string\]:number\[\]} | Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] |
|
| [cityData](./bitburner.product.citydata.md) | { \[key: string\]: number\[\] } | Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] |
|
||||||
| [cmp](./bitburner.product.cmp.md) | number | Competition for the product |
|
| [cmp](./bitburner.product.cmp.md) | number | Competition for the product |
|
||||||
| [developmentProgress](./bitburner.product.developmentprogress.md) | number | Creation progress - A number between 0-100 representing percentage |
|
| [developmentProgress](./bitburner.product.developmentprogress.md) | number | Creation progress - A number between 0-100 representing percentage |
|
||||||
| [dmd](./bitburner.product.dmd.md) | number | Demand for the product |
|
| [dmd](./bitburner.product.dmd.md) | number | Demand for the product |
|
||||||
|
17
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
17
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@ -6076,14 +6076,17 @@ export interface NS extends Singularity {
|
|||||||
flags(schema: [string, string | number | boolean | string[]][]): any;
|
flags(schema: [string, string | number | boolean | string[]][]): any;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Share your computer with your factions. Increasing your rep gain for a short duration.
|
* Share your computer with your factions.
|
||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 2.4 GB
|
* RAM cost: 2.4 GB
|
||||||
|
*
|
||||||
|
* Increases your rep gain of hacking contracts while share is called.
|
||||||
|
* Scales with thread count.
|
||||||
*/
|
*/
|
||||||
share(): Promise<void>;
|
share(): Promise<void>;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Calculate your share power.
|
* Calculate your share power. Based on all the active share calls.
|
||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 0.2 GB
|
* RAM cost: 0.2 GB
|
||||||
*/
|
*/
|
||||||
@ -6398,13 +6401,13 @@ export interface Corporation extends WarehouseAPI, OfficeAPI {
|
|||||||
* Create a Corporation
|
* Create a Corporation
|
||||||
* @param divisionName - Name of the division
|
* @param divisionName - Name of the division
|
||||||
* @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3
|
* @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3
|
||||||
* @returns true if created and false if not
|
* @returns true if created and false if not
|
||||||
*/
|
*/
|
||||||
createCorporation(corporationName: string, selfFund: boolean): boolean;
|
createCorporation(corporationName: string, selfFund: boolean): boolean;
|
||||||
/**
|
/**
|
||||||
* Check if you have a one time unlockable upgrade
|
* Check if you have a one time unlockable upgrade
|
||||||
* @param upgradeName - Name of the upgrade
|
* @param upgradeName - Name of the upgrade
|
||||||
* @returns true if unlocked and false if not
|
* @returns true if unlocked and false if not
|
||||||
*/
|
*/
|
||||||
hasUnlockUpgrade(upgradeName: string): boolean;
|
hasUnlockUpgrade(upgradeName: string): boolean;
|
||||||
/**
|
/**
|
||||||
@ -6574,10 +6577,10 @@ interface Product {
|
|||||||
pCost: number;
|
pCost: number;
|
||||||
/** Sell cost, can be "MP+5" */
|
/** Sell cost, can be "MP+5" */
|
||||||
sCost: string | number;
|
sCost: string | number;
|
||||||
/** Data refers to the production, sale, and quantity of the products
|
/** Data refers to the production, sale, and quantity of the products
|
||||||
* These values are specific to a city
|
* These values are specific to a city
|
||||||
* For each city, the data is [qty, prod, sell] */
|
* For each city, the data is [qty, prod, sell] */
|
||||||
cityData: {[key: string]:number[]};
|
cityData: { [key: string]: number[] };
|
||||||
/** Creation progress - A number between 0-100 representing percentage */
|
/** Creation progress - A number between 0-100 representing percentage */
|
||||||
developmentProgress: number;
|
developmentProgress: number;
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user