bitburner-src/markdown/bitburner.bladeburner.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

4.2 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-7 or have Source-File 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) 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.
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(name) Get chaos of a city.
getCityCommunities(name) Get number of communities in a city.
getCityEstimatedPopulation(name) Get estimated population in city.
getContractNames() List all contracts.
getCurrentAction() Get current action.
getGeneralActionNames() List all general actions.
getOperationNames() List all operations.
getRank() Get player bladeburner rank.
getSkillLevel(name) Get skill level.
getSkillNames() List all skills.
getSkillPoints() Get bladeburner skill points.
getSkillUpgradeCost(name, 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.
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(name) Travel to another city in bladeburner.
upgradeSkill(name, count) Upgrade skill.