mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-09-19 20:38:42 +02:00
Fix documentation for ns.sleeve (#227)
This commit is contained in:
parent
6616f7ba15
commit
e7fc0fbb03
67
dist/bitburner.d.ts
vendored
67
dist/bitburner.d.ts
vendored
@ -9,7 +9,7 @@ export declare interface ActiveFragment {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return value of {@link sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs}
|
* Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs}
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
export declare interface AugmentPair {
|
export declare interface AugmentPair {
|
||||||
@ -2662,18 +2662,14 @@ export declare interface Multipliers {
|
|||||||
bladeburner_success_chance: number;
|
bladeburner_success_chance: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/** Object representing a port. A port is a serialized queue.
|
||||||
* Object representing a port. A port is a serialized queue.
|
* @public */
|
||||||
* @public
|
|
||||||
*/
|
|
||||||
export declare interface NetscriptPort {
|
export declare interface NetscriptPort {
|
||||||
/**
|
/** Write data to a port.
|
||||||
* Write data to a port.
|
|
||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 0 GB
|
* RAM cost: 0 GB
|
||||||
*
|
*
|
||||||
* @returns The data popped off the queue if it was full.
|
* @returns The data popped off the queue if it was full. */
|
||||||
*/
|
|
||||||
write(value: string | number): PortData | null;
|
write(value: string | number): PortData | null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -2824,7 +2820,7 @@ export declare interface NS {
|
|||||||
* Namespace for sleeve functions.
|
* Namespace for sleeve functions.
|
||||||
* @remarks RAM cost: 0 GB
|
* @remarks RAM cost: 0 GB
|
||||||
*/
|
*/
|
||||||
readonly sleeve: sleeve;
|
readonly sleeve: Sleeve;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Namespace for stock functions.
|
* Namespace for stock functions.
|
||||||
@ -2880,11 +2876,36 @@ export declare interface NS {
|
|||||||
* @remarks
|
* @remarks
|
||||||
* RAM cost: 0 GB
|
* RAM cost: 0 GB
|
||||||
*
|
*
|
||||||
* Arguments passed into a script can be accessed using a normal
|
* Arguments passed into a script can be accessed as a normal array by using the `[]` operator
|
||||||
* array using the [] operator (args[0], args[1], etc…).
|
* (`args[0]`, `args[1]`, etc...).
|
||||||
|
* Arguments can be string, number, or boolean.
|
||||||
|
* Use `args.length` to get the number of arguments that were passed into a script.
|
||||||
*
|
*
|
||||||
* It is also possible to get the number of arguments that was passed into a script using: 'args.length'
|
* @example
|
||||||
* WARNING: Do not try to modify the args array. This will break the game.
|
* `run example.script 7 text true`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* // NS1 - example.script
|
||||||
|
* tprint(args.length) // 3
|
||||||
|
* tprint(args[0]); // 7 (number)
|
||||||
|
* tprint(args[1]); // "text" (string)
|
||||||
|
* tprint(args[2]); // true (boolean)
|
||||||
|
* tprint(args[3]); // undefined, because only 3 arguments were provided
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* `run example.js 7 text true`
|
||||||
|
*
|
||||||
|
* ```js
|
||||||
|
* // NS2 - example.js
|
||||||
|
* export async function main(ns) {
|
||||||
|
* ns.tprint(ns.args.length) // 3
|
||||||
|
* ns.tprint(ns.args[0]); // 7 (number)
|
||||||
|
* ns.tprint(ns.args[1]); // "text" (string)
|
||||||
|
* ns.tprint(ns.args[2]); // true (boolean)
|
||||||
|
* ns.tprint(ns.args[3]); // undefined, because only 3 arguments were provided
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
*/
|
*/
|
||||||
readonly args: (string | number | boolean)[];
|
readonly args: (string | number | boolean)[];
|
||||||
|
|
||||||
@ -6490,20 +6511,13 @@ export declare interface SkillsFormulas {
|
|||||||
calculateExp(skill: number, skillMult?: number): number;
|
calculateExp(skill: number, skillMult?: number): number;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @public */
|
|
||||||
export declare interface Sleeve extends Person {
|
|
||||||
shock: number;
|
|
||||||
sync: number;
|
|
||||||
memory: number;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sleeve API
|
* Sleeve API
|
||||||
* @remarks
|
* @remarks
|
||||||
* If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
* If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
export declare interface sleeve {
|
export declare interface Sleeve {
|
||||||
/**
|
/**
|
||||||
* Get the number of sleeves you own.
|
* Get the number of sleeves you own.
|
||||||
* @remarks
|
* @remarks
|
||||||
@ -6525,7 +6539,7 @@ export declare interface sleeve {
|
|||||||
* @param sleeveNumber - Index of the sleeve to retrieve information.
|
* @param sleeveNumber - Index of the sleeve to retrieve information.
|
||||||
* @returns Object containing information about this sleeve.
|
* @returns Object containing information about this sleeve.
|
||||||
*/
|
*/
|
||||||
getSleeve(sleeveNumber: number): Sleeve;
|
getSleeve(sleeveNumber: number): SleevePerson;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get task of a sleeve.
|
* Get task of a sleeve.
|
||||||
@ -6774,6 +6788,13 @@ export declare type SleeveFactionTask = {
|
|||||||
/** @public */
|
/** @public */
|
||||||
export declare type SleeveInfiltrateTask = { type: "INFILTRATE" };
|
export declare type SleeveInfiltrateTask = { type: "INFILTRATE" };
|
||||||
|
|
||||||
|
/** @public */
|
||||||
|
export declare interface SleevePerson extends Person {
|
||||||
|
shock: number;
|
||||||
|
sync: number;
|
||||||
|
memory: number;
|
||||||
|
}
|
||||||
|
|
||||||
/** @public */
|
/** @public */
|
||||||
export declare type SleeveRecoveryTask = { type: "RECOVERY" };
|
export declare type SleeveRecoveryTask = { type: "RECOVERY" };
|
||||||
|
|
||||||
|
@ -87,8 +87,8 @@
|
|||||||
| [Singularity](./bitburner.singularity.md) | Singularity API |
|
| [Singularity](./bitburner.singularity.md) | Singularity API |
|
||||||
| [Skills](./bitburner.skills.md) | |
|
| [Skills](./bitburner.skills.md) | |
|
||||||
| [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
|
| [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
|
||||||
| [sleeve](./bitburner.sleeve.md) | Sleeve API |
|
| [Sleeve](./bitburner.sleeve.md) | Sleeve API |
|
||||||
| [Sleeve](./bitburner.sleeve.md) | |
|
| [SleevePerson](./bitburner.sleeveperson.md) | |
|
||||||
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
|
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
|
||||||
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
|
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
|
||||||
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)<!-- -->Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) |
|
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)<!-- -->Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) |
|
||||||
|
@ -16,7 +16,33 @@ readonly args: (string | number | boolean)[];
|
|||||||
|
|
||||||
RAM cost: 0 GB
|
RAM cost: 0 GB
|
||||||
|
|
||||||
Arguments passed into a script can be accessed using a normal array using the \[\] operator (args\[0\], args\[1\], etc…).
|
Arguments passed into a script can be accessed as a normal array by using the `[]` operator (`args[0]`<!-- -->, `args[1]`<!-- -->, etc...). Arguments can be string, number, or boolean. Use `args.length` to get the number of arguments that were passed into a script.
|
||||||
|
|
||||||
It is also possible to get the number of arguments that was passed into a script using: 'args.length' WARNING: Do not try to modify the args array. This will break the game.
|
## Example 1
|
||||||
|
|
||||||
|
`run example.script 7 text true`
|
||||||
|
|
||||||
|
```js
|
||||||
|
// NS1 - example.script
|
||||||
|
tprint(args.length) // 3
|
||||||
|
tprint(args[0]); // 7 (number)
|
||||||
|
tprint(args[1]); // "text" (string)
|
||||||
|
tprint(args[2]); // true (boolean)
|
||||||
|
tprint(args[3]); // undefined, because only 3 arguments were provided
|
||||||
|
```
|
||||||
|
|
||||||
|
## Example 2
|
||||||
|
|
||||||
|
`run example.js 7 text true`
|
||||||
|
|
||||||
|
```js
|
||||||
|
// NS2 - example.js
|
||||||
|
export async function main(ns) {
|
||||||
|
ns.tprint(ns.args.length) // 3
|
||||||
|
ns.tprint(ns.args[0]); // 7 (number)
|
||||||
|
ns.tprint(ns.args[1]); // "text" (string)
|
||||||
|
ns.tprint(ns.args[2]); // true (boolean)
|
||||||
|
ns.tprint(ns.args[3]); // undefined, because only 3 arguments were provided
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
@ -51,7 +51,7 @@ export async function main(ns) {
|
|||||||
| [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. |
|
||||||
| [infiltration](./bitburner.ns.infiltration.md) | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB |
|
| [infiltration](./bitburner.ns.infiltration.md) | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB |
|
||||||
| [singularity](./bitburner.ns.singularity.md) | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB |
|
| [singularity](./bitburner.ns.singularity.md) | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB |
|
||||||
| [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 |
|
| [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. |
|
||||||
| [ui](./bitburner.ns.ui.md) | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB |
|
| [ui](./bitburner.ns.ui.md) | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB |
|
||||||
|
@ -9,7 +9,7 @@ Namespace for sleeve functions.
|
|||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
readonly sleeve: sleeve;
|
readonly sleeve: Sleeve;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Remarks
|
## Remarks
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getNumSleeves](./bitburner.sleeve.getnumsleeves.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getNumSleeves](./bitburner.sleeve.getnumsleeves.md)
|
||||||
|
|
||||||
## sleeve.getNumSleeves() method
|
## Sleeve.getNumSleeves() method
|
||||||
|
|
||||||
Get the number of sleeves you own.
|
Get the number of sleeves you own.
|
||||||
|
|
||||||
|
@ -1,15 +1,15 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getSleeve](./bitburner.sleeve.getsleeve.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeve](./bitburner.sleeve.getsleeve.md)
|
||||||
|
|
||||||
## sleeve.getSleeve() method
|
## Sleeve.getSleeve() method
|
||||||
|
|
||||||
Get information about a sleeve.
|
Get information about a sleeve.
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
getSleeve(sleeveNumber: number): Sleeve;
|
getSleeve(sleeveNumber: number): SleevePerson;
|
||||||
```
|
```
|
||||||
|
|
||||||
## Parameters
|
## Parameters
|
||||||
@ -20,7 +20,7 @@ getSleeve(sleeveNumber: number): Sleeve;
|
|||||||
|
|
||||||
<b>Returns:</b>
|
<b>Returns:</b>
|
||||||
|
|
||||||
[Sleeve](./bitburner.sleeve.md)
|
[SleevePerson](./bitburner.sleeveperson.md)
|
||||||
|
|
||||||
Object containing information about this sleeve.
|
Object containing information about this sleeve.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getSleeveAugmentationPrice](./bitburner.sleeve.getsleeveaugmentationprice.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentationPrice](./bitburner.sleeve.getsleeveaugmentationprice.md)
|
||||||
|
|
||||||
## sleeve.getSleeveAugmentationPrice() method
|
## Sleeve.getSleeveAugmentationPrice() method
|
||||||
|
|
||||||
Get price of an augmentation.
|
Get price of an augmentation.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getSleeveAugmentationRepReq](./bitburner.sleeve.getsleeveaugmentationrepreq.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentationRepReq](./bitburner.sleeve.getsleeveaugmentationrepreq.md)
|
||||||
|
|
||||||
## sleeve.getSleeveAugmentationRepReq() method
|
## Sleeve.getSleeveAugmentationRepReq() method
|
||||||
|
|
||||||
Get reputation requirement of an augmentation.
|
Get reputation requirement of an augmentation.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getSleeveAugmentations](./bitburner.sleeve.getsleeveaugmentations.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentations](./bitburner.sleeve.getsleeveaugmentations.md)
|
||||||
|
|
||||||
## sleeve.getSleeveAugmentations() method
|
## Sleeve.getSleeveAugmentations() method
|
||||||
|
|
||||||
Get augmentations installed on a sleeve.
|
Get augmentations installed on a sleeve.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md)
|
||||||
|
|
||||||
## sleeve.getSleevePurchasableAugs() method
|
## Sleeve.getSleevePurchasableAugs() method
|
||||||
|
|
||||||
List purchasable augs for a sleeve.
|
List purchasable augs for a sleeve.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [getTask](./bitburner.sleeve.gettask.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getTask](./bitburner.sleeve.gettask.md)
|
||||||
|
|
||||||
## sleeve.getTask() method
|
## Sleeve.getTask() method
|
||||||
|
|
||||||
Get task of a sleeve.
|
Get task of a sleeve.
|
||||||
|
|
||||||
|
@ -4,19 +4,37 @@
|
|||||||
|
|
||||||
## Sleeve interface
|
## Sleeve interface
|
||||||
|
|
||||||
|
Sleeve API
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
interface Sleeve extends Person
|
export interface Sleeve
|
||||||
```
|
```
|
||||||
<b>Extends:</b> [Person](./bitburner.person.md)
|
|
||||||
|
|
||||||
## Properties
|
## Remarks
|
||||||
|
|
||||||
| Property | Type | Description |
|
If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
||||||
| --- | --- | --- |
|
|
||||||
| [memory](./bitburner.sleeve.memory.md) | number | |
|
## Methods
|
||||||
| [shock](./bitburner.sleeve.shock.md) | number | |
|
|
||||||
| [sync](./bitburner.sleeve.sync.md) | number | |
|
| Method | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| [getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) | Get the number of sleeves you own. |
|
||||||
|
| [getSleeve(sleeveNumber)](./bitburner.sleeve.getsleeve.md) | Get information about a sleeve. |
|
||||||
|
| [getSleeveAugmentationPrice(augName)](./bitburner.sleeve.getsleeveaugmentationprice.md) | Get price of an augmentation. |
|
||||||
|
| [getSleeveAugmentationRepReq(augName)](./bitburner.sleeve.getsleeveaugmentationrepreq.md) | Get reputation requirement of an augmentation. |
|
||||||
|
| [getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md) | Get augmentations installed on a sleeve. |
|
||||||
|
| [getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) | List purchasable augs for a sleeve. |
|
||||||
|
| [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | Get task of a sleeve. |
|
||||||
|
| [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | Purchase an aug for a sleeve. |
|
||||||
|
| [setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md) | Set a sleeve to perform bladeburner actions. |
|
||||||
|
| [setToCommitCrime(sleeveNumber, crimeType)](./bitburner.sleeve.settocommitcrime.md) | Set a sleeve to commit crime. |
|
||||||
|
| [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | Set a sleeve to work for a company. |
|
||||||
|
| [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | Set a sleeve to work for a faction. |
|
||||||
|
| [setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md) | Set a sleeve to workout at the gym. |
|
||||||
|
| [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | Set a sleeve to shock recovery. |
|
||||||
|
| [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | Set a sleeve to synchronize. |
|
||||||
|
| [setToUniversityCourse(sleeveNumber, university, className)](./bitburner.sleeve.settouniversitycourse.md) | Set a sleeve to take a class at a university. |
|
||||||
|
| [travel(sleeveNumber, cityName)](./bitburner.sleeve.travel.md) | Make a sleeve travel to another city. |
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [purchaseSleeveAug](./bitburner.sleeve.purchasesleeveaug.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [purchaseSleeveAug](./bitburner.sleeve.purchasesleeveaug.md)
|
||||||
|
|
||||||
## sleeve.purchaseSleeveAug() method
|
## Sleeve.purchaseSleeveAug() method
|
||||||
|
|
||||||
Purchase an aug for a sleeve.
|
Purchase an aug for a sleeve.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToBladeburnerAction](./bitburner.sleeve.settobladeburneraction.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToBladeburnerAction](./bitburner.sleeve.settobladeburneraction.md)
|
||||||
|
|
||||||
## sleeve.setToBladeburnerAction() method
|
## Sleeve.setToBladeburnerAction() method
|
||||||
|
|
||||||
Set a sleeve to perform bladeburner actions.
|
Set a sleeve to perform bladeburner actions.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToCommitCrime](./bitburner.sleeve.settocommitcrime.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToCommitCrime](./bitburner.sleeve.settocommitcrime.md)
|
||||||
|
|
||||||
## sleeve.setToCommitCrime() method
|
## Sleeve.setToCommitCrime() method
|
||||||
|
|
||||||
Set a sleeve to commit crime.
|
Set a sleeve to commit crime.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToCompanyWork](./bitburner.sleeve.settocompanywork.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToCompanyWork](./bitburner.sleeve.settocompanywork.md)
|
||||||
|
|
||||||
## sleeve.setToCompanyWork() method
|
## Sleeve.setToCompanyWork() method
|
||||||
|
|
||||||
Set a sleeve to work for a company.
|
Set a sleeve to work for a company.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToFactionWork](./bitburner.sleeve.settofactionwork.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToFactionWork](./bitburner.sleeve.settofactionwork.md)
|
||||||
|
|
||||||
## sleeve.setToFactionWork() method
|
## Sleeve.setToFactionWork() method
|
||||||
|
|
||||||
Set a sleeve to work for a faction.
|
Set a sleeve to work for a faction.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToGymWorkout](./bitburner.sleeve.settogymworkout.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToGymWorkout](./bitburner.sleeve.settogymworkout.md)
|
||||||
|
|
||||||
## sleeve.setToGymWorkout() method
|
## Sleeve.setToGymWorkout() method
|
||||||
|
|
||||||
Set a sleeve to workout at the gym.
|
Set a sleeve to workout at the gym.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToShockRecovery](./bitburner.sleeve.settoshockrecovery.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToShockRecovery](./bitburner.sleeve.settoshockrecovery.md)
|
||||||
|
|
||||||
## sleeve.setToShockRecovery() method
|
## Sleeve.setToShockRecovery() method
|
||||||
|
|
||||||
Set a sleeve to shock recovery.
|
Set a sleeve to shock recovery.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToSynchronize](./bitburner.sleeve.settosynchronize.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToSynchronize](./bitburner.sleeve.settosynchronize.md)
|
||||||
|
|
||||||
## sleeve.setToSynchronize() method
|
## Sleeve.setToSynchronize() method
|
||||||
|
|
||||||
Set a sleeve to synchronize.
|
Set a sleeve to synchronize.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [setToUniversityCourse](./bitburner.sleeve.settouniversitycourse.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToUniversityCourse](./bitburner.sleeve.settouniversitycourse.md)
|
||||||
|
|
||||||
## sleeve.setToUniversityCourse() method
|
## Sleeve.setToUniversityCourse() method
|
||||||
|
|
||||||
Set a sleeve to take a class at a university.
|
Set a sleeve to take a class at a university.
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [sleeve](./bitburner.sleeve.md) > [travel](./bitburner.sleeve.travel.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [travel](./bitburner.sleeve.travel.md)
|
||||||
|
|
||||||
## sleeve.travel() method
|
## Sleeve.travel() method
|
||||||
|
|
||||||
Make a sleeve travel to another city.
|
Make a sleeve travel to another city.
|
||||||
|
|
||||||
|
22
markdown/bitburner.sleeveperson.md
Normal file
22
markdown/bitburner.sleeveperson.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
|
[Home](./index.md) > [bitburner](./bitburner.md) > [SleevePerson](./bitburner.sleeveperson.md)
|
||||||
|
|
||||||
|
## SleevePerson interface
|
||||||
|
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
interface SleevePerson extends Person
|
||||||
|
```
|
||||||
|
<b>Extends:</b> [Person](./bitburner.person.md)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Property | Type | Description |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| [memory](./bitburner.sleeveperson.memory.md) | number | |
|
||||||
|
| [shock](./bitburner.sleeveperson.shock.md) | number | |
|
||||||
|
| [sync](./bitburner.sleeveperson.sync.md) | number | |
|
||||||
|
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [memory](./bitburner.sleeve.memory.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [SleevePerson](./bitburner.sleeveperson.md) > [memory](./bitburner.sleeveperson.memory.md)
|
||||||
|
|
||||||
## Sleeve.memory property
|
## SleevePerson.memory property
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [shock](./bitburner.sleeve.shock.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [SleevePerson](./bitburner.sleeveperson.md) > [shock](./bitburner.sleeveperson.shock.md)
|
||||||
|
|
||||||
## Sleeve.shock property
|
## SleevePerson.shock property
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
@ -1,8 +1,8 @@
|
|||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||||
|
|
||||||
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [sync](./bitburner.sleeve.sync.md)
|
[Home](./index.md) > [bitburner](./bitburner.md) > [SleevePerson](./bitburner.sleeveperson.md) > [sync](./bitburner.sleeveperson.sync.md)
|
||||||
|
|
||||||
## Sleeve.sync property
|
## SleevePerson.sync property
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
@ -4,7 +4,7 @@ import { CityName } from "../Locations/data/CityNames";
|
|||||||
import { findCrime } from "../Crime/CrimeHelpers";
|
import { findCrime } from "../Crime/CrimeHelpers";
|
||||||
import { Augmentation } from "../Augmentation/Augmentation";
|
import { Augmentation } from "../Augmentation/Augmentation";
|
||||||
|
|
||||||
import { sleeve } from "../ScriptEditor/NetscriptDefinitions";
|
import { Sleeve } from "../ScriptEditor/NetscriptDefinitions";
|
||||||
import { checkEnum } from "../utils/helpers/enum";
|
import { checkEnum } from "../utils/helpers/enum";
|
||||||
import { InternalAPI, NetscriptContext } from "../Netscript/APIWrapper";
|
import { InternalAPI, NetscriptContext } from "../Netscript/APIWrapper";
|
||||||
import { isSleeveBladeburnerWork } from "../PersonObjects/Sleeve/Work/SleeveBladeburnerWork";
|
import { isSleeveBladeburnerWork } from "../PersonObjects/Sleeve/Work/SleeveBladeburnerWork";
|
||||||
@ -13,7 +13,7 @@ import { isSleeveCompanyWork } from "../PersonObjects/Sleeve/Work/SleeveCompanyW
|
|||||||
import { helpers } from "../Netscript/NetscriptHelpers";
|
import { helpers } from "../Netscript/NetscriptHelpers";
|
||||||
import { cloneDeep } from "lodash";
|
import { cloneDeep } from "lodash";
|
||||||
|
|
||||||
export function NetscriptSleeve(): InternalAPI<sleeve> {
|
export function NetscriptSleeve(): InternalAPI<Sleeve> {
|
||||||
const checkSleeveAPIAccess = function (ctx: NetscriptContext) {
|
const checkSleeveAPIAccess = function (ctx: NetscriptContext) {
|
||||||
if (Player.bitNodeN !== 10 && !Player.sourceFileLvl(10)) {
|
if (Player.bitNodeN !== 10 && !Player.sourceFileLvl(10)) {
|
||||||
throw helpers.makeRuntimeErrorMsg(
|
throw helpers.makeRuntimeErrorMsg(
|
||||||
|
@ -40,9 +40,9 @@ import { SleeveSupportWork } from "./Work/SleeveSupportWork";
|
|||||||
import { SleeveBladeburnerWork } from "./Work/SleeveBladeburnerWork";
|
import { SleeveBladeburnerWork } from "./Work/SleeveBladeburnerWork";
|
||||||
import { SleeveCrimeWork } from "./Work/SleeveCrimeWork";
|
import { SleeveCrimeWork } from "./Work/SleeveCrimeWork";
|
||||||
import * as sleeveMethods from "./SleeveMethods";
|
import * as sleeveMethods from "./SleeveMethods";
|
||||||
import { Sleeve as ISleeve } from "../../ScriptEditor/NetscriptDefinitions";
|
import { SleevePerson } from "../../ScriptEditor/NetscriptDefinitions";
|
||||||
|
|
||||||
export class Sleeve extends Person implements ISleeve {
|
export class Sleeve extends Person implements SleevePerson {
|
||||||
currentWork: Work | null = null;
|
currentWork: Work | null = null;
|
||||||
|
|
||||||
/** Clone retains 'memory' synchronization (and maybe exp?) upon prestige/installing Augs */
|
/** Clone retains 'memory' synchronization (and maybe exp?) upon prestige/installing Augs */
|
||||||
|
10
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
10
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@ -55,7 +55,7 @@ interface Player extends Person {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/** @public */
|
/** @public */
|
||||||
interface Sleeve extends Person {
|
interface SleevePerson extends Person {
|
||||||
shock: number;
|
shock: number;
|
||||||
sync: number;
|
sync: number;
|
||||||
memory: number;
|
memory: number;
|
||||||
@ -260,7 +260,7 @@ interface CodingAttemptOptions {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return value of {@link sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs}
|
* Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs}
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
interface AugmentPair {
|
interface AugmentPair {
|
||||||
@ -3515,7 +3515,7 @@ export interface Gang {
|
|||||||
* If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
* If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
||||||
* @public
|
* @public
|
||||||
*/
|
*/
|
||||||
export interface sleeve {
|
export interface Sleeve {
|
||||||
/**
|
/**
|
||||||
* Get the number of sleeves you own.
|
* Get the number of sleeves you own.
|
||||||
* @remarks
|
* @remarks
|
||||||
@ -3537,7 +3537,7 @@ export interface sleeve {
|
|||||||
* @param sleeveNumber - Index of the sleeve to retrieve information.
|
* @param sleeveNumber - Index of the sleeve to retrieve information.
|
||||||
* @returns Object containing information about this sleeve.
|
* @returns Object containing information about this sleeve.
|
||||||
*/
|
*/
|
||||||
getSleeve(sleeveNumber: number): Sleeve;
|
getSleeve(sleeveNumber: number): SleevePerson;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get task of a sleeve.
|
* Get task of a sleeve.
|
||||||
@ -4479,7 +4479,7 @@ export interface NS {
|
|||||||
* Namespace for sleeve functions.
|
* Namespace for sleeve functions.
|
||||||
* @remarks RAM cost: 0 GB
|
* @remarks RAM cost: 0 GB
|
||||||
*/
|
*/
|
||||||
readonly sleeve: sleeve;
|
readonly sleeve: Sleeve;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Namespace for stock functions.
|
* Namespace for stock functions.
|
||||||
|
Loading…
Reference in New Issue
Block a user