bitburner-src/markdown/bitburner.bladeburner.md

Home > bitburner > Bladeburner

Bladeburner interface

Signature:

export interface Bladeburner 

Methods

Method	Description
getActionAutolevel(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Return a boolean indicating whether or not this action is currently set to autolevel.Returns false if an invalid action is specified.
getActionCountRemaining(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the remaining count of the specified action.Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.
getActionCurrentLevel(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the current level of this action.Returns -1 if an invalid action is specified.
getActionEstimatedSuccessChance(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).
getActionMaxLevel(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the maximum level for this action.Returns -1 if an invalid action is specified.
getActionRepGain(type, name, level)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value.
getActionTime(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of seconds it takes to complete the specified action
getBlackOpNames()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner Black Ops.
getBlackOpRank(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the rank required to complete this BlackOp.Returns -1 if an invalid action is specified.
getBonusTime()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.
getCity()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the city that the player is currently in (for Bladeburner).
getCityChaos(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the chaos in the specified city, or -1 if an invalid city was specified.
getCityCommunities(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.
getCityEstimatedPopulation(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.
getContractNames()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner contracts.
getCurrentAction()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.
getGeneralActionNames()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all general Bladeburner actions.
getOperationNames()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner operations.
getRank()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the player’s Bladeburner Rank.
getSkillLevel(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.This function returns your level in the specified skill.The function returns -1 if an invalid skill name is passed in.
getSkillNames()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all general Bladeburner skills.
getSkillPoints()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of Bladeburner skill points you have.
getSkillUpgradeCost(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.This function returns the number of skill points needed to upgrade the specified skill.The function returns -1 if an invalid skill name is passed in.
getStamina()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array with two elements: * [Current stamina, Max stamina]
getTeamSize(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of Bladeburner team members you have assigned to the specified action.Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.
joinBladeburnerDivision()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to join the Bladeburner division.Returns true if you successfully join the Bladeburner division, or if you are already a member.Returns false otherwise.
joinBladeburnerFaction()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to join the Bladeburner faction.Returns true if you successfully join the Bladeburner faction, or if you are already a member.Returns false otherwise.
setActionAutolevel(type, name, autoLevel)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Enable/disable autoleveling for the specified action.
setActionLevel(type, name, level)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Set the level for the specified action.
setTeamSize(type, name, size)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Set the team size for the specified Bladeburner action.Returns the team size that was set, or -1 if the function failed.
startAction(type, name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.
stopBladeburnerAction()	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Stops the current Bladeburner action.
switchCity(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to switch to the specified city (for Bladeburner only).Returns true if successful, and false otherwise
upgradeSkill(name)	You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to upgrade the specified Bladeburner skill.Returns true if the skill is successfully upgraded, and false otherwise.