Files
bitburner-src/markdown/bitburner.sleeve.md

276 lines
3.8 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [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>
[getMemoryUpgradeCost(sleeveNumber, amount)](./bitburner.sleeve.getmemoryupgradecost.md)
</td><td>
Get the cost of memory upgrades.
</td></tr>
<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>
[getSleeveCost()](./bitburner.sleeve.getsleevecost.md)
</td><td>
Get the cost of the next 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>
[purchaseSleeve()](./bitburner.sleeve.purchasesleeve.md)
</td><td>
Purchase a sleeve. You must be in BitNode 10 to use this API.
</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>
<tr><td>
[upgradeMemory(sleeveNumber, amount)](./bitburner.sleeve.upgradememory.md)
</td><td>
Upgrade memory of a sleeve. You must be in BitNode 10 to use this API.
</td></tr>
</tbody></table>