diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index d4bc7285b..a367eec97 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -9,7 +9,7 @@ export declare interface ActiveFragment { } /** - * Return value of {@link sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} + * Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} * @public */ export declare interface AugmentPair { @@ -2662,18 +2662,14 @@ export declare interface Multipliers { bladeburner_success_chance: number; } -/** - * Object representing a port. A port is a serialized queue. - * @public - */ +/** Object representing a port. A port is a serialized queue. + * @public */ export declare interface NetscriptPort { - /** - * Write data to a port. + /** Write data to a port. * @remarks * 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; /** @@ -2824,7 +2820,7 @@ export declare interface NS { * Namespace for sleeve functions. * @remarks RAM cost: 0 GB */ - readonly sleeve: sleeve; + readonly sleeve: Sleeve; /** * Namespace for stock functions. @@ -2880,11 +2876,36 @@ export declare interface NS { * @remarks * 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 + * `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)[]; @@ -6490,20 +6511,13 @@ export declare interface SkillsFormulas { calculateExp(skill: number, skillMult?: number): number; } -/** @public */ -export declare interface Sleeve extends Person { - shock: number; - sync: number; - memory: number; -} - /** * Sleeve API * @remarks * If you are not in BitNode-10, then you must have Source-File 10 in order to use this API. * @public */ -export declare interface sleeve { +export declare interface Sleeve { /** * Get the number of sleeves you own. * @remarks @@ -6525,7 +6539,7 @@ export declare interface sleeve { * @param sleeveNumber - Index of the sleeve to retrieve information. * @returns Object containing information about this sleeve. */ - getSleeve(sleeveNumber: number): Sleeve; + getSleeve(sleeveNumber: number): SleevePerson; /** * Get task of a sleeve. @@ -6774,6 +6788,13 @@ export declare type SleeveFactionTask = { /** @public */ export declare type SleeveInfiltrateTask = { type: "INFILTRATE" }; +/** @public */ +export declare interface SleevePerson extends Person { + shock: number; + sync: number; + memory: number; +} + /** @public */ export declare type SleeveRecoveryTask = { type: "RECOVERY" }; diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 8ee86699b..e1ace781c 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -87,8 +87,8 @@ | [Singularity](./bitburner.singularity.md) | Singularity API | | [Skills](./bitburner.skills.md) | | | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas | -| [sleeve](./bitburner.sleeve.md) | Sleeve API | -| [Sleeve](./bitburner.sleeve.md) | | +| [Sleeve](./bitburner.sleeve.md) | Sleeve API | +| [SleevePerson](./bitburner.sleeveperson.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)Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) | diff --git a/markdown/bitburner.ns.args.md b/markdown/bitburner.ns.args.md index 463ae0bd5..60c8c1a41 100644 --- a/markdown/bitburner.ns.args.md +++ b/markdown/bitburner.ns.args.md @@ -16,7 +16,33 @@ readonly args: (string | number | boolean)[]; 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 +} +``` diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 7e65aa3f3..c15c5e693 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -51,7 +51,7 @@ export async function main(ns) { | [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 | | [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 | | [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 | diff --git a/markdown/bitburner.ns.sleeve.md b/markdown/bitburner.ns.sleeve.md index 6e568b05f..bc3be1dd9 100644 --- a/markdown/bitburner.ns.sleeve.md +++ b/markdown/bitburner.ns.sleeve.md @@ -9,7 +9,7 @@ Namespace for sleeve functions. Signature: ```typescript -readonly sleeve: sleeve; +readonly sleeve: Sleeve; ``` ## Remarks diff --git a/markdown/bitburner.sleeve.getnumsleeves.md b/markdown/bitburner.sleeve.getnumsleeves.md index 81eab7964..e456fed41 100644 --- a/markdown/bitburner.sleeve.getnumsleeves.md +++ b/markdown/bitburner.sleeve.getnumsleeves.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.getsleeve.md b/markdown/bitburner.sleeve.getsleeve.md index 36e0547cd..c1dd37815 100644 --- a/markdown/bitburner.sleeve.getsleeve.md +++ b/markdown/bitburner.sleeve.getsleeve.md @@ -1,15 +1,15 @@ -[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. Signature: ```typescript -getSleeve(sleeveNumber: number): Sleeve; +getSleeve(sleeveNumber: number): SleevePerson; ``` ## Parameters @@ -20,7 +20,7 @@ getSleeve(sleeveNumber: number): Sleeve; Returns: -[Sleeve](./bitburner.sleeve.md) +[SleevePerson](./bitburner.sleeveperson.md) Object containing information about this sleeve. diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md index 7e8deb422..387a4ee49 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md index df39f2e50..9fd86d7b6 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.getsleeveaugmentations.md b/markdown/bitburner.sleeve.getsleeveaugmentations.md index 778065e30..d3835eac0 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentations.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentations.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md index a40916130..b4c635a4f 100644 --- a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md +++ b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.gettask.md b/markdown/bitburner.sleeve.gettask.md index e7ea25e69..11fec4014 100644 --- a/markdown/bitburner.sleeve.gettask.md +++ b/markdown/bitburner.sleeve.gettask.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md index 2f16a5318..e1d6e419a 100644 --- a/markdown/bitburner.sleeve.md +++ b/markdown/bitburner.sleeve.md @@ -4,19 +4,37 @@ ## Sleeve interface +Sleeve API Signature: ```typescript -interface Sleeve extends Person +export interface Sleeve ``` -Extends: [Person](./bitburner.person.md) -## Properties +## Remarks -| Property | Type | Description | -| --- | --- | --- | -| [memory](./bitburner.sleeve.memory.md) | number | | -| [shock](./bitburner.sleeve.shock.md) | number | | -| [sync](./bitburner.sleeve.sync.md) | number | | +If you are not in BitNode-10, then you must have Source-File 10 in order to use this API. + +## Methods + +| 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. | diff --git a/markdown/bitburner.sleeve.purchasesleeveaug.md b/markdown/bitburner.sleeve.purchasesleeveaug.md index a07cd58d2..16d6f836a 100644 --- a/markdown/bitburner.sleeve.purchasesleeveaug.md +++ b/markdown/bitburner.sleeve.purchasesleeveaug.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settobladeburneraction.md b/markdown/bitburner.sleeve.settobladeburneraction.md index 5e846724b..3d9bf246c 100644 --- a/markdown/bitburner.sleeve.settobladeburneraction.md +++ b/markdown/bitburner.sleeve.settobladeburneraction.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md index 37799f066..eb6919eb1 100644 --- a/markdown/bitburner.sleeve.settocommitcrime.md +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md index ff4c2aedc..bc8d93a0d 100644 --- a/markdown/bitburner.sleeve.settocompanywork.md +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md index 220ac859f..2d5b6ea17 100644 --- a/markdown/bitburner.sleeve.settofactionwork.md +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md index fd85512d4..b092838eb 100644 --- a/markdown/bitburner.sleeve.settogymworkout.md +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settoshockrecovery.md b/markdown/bitburner.sleeve.settoshockrecovery.md index 943036656..93a1ef01c 100644 --- a/markdown/bitburner.sleeve.settoshockrecovery.md +++ b/markdown/bitburner.sleeve.settoshockrecovery.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settosynchronize.md b/markdown/bitburner.sleeve.settosynchronize.md index 1630d90a4..17fa4ca6d 100644 --- a/markdown/bitburner.sleeve.settosynchronize.md +++ b/markdown/bitburner.sleeve.settosynchronize.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md index 8ad9440a8..f96d60a8b 100644 --- a/markdown/bitburner.sleeve.settouniversitycourse.md +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md index 56229adbb..e3d98cbfa 100644 --- a/markdown/bitburner.sleeve.travel.md +++ b/markdown/bitburner.sleeve.travel.md @@ -1,8 +1,8 @@ -[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. diff --git a/markdown/bitburner.sleeveperson.md b/markdown/bitburner.sleeveperson.md new file mode 100644 index 000000000..547347cd1 --- /dev/null +++ b/markdown/bitburner.sleeveperson.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleevePerson](./bitburner.sleeveperson.md) + +## SleevePerson interface + + +Signature: + +```typescript +interface SleevePerson extends Person +``` +Extends: [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 | | + diff --git a/markdown/bitburner.sleeve.memory.md b/markdown/bitburner.sleeveperson.memory.md similarity index 62% rename from markdown/bitburner.sleeve.memory.md rename to markdown/bitburner.sleeveperson.memory.md index b1cf14f9f..8af8dbd92 100644 --- a/markdown/bitburner.sleeve.memory.md +++ b/markdown/bitburner.sleeveperson.memory.md @@ -1,8 +1,8 @@ -[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 Signature: diff --git a/markdown/bitburner.sleeve.shock.md b/markdown/bitburner.sleeveperson.shock.md similarity index 63% rename from markdown/bitburner.sleeve.shock.md rename to markdown/bitburner.sleeveperson.shock.md index bd748fb90..016fe1da7 100644 --- a/markdown/bitburner.sleeve.shock.md +++ b/markdown/bitburner.sleeveperson.shock.md @@ -1,8 +1,8 @@ -[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 Signature: diff --git a/markdown/bitburner.sleeve.sync.md b/markdown/bitburner.sleeveperson.sync.md similarity index 63% rename from markdown/bitburner.sleeve.sync.md rename to markdown/bitburner.sleeveperson.sync.md index c6cd8c9a2..7c7f95909 100644 --- a/markdown/bitburner.sleeve.sync.md +++ b/markdown/bitburner.sleeveperson.sync.md @@ -1,8 +1,8 @@ -[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 Signature: diff --git a/src/NetscriptFunctions/Sleeve.ts b/src/NetscriptFunctions/Sleeve.ts index 9908c8e0b..3e4b87678 100644 --- a/src/NetscriptFunctions/Sleeve.ts +++ b/src/NetscriptFunctions/Sleeve.ts @@ -4,7 +4,7 @@ import { CityName } from "../Locations/data/CityNames"; import { findCrime } from "../Crime/CrimeHelpers"; import { Augmentation } from "../Augmentation/Augmentation"; -import { sleeve } from "../ScriptEditor/NetscriptDefinitions"; +import { Sleeve } from "../ScriptEditor/NetscriptDefinitions"; import { checkEnum } from "../utils/helpers/enum"; import { InternalAPI, NetscriptContext } from "../Netscript/APIWrapper"; import { isSleeveBladeburnerWork } from "../PersonObjects/Sleeve/Work/SleeveBladeburnerWork"; @@ -13,7 +13,7 @@ import { isSleeveCompanyWork } from "../PersonObjects/Sleeve/Work/SleeveCompanyW import { helpers } from "../Netscript/NetscriptHelpers"; import { cloneDeep } from "lodash"; -export function NetscriptSleeve(): InternalAPI { +export function NetscriptSleeve(): InternalAPI { const checkSleeveAPIAccess = function (ctx: NetscriptContext) { if (Player.bitNodeN !== 10 && !Player.sourceFileLvl(10)) { throw helpers.makeRuntimeErrorMsg( diff --git a/src/PersonObjects/Sleeve/Sleeve.ts b/src/PersonObjects/Sleeve/Sleeve.ts index e9f387abe..ce6acb621 100644 --- a/src/PersonObjects/Sleeve/Sleeve.ts +++ b/src/PersonObjects/Sleeve/Sleeve.ts @@ -40,9 +40,9 @@ import { SleeveSupportWork } from "./Work/SleeveSupportWork"; import { SleeveBladeburnerWork } from "./Work/SleeveBladeburnerWork"; import { SleeveCrimeWork } from "./Work/SleeveCrimeWork"; 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; /** Clone retains 'memory' synchronization (and maybe exp?) upon prestige/installing Augs */ diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 359ffa431..620f834c3 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -55,7 +55,7 @@ interface Player extends Person { } /** @public */ -interface Sleeve extends Person { +interface SleevePerson extends Person { shock: number; sync: number; memory: number; @@ -260,7 +260,7 @@ interface CodingAttemptOptions { } /** - * Return value of {@link sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} + * Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} * @public */ 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. * @public */ -export interface sleeve { +export interface Sleeve { /** * Get the number of sleeves you own. * @remarks @@ -3537,7 +3537,7 @@ export interface sleeve { * @param sleeveNumber - Index of the sleeve to retrieve information. * @returns Object containing information about this sleeve. */ - getSleeve(sleeveNumber: number): Sleeve; + getSleeve(sleeveNumber: number): SleevePerson; /** * Get task of a sleeve. @@ -4479,7 +4479,7 @@ export interface NS { * Namespace for sleeve functions. * @remarks RAM cost: 0 GB */ - readonly sleeve: sleeve; + readonly sleeve: Sleeve; /** * Namespace for stock functions.