mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-26 19:14:32 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
232 lines
3.2 KiB
Markdown
232 lines
3.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md)
|
|
|
|
## Sleeve interface
|
|
|
|
Sleeve API
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface Sleeve
|
|
```
|
|
|
|
## Remarks
|
|
|
|
If you are not in BitNode-10, then you must have Source-File 10 in order to use this API.
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[getNumSleeves()](./bitburner.sleeve.getnumsleeves.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the number of sleeves you own.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getSleeve(sleeveNumber)](./bitburner.sleeve.getsleeve.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get information about a sleeve.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getSleeveAugmentationPrice(augName)](./bitburner.sleeve.getsleeveaugmentationprice.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get price of an augmentation.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getSleeveAugmentationRepReq(augName)](./bitburner.sleeve.getsleeveaugmentationrepreq.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get reputation requirement of an augmentation.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get augmentations installed on a sleeve.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
List purchasable augs for a sleeve.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getTask(sleeveNumber)](./bitburner.sleeve.gettask.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get task of a sleeve.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Purchase an aug for a sleeve.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to perform Bladeburner actions.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToCommitCrime(sleeveNumber, crimeType)](./bitburner.sleeve.settocommitcrime.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to commit crime.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to work for a company.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to work for a faction.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to workout at the gym.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToIdle(sleeveNumber)](./bitburner.sleeve.settoidle.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to idle.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to shock recovery.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to synchronize.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setToUniversityCourse(sleeveNumber, universityName, courseName)](./bitburner.sleeve.settouniversitycourse.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set a sleeve to take a class at a university.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[travel(sleeveNumber, city)](./bitburner.sleeve.travel.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Make a sleeve travel to another city. The cost for using this function is the same as for a player.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|