bitburner-src/markdown/bitburner.sleeve.md

Home > bitburner > Sleeve

Sleeve interface

Sleeve API

Signature:

interface Sleeve 

Methods

Method	Description
getInformation(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a struct containing tons of information about this sleeve
getNumSleeves()	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return the number of duplicate sleeves the player has.
getSleeveAugmentations(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a list of augmentation names that this sleeve has installed.
getSleevePurchasableAugs(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a list of augmentations that the player can buy for this sleeve.
getSleeveStats(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a structure containing the stats of the sleeve.
getTask(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything.
purchaseSleeveAug(sleeveNumber, augName)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return true if the aug was purchased and installed on the sleeve.
setToCommitCrime(sleeveNumber, name)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully.Returns false if an invalid action is specified.
setToCompanyWork(sleeveNumber, companyName)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working or this company.
setToFactionWork(sleeveNumber, factionName, factionWorkType)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working or this faction.
setToGymWorkout(sleeveNumber, gymName, stat)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working out.
setToShockRecovery(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully.
setToSynchronize(sleeveNumber)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully.
setToUniversityCourse(sleeveNumber, university, className)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully.
travel(sleeveNumber, cityName)	If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve reached destination.