bitburner-src/markdown/bitburner.sleeve.md
catloversg cacecda72f
API: Add types for parameters of gym-university-bladeburner API (Fix merging error) (#1596)
* API: Add types for parameters of gym-university-bladeburner API
* Fix merging error
2024-08-17 14:08:55 -07:00

2.6 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.