Files
bitburner-src/markdown/bitburner.sleeve.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

3.2 KiB

Home > bitburner > Sleeve

Sleeve interface

Sleeve API

Signature:

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

Method

Description

getNumSleeves()

Get the number of sleeves you own.

getSleeve(sleeveNumber)

Get information about a sleeve.

getSleeveAugmentationPrice(augName)

Get price of an augmentation.

getSleeveAugmentationRepReq(augName)

Get reputation requirement of an augmentation.

getSleeveAugmentations(sleeveNumber)

Get augmentations installed on a sleeve.

getSleevePurchasableAugs(sleeveNumber)

List purchasable augs for a sleeve.

getTask(sleeveNumber)

Get task of a sleeve.

purchaseSleeveAug(sleeveNumber, augName)

Purchase an aug for a sleeve.

setToBladeburnerAction(sleeveNumber, action, contract)

Set a sleeve to perform Bladeburner actions.

setToCommitCrime(sleeveNumber, crimeType)

Set a sleeve to commit crime.

setToCompanyWork(sleeveNumber, companyName)

Set a sleeve to work for a company.

setToFactionWork(sleeveNumber, factionName, factionWorkType)

Set a sleeve to work for a faction.

setToGymWorkout(sleeveNumber, gymName, stat)

Set a sleeve to workout at the gym.

setToIdle(sleeveNumber)

Set a sleeve to idle.

setToShockRecovery(sleeveNumber)

Set a sleeve to shock recovery.

setToSynchronize(sleeveNumber)

Set a sleeve to synchronize.

setToUniversityCourse(sleeveNumber, universityName, courseName)

Set a sleeve to take a class at a university.

travel(sleeveNumber, city)

Make a sleeve travel to another city. The cost for using this function is the same as for a player.