mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
dcd2f33f7c
* 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>
179 lines
2.5 KiB
Markdown
179 lines
2.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md)
|
|
|
|
## OfficeAPI interface
|
|
|
|
Corporation Office API
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface OfficeAPI
|
|
```
|
|
|
|
## Remarks
|
|
|
|
Requires the Office API upgrade from your corporation.
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[buyTea(divisionName, city)](./bitburner.officeapi.buytea.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Buy tea for your employees.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getHireAdVertCost(divisionName)](./bitburner.officeapi.gethireadvertcost.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the cost to hire AdVert.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getHireAdVertCount(divisionName)](./bitburner.officeapi.gethireadvertcount.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the number of times you have hired AdVert.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getOffice(divisionName, city)](./bitburner.officeapi.getoffice.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get data about an office.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getOfficeSizeUpgradeCost(divisionName, city, size)](./bitburner.officeapi.getofficesizeupgradecost.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the cost to upgrade an office.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getResearchCost(divisionName, researchName)](./bitburner.officeapi.getresearchcost.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the cost to unlock a research.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hasResearched(divisionName, researchName)](./bitburner.officeapi.hasresearched.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Check if you unlocked a research.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hireAdVert(divisionName)](./bitburner.officeapi.hireadvert.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Hire AdVert.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hireEmployee(divisionName, city, employeePosition)](./bitburner.officeapi.hireemployee.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Hire an employee.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[research(divisionName, researchName)](./bitburner.officeapi.research.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
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.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setJobAssignment(divisionName, city, job, amount)](./bitburner.officeapi.setjobassignment.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set the job assignment for a job.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[throwParty(divisionName, city, costPerEmployee)](./bitburner.officeapi.throwparty.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Throw a party for your employees.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[upgradeOfficeSize(divisionName, city, size)](./bitburner.officeapi.upgradeofficesize.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Upgrade office size.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|