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

1.9 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
buyCoffee(divisionName, cityName) Buy coffee for your employees
getHireAdVertCost(divisionName) Get data about an employee
getHireAdVertCount(adivisionName) Get the number of times you have Hired AdVert
getOffice(divisionName, cityName) Get data about an office
getOfficeSizeUpgradeCost(divisionName, cityName, asize) Cost to Upgrade office size.
getResearchCost(divisionName, researchName) Get the cost to unlock research
hasResearched(divisionName, researchName) Gets if you have unlocked a research
hireAdVert(divisionName) Hire AdVert.
hireEmployee(divisionName, cityName, employeePosition) Hire an employee.
research(divisionName, researchName) Purchase a research
setAutoJobAssignment(divisionName, cityName, job, amount) Set the auto job assignment for a job
throwParty(divisionName, cityName, costPerEmployee) Throw a party for your employees
upgradeOfficeSize(divisionName, cityName, size) Upgrade office size.