Files
bitburner-src/markdown/bitburner.bladeburner.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

5.8 KiB

Home > bitburner > Bladeburner

Bladeburner interface

Bladeburner API

Signature:

export interface Bladeburner 

Remarks

You have to be employed in the Bladeburner division and be in BitNode 6/7 or have Source-File 6/7 in order to use this API.

Methods

Method

Description

getActionAutolevel(type, name)

Get whether an action is set to autolevel.

getActionCountRemaining(type, name)

Get action count remaining.

getActionCurrentLevel(type, name)

Get the current level of an action.

getActionCurrentTime()

Get the time elapsed on current action.

getActionEstimatedSuccessChance(type, name, sleeveNumber)

Get estimate success chance of an action.

getActionMaxLevel(type, name)

Get the maximum level of an action.

getActionRepGain(type, name, level)

Get the reputation gain of an action.

getActionSuccesses(type, name)

Get action successes.

getActionTime(type, name)

Get the time to complete an action.

getBlackOpNames()

List all black ops.

getBlackOpRank(name)

Get black op required rank.

getBonusTime()

Get Bladeburner bonus time.

getCity()

Get current city.

getCityChaos(city)

Get chaos of a city.

getCityCommunities(city)

Get number of communities in a city.

getCityEstimatedPopulation(city)

Get estimated population in city.

getContractNames()

List all contracts.

getCurrentAction()

Get current action.

getGeneralActionNames()

List all general actions.

getNextBlackOp()

Get an object with the name and rank requirement of the next BlackOp that can be completed.

getOperationNames()

List all operations.

getRank()

Get player bladeburner rank.

getSkillLevel(skillName)

Get skill level.

getSkillNames()

List all skills.

getSkillPoints()

Get bladeburner skill points.

getSkillUpgradeCost(skillName, count)

Get cost to upgrade skill.

getStamina()

Get Bladeburner stamina.

getTeamSize(type, name)

Get team size.

inBladeburner()

Returns whether player is a member of Bladeburner division. Does not require API access.

joinBladeburnerDivision()

Join the Bladeburner division.

joinBladeburnerFaction()

Join the Bladeburner faction.

nextUpdate()

Sleep until the next Bladeburner update has happened.

setActionAutolevel(type, name, autoLevel)

Set an action autolevel.

setActionLevel(type, name, level)

Set the level of an action.

setTeamSize(type, name, size)

Set team size.

startAction(type, name)

Start an action.

stopBladeburnerAction()

Stop current action.

switchCity(city)

Travel to another city in Bladeburner.

upgradeSkill(skillName, count)

Upgrade skill.