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

2.5 KiB

Home > bitburner > OfficeAPI

OfficeAPI interface

Corporation Office API

Signature:

export interface OfficeAPI 

Remarks

Requires the Office API upgrade from your corporation.

Methods

Method

Description

buyTea(divisionName, city)

Buy tea for your employees.

getHireAdVertCost(divisionName)

Get the cost to hire AdVert.

getHireAdVertCount(divisionName)

Get the number of times you have hired AdVert.

getOffice(divisionName, city)

Get data about an office.

getOfficeSizeUpgradeCost(divisionName, city, size)

Get the cost to upgrade an office.

getResearchCost(divisionName, researchName)

Get the cost to unlock a research.

hasResearched(divisionName, researchName)

Check if you unlocked a research.

hireAdVert(divisionName)

Hire AdVert.

hireEmployee(divisionName, city, employeePosition)

Hire an employee.

research(divisionName, researchName)

Purchase a research.

Some research is only available for product industries. This function does not do anything if you purchase that research for a material industry.

setJobAssignment(divisionName, city, job, amount)

Set the job assignment for a job.

throwParty(divisionName, city, costPerEmployee)

Throw a party for your employees.

upgradeOfficeSize(divisionName, city, size)

Upgrade office size.