mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-22 07:33:48 +01:00
v1.1.0
This commit is contained in:
parent
ceb008c9fe
commit
3c27893aa3
187
dist/bitburner.d.ts
vendored
187
dist/bitburner.d.ts
vendored
@ -1,3 +1,15 @@
|
|||||||
|
/**
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
export declare interface ActiveFragment {
|
||||||
|
id: number;
|
||||||
|
avgCharge: number;
|
||||||
|
numCharge: number;
|
||||||
|
rotation: number;
|
||||||
|
x: number;
|
||||||
|
y: number;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Data representing the internal values of an Augmentation.
|
* Data representing the internal values of an Augmentation.
|
||||||
* @public
|
* @public
|
||||||
@ -890,6 +902,17 @@ export declare interface Formulas {
|
|||||||
hacknetServers: HacknetServersFormulas;
|
hacknetServers: HacknetServersFormulas;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
export declare interface Fragment {
|
||||||
|
id: number;
|
||||||
|
shape: boolean[][];
|
||||||
|
type: number;
|
||||||
|
power: number;
|
||||||
|
limit: number;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gang API
|
* Gang API
|
||||||
* @remarks
|
* @remarks
|
||||||
@ -1769,6 +1792,11 @@ export declare interface NS extends Singularity {
|
|||||||
* RAM cost: 0 GB
|
* RAM cost: 0 GB
|
||||||
*/
|
*/
|
||||||
readonly formulas: Formulas;
|
readonly formulas: Formulas;
|
||||||
|
/**
|
||||||
|
* Namespace for stanek functions.
|
||||||
|
* RAM cost: 0 GB
|
||||||
|
*/
|
||||||
|
readonly stanek: Stanek;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Arguments passed into the script.
|
* Arguments passed into the script.
|
||||||
@ -3572,6 +3600,45 @@ export declare interface Server {
|
|||||||
|
|
||||||
/** Flag indicating whether the SSH Port is open */
|
/** Flag indicating whether the SSH Port is open */
|
||||||
sshPortOpen: boolean;
|
sshPortOpen: boolean;
|
||||||
|
|
||||||
|
/** Flag indicating whether this is a purchased server */
|
||||||
|
purchasedByPlayer: boolean;
|
||||||
|
|
||||||
|
/** Flag indicating whether this server has a backdoor installed by a player */
|
||||||
|
backdoorInstalled: boolean;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initial server security level
|
||||||
|
* (i.e. security level when the server was created)
|
||||||
|
*/
|
||||||
|
baseDifficulty: number;
|
||||||
|
|
||||||
|
/** Server Security Level */
|
||||||
|
hackDifficulty: number;
|
||||||
|
|
||||||
|
/** Minimum server security level that this server can be weakened to */
|
||||||
|
minDifficulty: number;
|
||||||
|
|
||||||
|
/** How much money currently resides on the server and can be hacked */
|
||||||
|
moneyAvailable: number;
|
||||||
|
|
||||||
|
/** Maximum amount of money that this server can hold */
|
||||||
|
moneyMax: number;
|
||||||
|
|
||||||
|
/** Number of open ports required in order to gain admin/root access */
|
||||||
|
numOpenPortsRequired: number;
|
||||||
|
|
||||||
|
/** How many ports are currently opened on the server */
|
||||||
|
openPortCount: number;
|
||||||
|
|
||||||
|
/** Hacking level required to hack this server */
|
||||||
|
requiredHackingSkill: number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parameter that affects how effectively this server's money can
|
||||||
|
* be increased using the grow() Netscript function
|
||||||
|
*/
|
||||||
|
serverGrowth: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -4282,24 +4349,6 @@ export declare interface Singularity {
|
|||||||
* @returns True if the installation was successful.
|
* @returns True if the installation was successful.
|
||||||
*/
|
*/
|
||||||
installBackdoor(): Promise<void>;
|
installBackdoor(): Promise<void>;
|
||||||
|
|
||||||
/**
|
|
||||||
* SF4.2 - Check if the player is focused.
|
|
||||||
* @remarks
|
|
||||||
* RAM cost: 0.1 GB
|
|
||||||
*
|
|
||||||
*
|
|
||||||
* @returns True if the player is focused.
|
|
||||||
*/
|
|
||||||
isFocused(): void;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* SF4.2 - Set the players focus.
|
|
||||||
* @remarks
|
|
||||||
* RAM cost: 0.1 GB
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
setFocus(focus: boolean): void;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -4610,6 +4659,108 @@ export declare interface SourceFileLvl {
|
|||||||
lvl: number;
|
lvl: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stanek's Gift API.
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
export declare interface Stanek {
|
||||||
|
/**
|
||||||
|
* Stanek's Gift width.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: 0.4 GB
|
||||||
|
* @returns The width of the gift.
|
||||||
|
*/
|
||||||
|
width(): number;
|
||||||
|
/**
|
||||||
|
* Stanek's Gift height.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: 0.4 GB
|
||||||
|
* @returns The height of the gift.
|
||||||
|
*/
|
||||||
|
height(): number;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Charge a fragment, increasing it's power.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: 0.4 GB
|
||||||
|
* @param rootX - rootX Root X against which to align the top left of the fragment.
|
||||||
|
* @param rootY - rootY Root Y against which to align the top left of the fragment.
|
||||||
|
* @returns Promise that lasts until the charge action is over.
|
||||||
|
*/
|
||||||
|
charge(rootX: number, rootY: number): Promise<void>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List possible fragments.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 0 GB
|
||||||
|
*
|
||||||
|
* @returns List of possible fragments.
|
||||||
|
*/
|
||||||
|
fragmentDefinitions(): Fragment[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List of fragments in Stanek's Gift.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 5 GB
|
||||||
|
*
|
||||||
|
* @returns List of active fragments placed on Stanek's Gift.
|
||||||
|
*/
|
||||||
|
activeFragments(): ActiveFragment[];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear the board of all fragments.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 0 GB
|
||||||
|
*/
|
||||||
|
clear(): void;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if fragment can be placed at specified location.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 0.5 GB
|
||||||
|
*
|
||||||
|
* @param rootX - rootX Root X against which to align the top left of the fragment.
|
||||||
|
* @param rootY - rootY Root Y against which to align the top left of the fragment.
|
||||||
|
* @param rotation - rotation A number from 0 to 3, the mount of 90 degree turn to take.
|
||||||
|
* @param fragmentId - fragmentId ID of the fragment to place.
|
||||||
|
* @returns true if the fragment can be placed at that position. false otherwise.
|
||||||
|
*/
|
||||||
|
canPlace(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
|
||||||
|
/**
|
||||||
|
* Place fragment on Stanek's Gift.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 5 GB
|
||||||
|
*
|
||||||
|
* @param rootX - X against which to align the top left of the fragment.
|
||||||
|
* @param rootY - Y against which to align the top left of the fragment.
|
||||||
|
* @param rotation - A number from 0 to 3, the mount of 90 degree turn to take.
|
||||||
|
* @param fragmentId - ID of the fragment to place.
|
||||||
|
* @returns true if the fragment can be placed at that position. false otherwise.
|
||||||
|
*/
|
||||||
|
place(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
|
||||||
|
/**
|
||||||
|
* Get placed fragment at location.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 5 GB
|
||||||
|
*
|
||||||
|
* @param rootX - X against which to align the top left of the fragment.
|
||||||
|
* @param rootY - Y against which to align the top left of the fragment.
|
||||||
|
* @returns The fragment at [rootX, rootY], if any.
|
||||||
|
*/
|
||||||
|
get(rootX: number, rootY: number): ActiveFragment | undefined;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove fragment at location.
|
||||||
|
* @remarks
|
||||||
|
* RAM cost: cost: 0.15 GB
|
||||||
|
*
|
||||||
|
* @param rootX - X against which to align the top left of the fragment.
|
||||||
|
* @param rootY - Y against which to align the top left of the fragment.
|
||||||
|
* @returns The fragment at [rootX, rootY], if any.
|
||||||
|
*/
|
||||||
|
remove(rootX: number, rootY: number): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return value of {@link TIX.getOrders | getOrders}
|
* Return value of {@link TIX.getOrders | getOrders}
|
||||||
* @public
|
* @public
|
||||||
|
@ -62,7 +62,7 @@ v1.1.0 - 2021-12-03 BN13: They're Lunatics (hydroflame & community)
|
|||||||
* Remove warning that the theme editor is slow, it's only slow in dev mode.
|
* Remove warning that the theme editor is slow, it's only slow in dev mode.
|
||||||
* In BN8 is it possible to reduce the money on a server without gaining any.
|
* In BN8 is it possible to reduce the money on a server without gaining any.
|
||||||
* In the options, the timestamp feature has a placeholder explaining the expected format.
|
* In the options, the timestamp feature has a placeholder explaining the expected format.
|
||||||
* Bunch of doc typo fix. (hydroflame & @BartKoppelmans)
|
* Bunch of doc typo fix. (hydroflame & @BartKoppelmans & @cvr-119)
|
||||||
* nerf noodle bar
|
* nerf noodle bar
|
||||||
|
|
||||||
v1.0.2 - 2021-11-17 It's the little things (hydroflame)
|
v1.0.2 - 2021-11-17 It's the little things (hydroflame)
|
||||||
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
11
markdown/bitburner.activefragment.avgcharge.md
Normal file
11
markdown/bitburner.activefragment.avgcharge.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [avgCharge](./bitburner.activefragment.avgcharge.md)
|
||||||
|
|
||||||
|
## ActiveFragment.avgCharge property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
avgCharge: number;
|
||||||
|
```
|
11
markdown/bitburner.activefragment.id.md
Normal file
11
markdown/bitburner.activefragment.id.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [id](./bitburner.activefragment.id.md)
|
||||||
|
|
||||||
|
## ActiveFragment.id property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
id: number;
|
||||||
|
```
|
24
markdown/bitburner.activefragment.md
Normal file
24
markdown/bitburner.activefragment.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md)
|
||||||
|
|
||||||
|
## ActiveFragment interface
|
||||||
|
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
export interface ActiveFragment
|
||||||
|
```
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| [avgCharge](./bitburner.activefragment.avgcharge.md) | number | |
|
||||||
|
| [id](./bitburner.activefragment.id.md) | number | |
|
||||||
|
| [numCharge](./bitburner.activefragment.numcharge.md) | number | |
|
||||||
|
| [rotation](./bitburner.activefragment.rotation.md) | number | |
|
||||||
|
| [x](./bitburner.activefragment.x.md) | number | |
|
||||||
|
| [y](./bitburner.activefragment.y.md) | number | |
|
||||||
|
|
11
markdown/bitburner.activefragment.numcharge.md
Normal file
11
markdown/bitburner.activefragment.numcharge.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [numCharge](./bitburner.activefragment.numcharge.md)
|
||||||
|
|
||||||
|
## ActiveFragment.numCharge property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
numCharge: number;
|
||||||
|
```
|
11
markdown/bitburner.activefragment.rotation.md
Normal file
11
markdown/bitburner.activefragment.rotation.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [rotation](./bitburner.activefragment.rotation.md)
|
||||||
|
|
||||||
|
## ActiveFragment.rotation property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
rotation: number;
|
||||||
|
```
|
11
markdown/bitburner.activefragment.x.md
Normal file
11
markdown/bitburner.activefragment.x.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [x](./bitburner.activefragment.x.md)
|
||||||
|
|
||||||
|
## ActiveFragment.x property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
x: number;
|
||||||
|
```
|
11
markdown/bitburner.activefragment.y.md
Normal file
11
markdown/bitburner.activefragment.y.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [y](./bitburner.activefragment.y.md)
|
||||||
|
|
||||||
|
## ActiveFragment.y property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
y: number;
|
||||||
|
```
|
11
markdown/bitburner.fragment.id.md
Normal file
11
markdown/bitburner.fragment.id.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [id](./bitburner.fragment.id.md)
|
||||||
|
|
||||||
|
## Fragment.id property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
id: number;
|
||||||
|
```
|
11
markdown/bitburner.fragment.limit.md
Normal file
11
markdown/bitburner.fragment.limit.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [limit](./bitburner.fragment.limit.md)
|
||||||
|
|
||||||
|
## Fragment.limit property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
limit: number;
|
||||||
|
```
|
23
markdown/bitburner.fragment.md
Normal file
23
markdown/bitburner.fragment.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md)
|
||||||
|
|
||||||
|
## Fragment interface
|
||||||
|
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
export interface Fragment
|
||||||
|
```
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| [id](./bitburner.fragment.id.md) | number | |
|
||||||
|
| [limit](./bitburner.fragment.limit.md) | number | |
|
||||||
|
| [power](./bitburner.fragment.power.md) | number | |
|
||||||
|
| [shape](./bitburner.fragment.shape.md) | boolean\[\]\[\] | |
|
||||||
|
| [type](./bitburner.fragment.type.md) | number | |
|
||||||
|
|
11
markdown/bitburner.fragment.power.md
Normal file
11
markdown/bitburner.fragment.power.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [power](./bitburner.fragment.power.md)
|
||||||
|
|
||||||
|
## Fragment.power property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
power: number;
|
||||||
|
```
|
11
markdown/bitburner.fragment.shape.md
Normal file
11
markdown/bitburner.fragment.shape.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [shape](./bitburner.fragment.shape.md)
|
||||||
|
|
||||||
|
## Fragment.shape property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
shape: boolean[][];
|
||||||
|
```
|
11
markdown/bitburner.fragment.type.md
Normal file
11
markdown/bitburner.fragment.type.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [type](./bitburner.fragment.type.md)
|
||||||
|
|
||||||
|
## Fragment.type property
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
type: number;
|
||||||
|
```
|
@ -8,6 +8,7 @@
|
|||||||
|
|
||||||
| Interface | Description |
|
| Interface | Description |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
|
| [ActiveFragment](./bitburner.activefragment.md) | |
|
||||||
| [AugmentationStats](./bitburner.augmentationstats.md) | Data representing the internal values of an Augmentation. |
|
| [AugmentationStats](./bitburner.augmentationstats.md) | Data representing the internal values of an Augmentation. |
|
||||||
| [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) |
|
| [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) |
|
||||||
| [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow](./bitburner.ns.grow.md)<!-- -->, and [weaken](./bitburner.ns.weaken.md)<!-- -->. |
|
| [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow](./bitburner.ns.grow.md)<!-- -->, and [weaken](./bitburner.ns.weaken.md)<!-- -->. |
|
||||||
@ -21,6 +22,7 @@
|
|||||||
| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
|
| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
|
||||||
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
|
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
|
||||||
| [Formulas](./bitburner.formulas.md) | |
|
| [Formulas](./bitburner.formulas.md) | |
|
||||||
|
| [Fragment](./bitburner.fragment.md) | |
|
||||||
| [Gang](./bitburner.gang.md) | Gang API |
|
| [Gang](./bitburner.gang.md) | Gang API |
|
||||||
| [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. |
|
| [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. |
|
||||||
| [GangMemberAscension](./bitburner.gangmemberascension.md) | |
|
| [GangMemberAscension](./bitburner.gangmemberascension.md) | |
|
||||||
@ -50,6 +52,7 @@
|
|||||||
| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
|
| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
|
||||||
| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | |
|
| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | |
|
||||||
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
|
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
|
||||||
|
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
|
||||||
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) |
|
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) |
|
||||||
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
|
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
|
||||||
| [TIX](./bitburner.tix.md) | Stock market API |
|
| [TIX](./bitburner.tix.md) | Stock market API |
|
||||||
|
@ -24,6 +24,7 @@ export interface NS extends Singularity
|
|||||||
| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. |
|
| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. |
|
||||||
| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. |
|
| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. |
|
||||||
| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. |
|
| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. |
|
||||||
|
| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB |
|
||||||
| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | Namespace for stock functions. |
|
| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | Namespace for stock functions. |
|
||||||
|
|
||||||
## Methods
|
## Methods
|
||||||
|
13
markdown/bitburner.ns.stanek.md
Normal file
13
markdown/bitburner.ns.stanek.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [stanek](./bitburner.ns.stanek.md)
|
||||||
|
|
||||||
|
## NS.stanek property
|
||||||
|
|
||||||
|
Namespace for stanek functions. RAM cost: 0 GB
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
readonly stanek: Stanek;
|
||||||
|
```
|
13
markdown/bitburner.server.backdoorinstalled.md
Normal file
13
markdown/bitburner.server.backdoorinstalled.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [backdoorInstalled](./bitburner.server.backdoorinstalled.md)
|
||||||
|
|
||||||
|
## Server.backdoorInstalled property
|
||||||
|
|
||||||
|
Flag indicating whether this server has a backdoor installed by a player
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
backdoorInstalled: boolean;
|
||||||
|
```
|
13
markdown/bitburner.server.basedifficulty.md
Normal file
13
markdown/bitburner.server.basedifficulty.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [baseDifficulty](./bitburner.server.basedifficulty.md)
|
||||||
|
|
||||||
|
## Server.baseDifficulty property
|
||||||
|
|
||||||
|
Initial server security level (i.e. security level when the server was created)
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
baseDifficulty: number;
|
||||||
|
```
|
13
markdown/bitburner.server.hackdifficulty.md
Normal file
13
markdown/bitburner.server.hackdifficulty.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [hackDifficulty](./bitburner.server.hackdifficulty.md)
|
||||||
|
|
||||||
|
## Server.hackDifficulty property
|
||||||
|
|
||||||
|
Server Security Level
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
hackDifficulty: number;
|
||||||
|
```
|
@ -16,16 +16,27 @@ export interface Server
|
|||||||
|
|
||||||
| Property | Type | Description |
|
| Property | Type | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
| [backdoorInstalled](./bitburner.server.backdoorinstalled.md) | boolean | Flag indicating whether this server has a backdoor installed by a player |
|
||||||
|
| [baseDifficulty](./bitburner.server.basedifficulty.md) | number | Initial server security level (i.e. security level when the server was created) |
|
||||||
| [cpuCores](./bitburner.server.cpucores.md) | number | How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. |
|
| [cpuCores](./bitburner.server.cpucores.md) | number | How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. |
|
||||||
| [ftpPortOpen](./bitburner.server.ftpportopen.md) | boolean | Flag indicating whether the FTP port is open |
|
| [ftpPortOpen](./bitburner.server.ftpportopen.md) | boolean | Flag indicating whether the FTP port is open |
|
||||||
|
| [hackDifficulty](./bitburner.server.hackdifficulty.md) | number | Server Security Level |
|
||||||
| [hasAdminRights](./bitburner.server.hasadminrights.md) | boolean | Flag indicating whether player has admin/root access to this server |
|
| [hasAdminRights](./bitburner.server.hasadminrights.md) | boolean | Flag indicating whether player has admin/root access to this server |
|
||||||
| [hostname](./bitburner.server.hostname.md) | string | Hostname. Must be unique |
|
| [hostname](./bitburner.server.hostname.md) | string | Hostname. Must be unique |
|
||||||
| [httpPortOpen](./bitburner.server.httpportopen.md) | boolean | Flag indicating whether HTTP Port is open |
|
| [httpPortOpen](./bitburner.server.httpportopen.md) | boolean | Flag indicating whether HTTP Port is open |
|
||||||
| [ip](./bitburner.server.ip.md) | string | IP Address. Must be unique |
|
| [ip](./bitburner.server.ip.md) | string | IP Address. Must be unique |
|
||||||
| [isConnectedTo](./bitburner.server.isconnectedto.md) | boolean | Flag indicating whether player is curently connected to this server |
|
| [isConnectedTo](./bitburner.server.isconnectedto.md) | boolean | Flag indicating whether player is curently connected to this server |
|
||||||
| [maxRam](./bitburner.server.maxram.md) | number | RAM (GB) available on this server |
|
| [maxRam](./bitburner.server.maxram.md) | number | RAM (GB) available on this server |
|
||||||
|
| [minDifficulty](./bitburner.server.mindifficulty.md) | number | Minimum server security level that this server can be weakened to |
|
||||||
|
| [moneyAvailable](./bitburner.server.moneyavailable.md) | number | How much money currently resides on the server and can be hacked |
|
||||||
|
| [moneyMax](./bitburner.server.moneymax.md) | number | Maximum amount of money that this server can hold |
|
||||||
|
| [numOpenPortsRequired](./bitburner.server.numopenportsrequired.md) | number | Number of open ports required in order to gain admin/root access |
|
||||||
|
| [openPortCount](./bitburner.server.openportcount.md) | number | How many ports are currently opened on the server |
|
||||||
| [organizationName](./bitburner.server.organizationname.md) | string | Name of company/faction/etc. that this server belongs to. Optional, not applicable to all Servers |
|
| [organizationName](./bitburner.server.organizationname.md) | string | Name of company/faction/etc. that this server belongs to. Optional, not applicable to all Servers |
|
||||||
|
| [purchasedByPlayer](./bitburner.server.purchasedbyplayer.md) | boolean | Flag indicating whether this is a purchased server |
|
||||||
| [ramUsed](./bitburner.server.ramused.md) | number | RAM (GB) used. i.e. unavailable RAM |
|
| [ramUsed](./bitburner.server.ramused.md) | number | RAM (GB) used. i.e. unavailable RAM |
|
||||||
|
| [requiredHackingSkill](./bitburner.server.requiredhackingskill.md) | number | Hacking level required to hack this server |
|
||||||
|
| [serverGrowth](./bitburner.server.servergrowth.md) | number | Parameter that affects how effectively this server's money can be increased using the grow() Netscript function |
|
||||||
| [smtpPortOpen](./bitburner.server.smtpportopen.md) | boolean | Flag indicating whether SMTP Port is open |
|
| [smtpPortOpen](./bitburner.server.smtpportopen.md) | boolean | Flag indicating whether SMTP Port is open |
|
||||||
| [sqlPortOpen](./bitburner.server.sqlportopen.md) | boolean | Flag indicating whether SQL Port is open |
|
| [sqlPortOpen](./bitburner.server.sqlportopen.md) | boolean | Flag indicating whether SQL Port is open |
|
||||||
| [sshPortOpen](./bitburner.server.sshportopen.md) | boolean | Flag indicating whether the SSH Port is open |
|
| [sshPortOpen](./bitburner.server.sshportopen.md) | boolean | Flag indicating whether the SSH Port is open |
|
||||||
|
13
markdown/bitburner.server.mindifficulty.md
Normal file
13
markdown/bitburner.server.mindifficulty.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [minDifficulty](./bitburner.server.mindifficulty.md)
|
||||||
|
|
||||||
|
## Server.minDifficulty property
|
||||||
|
|
||||||
|
Minimum server security level that this server can be weakened to
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
minDifficulty: number;
|
||||||
|
```
|
13
markdown/bitburner.server.moneyavailable.md
Normal file
13
markdown/bitburner.server.moneyavailable.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [moneyAvailable](./bitburner.server.moneyavailable.md)
|
||||||
|
|
||||||
|
## Server.moneyAvailable property
|
||||||
|
|
||||||
|
How much money currently resides on the server and can be hacked
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
moneyAvailable: number;
|
||||||
|
```
|
13
markdown/bitburner.server.moneymax.md
Normal file
13
markdown/bitburner.server.moneymax.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [moneyMax](./bitburner.server.moneymax.md)
|
||||||
|
|
||||||
|
## Server.moneyMax property
|
||||||
|
|
||||||
|
Maximum amount of money that this server can hold
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
moneyMax: number;
|
||||||
|
```
|
13
markdown/bitburner.server.numopenportsrequired.md
Normal file
13
markdown/bitburner.server.numopenportsrequired.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [numOpenPortsRequired](./bitburner.server.numopenportsrequired.md)
|
||||||
|
|
||||||
|
## Server.numOpenPortsRequired property
|
||||||
|
|
||||||
|
Number of open ports required in order to gain admin/root access
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
numOpenPortsRequired: number;
|
||||||
|
```
|
13
markdown/bitburner.server.openportcount.md
Normal file
13
markdown/bitburner.server.openportcount.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [openPortCount](./bitburner.server.openportcount.md)
|
||||||
|
|
||||||
|
## Server.openPortCount property
|
||||||
|
|
||||||
|
How many ports are currently opened on the server
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
openPortCount: number;
|
||||||
|
```
|
13
markdown/bitburner.server.purchasedbyplayer.md
Normal file
13
markdown/bitburner.server.purchasedbyplayer.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [purchasedByPlayer](./bitburner.server.purchasedbyplayer.md)
|
||||||
|
|
||||||
|
## Server.purchasedByPlayer property
|
||||||
|
|
||||||
|
Flag indicating whether this is a purchased server
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
purchasedByPlayer: boolean;
|
||||||
|
```
|
13
markdown/bitburner.server.requiredhackingskill.md
Normal file
13
markdown/bitburner.server.requiredhackingskill.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [requiredHackingSkill](./bitburner.server.requiredhackingskill.md)
|
||||||
|
|
||||||
|
## Server.requiredHackingSkill property
|
||||||
|
|
||||||
|
Hacking level required to hack this server
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
requiredHackingSkill: number;
|
||||||
|
```
|
13
markdown/bitburner.server.servergrowth.md
Normal file
13
markdown/bitburner.server.servergrowth.md
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [serverGrowth](./bitburner.server.servergrowth.md)
|
||||||
|
|
||||||
|
## Server.serverGrowth property
|
||||||
|
|
||||||
|
Parameter that affects how effectively this server's money can be increased using the grow() Netscript function
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
serverGrowth: number;
|
||||||
|
```
|
@ -1,23 +0,0 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [isFocused](./bitburner.singularity.isfocused.md)
|
|
||||||
|
|
||||||
## Singularity.isFocused() method
|
|
||||||
|
|
||||||
SF4.2 - Check if the player is focused.
|
|
||||||
|
|
||||||
<b>Signature:</b>
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
isFocused(): void;
|
|
||||||
```
|
|
||||||
<b>Returns:</b>
|
|
||||||
|
|
||||||
void
|
|
||||||
|
|
||||||
True if the player is focused.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
RAM cost: 0.1 GB
|
|
||||||
|
|
@ -52,13 +52,11 @@ This API requires Source-File 4 level 1 / 2 / 3 to use.
|
|||||||
| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | SF4.3 - Install your purchased augmentations. |
|
| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | SF4.3 - Install your purchased augmentations. |
|
||||||
| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | SF4.1 - Run the backdoor command in the terminal. |
|
| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | SF4.1 - Run the backdoor command in the terminal. |
|
||||||
| [isBusy()](./bitburner.singularity.isbusy.md) | SF4.1 - Check if the player is busy. |
|
| [isBusy()](./bitburner.singularity.isbusy.md) | SF4.1 - Check if the player is busy. |
|
||||||
| [isFocused()](./bitburner.singularity.isfocused.md) | SF4.2 - Check if the player is focused. |
|
|
||||||
| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | SF4.2 - Join a faction. |
|
| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | SF4.2 - Join a faction. |
|
||||||
| [manualHack()](./bitburner.singularity.manualhack.md) | SF4.1 - Run the hack command in the terminal. |
|
| [manualHack()](./bitburner.singularity.manualhack.md) | SF4.1 - Run the hack command in the terminal. |
|
||||||
| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | SF4.3 - Purchase an augmentation |
|
| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | SF4.3 - Purchase an augmentation |
|
||||||
| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | SF4.1 - Purchase a program from the dark web. |
|
| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | SF4.1 - Purchase a program from the dark web. |
|
||||||
| [purchaseTor()](./bitburner.singularity.purchasetor.md) | SF4.1 - Purchase the TOR router. |
|
| [purchaseTor()](./bitburner.singularity.purchasetor.md) | SF4.1 - Purchase the TOR router. |
|
||||||
| [setFocus(focus)](./bitburner.singularity.setfocus.md) | SF4.2 - Set the players focus. |
|
|
||||||
| [softReset(cbScript)](./bitburner.singularity.softreset.md) | SF4.3 - Soft reset the game. |
|
| [softReset(cbScript)](./bitburner.singularity.softreset.md) | SF4.3 - Soft reset the game. |
|
||||||
| [stopAction()](./bitburner.singularity.stopaction.md) | SF4.1 - Stop the current action. |
|
| [stopAction()](./bitburner.singularity.stopaction.md) | SF4.1 - Stop the current action. |
|
||||||
| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | SF4.1 - Travel to another city. |
|
| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | SF4.1 - Travel to another city. |
|
||||||
|
@ -1,28 +0,0 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [setFocus](./bitburner.singularity.setfocus.md)
|
|
||||||
|
|
||||||
## Singularity.setFocus() method
|
|
||||||
|
|
||||||
SF4.2 - Set the players focus.
|
|
||||||
|
|
||||||
<b>Signature:</b>
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
setFocus(focus: boolean): void;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Parameters
|
|
||||||
|
|
||||||
| Parameter | Type | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| focus | boolean | |
|
|
||||||
|
|
||||||
<b>Returns:</b>
|
|
||||||
|
|
||||||
void
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
|
|
||||||
RAM cost: 0.1 GB
|
|
||||||
|
|
23
markdown/bitburner.stanek.activefragments.md
Normal file
23
markdown/bitburner.stanek.activefragments.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [activeFragments](./bitburner.stanek.activefragments.md)
|
||||||
|
|
||||||
|
## Stanek.activeFragments() method
|
||||||
|
|
||||||
|
List of fragments in Stanek's Gift.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
activeFragments(): ActiveFragment[];
|
||||||
|
```
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
[ActiveFragment](./bitburner.activefragment.md)<!-- -->\[\]
|
||||||
|
|
||||||
|
List of active fragments placed on Stanek's Gift.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 5 GB
|
||||||
|
|
33
markdown/bitburner.stanek.canplace.md
Normal file
33
markdown/bitburner.stanek.canplace.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [canPlace](./bitburner.stanek.canplace.md)
|
||||||
|
|
||||||
|
## Stanek.canPlace() method
|
||||||
|
|
||||||
|
Check if fragment can be placed at specified location.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
canPlace(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| rootX | number | rootX Root X against which to align the top left of the fragment. |
|
||||||
|
| rootY | number | rootY Root Y against which to align the top left of the fragment. |
|
||||||
|
| rotation | number | rotation A number from 0 to 3, the mount of 90 degree turn to take. |
|
||||||
|
| fragmentId | number | fragmentId ID of the fragment to place. |
|
||||||
|
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
boolean
|
||||||
|
|
||||||
|
true if the fragment can be placed at that position. false otherwise.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 0.5 GB
|
||||||
|
|
31
markdown/bitburner.stanek.charge.md
Normal file
31
markdown/bitburner.stanek.charge.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [charge](./bitburner.stanek.charge.md)
|
||||||
|
|
||||||
|
## Stanek.charge() method
|
||||||
|
|
||||||
|
Charge a fragment, increasing it's power.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
charge(rootX: number, rootY: number): Promise<void>;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| rootX | number | rootX Root X against which to align the top left of the fragment. |
|
||||||
|
| rootY | number | rootY Root Y against which to align the top left of the fragment. |
|
||||||
|
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
Promise<void>
|
||||||
|
|
||||||
|
Promise that lasts until the charge action is over.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: 0.4 GB
|
||||||
|
|
21
markdown/bitburner.stanek.clear.md
Normal file
21
markdown/bitburner.stanek.clear.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [clear](./bitburner.stanek.clear.md)
|
||||||
|
|
||||||
|
## Stanek.clear() method
|
||||||
|
|
||||||
|
Clear the board of all fragments.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
clear(): void;
|
||||||
|
```
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
void
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 0 GB
|
||||||
|
|
23
markdown/bitburner.stanek.fragmentdefinitions.md
Normal file
23
markdown/bitburner.stanek.fragmentdefinitions.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [fragmentDefinitions](./bitburner.stanek.fragmentdefinitions.md)
|
||||||
|
|
||||||
|
## Stanek.fragmentDefinitions() method
|
||||||
|
|
||||||
|
List possible fragments.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
fragmentDefinitions(): Fragment[];
|
||||||
|
```
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
[Fragment](./bitburner.fragment.md)<!-- -->\[\]
|
||||||
|
|
||||||
|
List of possible fragments.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 0 GB
|
||||||
|
|
31
markdown/bitburner.stanek.get.md
Normal file
31
markdown/bitburner.stanek.get.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [get](./bitburner.stanek.get.md)
|
||||||
|
|
||||||
|
## Stanek.get() method
|
||||||
|
|
||||||
|
Get placed fragment at location.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
get(rootX: number, rootY: number): ActiveFragment | undefined;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| rootX | number | X against which to align the top left of the fragment. |
|
||||||
|
| rootY | number | Y against which to align the top left of the fragment. |
|
||||||
|
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
[ActiveFragment](./bitburner.activefragment.md) \| undefined
|
||||||
|
|
||||||
|
The fragment at \[rootX, rootY\], if any.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 5 GB
|
||||||
|
|
23
markdown/bitburner.stanek.height.md
Normal file
23
markdown/bitburner.stanek.height.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [height](./bitburner.stanek.height.md)
|
||||||
|
|
||||||
|
## Stanek.height() method
|
||||||
|
|
||||||
|
Stanek's Gift height.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
height(): number;
|
||||||
|
```
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
number
|
||||||
|
|
||||||
|
The height of the gift.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: 0.4 GB
|
||||||
|
|
29
markdown/bitburner.stanek.md
Normal file
29
markdown/bitburner.stanek.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md)
|
||||||
|
|
||||||
|
## Stanek interface
|
||||||
|
|
||||||
|
Stanek's Gift API.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface Stanek
|
||||||
|
```
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [activeFragments()](./bitburner.stanek.activefragments.md) | List of fragments in Stanek's Gift. |
|
||||||
|
| [canPlace(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplace.md) | Check if fragment can be placed at specified location. |
|
||||||
|
| [charge(rootX, rootY)](./bitburner.stanek.charge.md) | Charge a fragment, increasing it's power. |
|
||||||
|
| [clear()](./bitburner.stanek.clear.md) | Clear the board of all fragments. |
|
||||||
|
| [fragmentDefinitions()](./bitburner.stanek.fragmentdefinitions.md) | List possible fragments. |
|
||||||
|
| [get(rootX, rootY)](./bitburner.stanek.get.md) | Get placed fragment at location. |
|
||||||
|
| [height()](./bitburner.stanek.height.md) | Stanek's Gift height. |
|
||||||
|
| [place(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.place.md) | Place fragment on Stanek's Gift. |
|
||||||
|
| [remove(rootX, rootY)](./bitburner.stanek.remove.md) | Remove fragment at location. |
|
||||||
|
| [width()](./bitburner.stanek.width.md) | Stanek's Gift width. |
|
||||||
|
|
33
markdown/bitburner.stanek.place.md
Normal file
33
markdown/bitburner.stanek.place.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [place](./bitburner.stanek.place.md)
|
||||||
|
|
||||||
|
## Stanek.place() method
|
||||||
|
|
||||||
|
Place fragment on Stanek's Gift.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
place(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| rootX | number | X against which to align the top left of the fragment. |
|
||||||
|
| rootY | number | Y against which to align the top left of the fragment. |
|
||||||
|
| rotation | number | A number from 0 to 3, the mount of 90 degree turn to take. |
|
||||||
|
| fragmentId | number | ID of the fragment to place. |
|
||||||
|
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
boolean
|
||||||
|
|
||||||
|
true if the fragment can be placed at that position. false otherwise.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 5 GB
|
||||||
|
|
31
markdown/bitburner.stanek.remove.md
Normal file
31
markdown/bitburner.stanek.remove.md
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [remove](./bitburner.stanek.remove.md)
|
||||||
|
|
||||||
|
## Stanek.remove() method
|
||||||
|
|
||||||
|
Remove fragment at location.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
remove(rootX: number, rootY: number): boolean;
|
||||||
|
```
|
||||||
|
|
||||||
|
## Parameters
|
||||||
|
|
||||||
|
| Parameter | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| rootX | number | X against which to align the top left of the fragment. |
|
||||||
|
| rootY | number | Y against which to align the top left of the fragment. |
|
||||||
|
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
boolean
|
||||||
|
|
||||||
|
The fragment at \[rootX, rootY\], if any.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: cost: 0.15 GB
|
||||||
|
|
23
markdown/bitburner.stanek.width.md
Normal file
23
markdown/bitburner.stanek.width.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [width](./bitburner.stanek.width.md)
|
||||||
|
|
||||||
|
## Stanek.width() method
|
||||||
|
|
||||||
|
Stanek's Gift width.
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
width(): number;
|
||||||
|
```
|
||||||
|
<b>Returns:</b>
|
||||||
|
|
||||||
|
number
|
||||||
|
|
||||||
|
The width of the gift.
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
RAM cost: 0.4 GB
|
||||||
|
|
@ -332,7 +332,7 @@ export const CONSTANTS: {
|
|||||||
* Remove warning that the theme editor is slow, it's only slow in dev mode.
|
* Remove warning that the theme editor is slow, it's only slow in dev mode.
|
||||||
* In BN8 is it possible to reduce the money on a server without gaining any.
|
* In BN8 is it possible to reduce the money on a server without gaining any.
|
||||||
* In the options, the timestamp feature has a placeholder explaining the expected format.
|
* In the options, the timestamp feature has a placeholder explaining the expected format.
|
||||||
* Bunch of doc typo fix. (hydroflame & @BartKoppelmans)
|
* Bunch of doc typo fix. (hydroflame & @BartKoppelmans & @cvr-119)
|
||||||
* nerf noodle bar
|
* nerf noodle bar
|
||||||
`,
|
`,
|
||||||
};
|
};
|
||||||
|
8
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
8
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@ -3346,6 +3346,9 @@ export interface Formulas {
|
|||||||
hacknetServers: HacknetServersFormulas;
|
hacknetServers: HacknetServersFormulas;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
export interface Fragment {
|
export interface Fragment {
|
||||||
id: number;
|
id: number;
|
||||||
shape: boolean[][];
|
shape: boolean[][];
|
||||||
@ -3354,6 +3357,9 @@ export interface Fragment {
|
|||||||
limit: number;
|
limit: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
export interface ActiveFragment {
|
export interface ActiveFragment {
|
||||||
id: number;
|
id: number;
|
||||||
avgCharge: number;
|
avgCharge: number;
|
||||||
@ -3516,7 +3522,7 @@ export interface NS extends Singularity {
|
|||||||
readonly formulas: Formulas;
|
readonly formulas: Formulas;
|
||||||
/**
|
/**
|
||||||
* Namespace for stanek functions.
|
* Namespace for stanek functions.
|
||||||
* @ramCost 0 GB
|
* RAM cost: 0 GB
|
||||||
*/
|
*/
|
||||||
readonly stanek: Stanek;
|
readonly stanek: Stanek;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user