Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-23 06:32:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1843 from danielyxie/dev

Browse Source 
corp doc
This commit is contained in:
hydroflame 2021-12-08 20:03:44 -05:00 committed by GitHub
commit 4c88ab7794
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
101 changed files with 1052 additions and 397 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

278
dist/bitburner.d.ts vendored
View File

@ -827,32 +827,76 @@ export declare interface CodingContract {
}
/**
* Corporation API
* @public
*/
export declare interface Corporation extends WarehouseAPI, OfficeAPI {
/**
* Get corporation data
* @returns Corporation data
*/
getCorporation(): CorporationInfo;
/**
* Get division data
* @param divisionName - Name of the division
* @returns Division data
*/
getDivision(divisionName: string): Division;
expandIndustry(industryName: string, divisionName: string): void;
/**
* Expand to a new industry
* @param industryType - Name of the industry
* @param divisionName - Name of the division
*/
expandIndustry(industryType: string, divisionName: string): void;
/**
* Expand to a new city
* @param divisionName - Name of the division
* @param cityName - Name of the city
*/
expandCity(divisionName: string, cityName: string): void;
/**
* Unlock an upgrade.
* @param upgradeName - Name of the upgrade
*/
unlockUpgrade(upgradeName: string): void;
/**
* Level an upgrade.
* @param upgradeName - Name of the upgrade
*/
levelUpgrade(upgradeName: string): void;
/**
* Issue dividends
* @param percent - Percent of profit to issue as dividends.
*/
issueDividends(percent: number): void;
}
/**
* General info about a corporation
* @public
*/
export declare interface CorporationInfo {
/** Name of the corporation */
name: string;
/** Funds available */
funds: number;
/** Revenue per second this cycle */
revenue: number;
/** Expenses per second this cycle */
expenses: number;
/** Is the company is public */
public: boolean;
/** Total number of shares issues by this corporation */
totalShares: number;
/** Amount of share owned */
numShares: number;
/** Cooldown until shares can be sold again */
shareSaleCooldown: number;
/** Amount of shares issued */
issuedShares: number;
/** Price of the shares */
sharePrice: number;
/** State of the corporation, like PRODUCTION or EXPORT */
state: string;
}
@ -904,42 +948,64 @@ export declare interface CrimeStats {
}
/**
* Corporation division
* @public
*/
export declare interface Division {
/** Name of the division */
name: string;
/** Type of division, like Aggriculture */
type: string;
/** Awareness of the division */
awareness: number;
/** Popularity of the division */
popularity: number;
/** Production multiplier */
prodMult: number;
/** Amount of research in that division */
research: number;
/** Revenue last cycle */
lastCycleRevenue: number;
/** Expenses last cycle */
lastCycleExpenses: number;
/** Revenue this cycle */
thisCycleRevenue: number;
/** Expenses this cycle */
thisCycleExpenses: number;
/** All research bought */
upgrades: number[];
/** Cities in which this division has expanded */
cities: string[];
}
/**
* Employee in an office
* @public
*/
export declare interface Employee {
/** Name of the employee */
name: string;
/** Morale */
mor: number;
/** Happiness */
hap: number;
/** Energy */
ene: number;
int: number;
cha: number;
exp: number;
cre: number;
eff: number;
/** Salary */
sal: number;
/** City */
loc: string;
/** Current job */
pos: string;
}
/**
* Object representing the number of employee in each job.
* @public
*/
export declare interface EmployeeJobs {
@ -2002,11 +2068,15 @@ export declare interface HacknetServersFormulas {
}
/**
* Material in a warehouse
* @public
*/
export declare interface Material {
/** Name of the material */
name: string;
/** Amount of material */
qty: number;
/** Quality of the material */
qlt: number;
}
@ -3705,33 +3775,100 @@ export declare interface NS extends Singularity {
}
/**
* Office for a division in a city.
* @public
*/
export declare interface Office {
/** City of the office */
loc: string;
/** Maximum number of employee */
size: number;
/** Minimum amount of energy of the employees */
minEne: number;
/** Maximum amount of energy of the employees */
maxEne: number;
/** Minimum happiness of the employees */
minHap: number;
/** Maximum happiness of the employees */
maxHap: number;
/** Maximum morale of the employees */
maxMor: number;
/** Name of all the employees */
employees: string[];
/** Positions of the employees */
employeeProd: EmployeeJobs;
}
/**
* Corporation Office API
* @remarks
* Requires the Office API upgrade from your corporation.
* @public
*/
export declare interface OfficeAPI {
employees(divisionName: string, cityName: string): string[];
/**
* Assign an employee to a job.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param employeeName - name of the employee
* @param job - Name of the job.
* @returns A promise that is fulfilled when the assignment is complete.
*/
assignJob(divisionName: string, cityName: string, employeeName: string, job: string): Promise<void>;
hireEmployee(divisionName: string, cityName: string): Employee;
/**
* Assign an employee to a job.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @returns The newly hired employee, if any
*/
hireEmployee(divisionName: string, cityName: string): Employee | undefined;
/**
* Upgrade office size.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param size - Amount of positions to open
*/
upgradeOfficeSize(divisionName: string, cityName: string, size: number): void;
/**
* Assign an employee to a job.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param costPerEmployee - Amount to spend per employee.
* @returns Amount of happiness increased.
*/
throwParty(divisionName: string, cityName: string, costPerEmployee: number): Promise<number>;
/**
* Buy coffee for your employees
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @returns A promise that is fulfilled when the coffee is served.
*/
buyCoffee(divisionName: string, cityName: string): Promise<void>;
/**
* Hire AdVert.
* @param divisionName - Name of the division
*/
hireAdVert(divisionName: string): void;
/**
* Hire AdVert.
* @param divisionName - Name of the division
* @param researchName - Name of the research
*/
research(divisionName: string, researchName: string): void;
/**
* Get data about an office
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @returns Office data
*/
getOffice(divisionName: string, cityName: string): Office;
/**
* Get data about an employee
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param employeeName - Name of the employee
* @returns Employee data
*/
getEmployee(divisionName: string, cityName: string, employeeName: string): Employee;
}
@ -3862,13 +3999,19 @@ export declare interface ProcessInfo {
}
/**
* Product in a warehouse
* @public
*/
export declare interface Product {
/** Name of the product */
name: string;
/** Demand for the product */
dmd: number;
/** Competition for the product */
cmp: number;
/** Production cost */
pCost: number;
/** Sell cost, can be "MP+5" */
sCost: string | number;
}
@ -5488,38 +5631,134 @@ export declare interface TIX {
}
/**
* Warehouse for a division in a city
* @public
*/
export declare interface Warehouse {
/** Amount of size upgrade bought */
level: number;
/** City in which the warehouse is located */
loc: string;
/** Total space in the warehouse */
size: number;
/** Used space in the warehouse */
sizeUsed: number;
}
/**
* Corporation Warehouse API
* @remarks
* Requires the Warehouse API upgrade from your corporation.
* @public
*/
export declare interface WarehouseAPI {
sellMaterial(divisionName: string, cityName: string, materialName: string, amt: number, price: number): void;
/**
* Set material sell data.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param amt - Amount to sell, can be "MAX"
* @param price - Price to sell, can be "MP"
*/
sellMaterial(divisionName: string, cityName: string, materialName: string, amt: string, price: string): void;
/**
* Set product sell data.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param productName - Name of the product
* @param amt - Amount to sell, can be "MAX"
* @param price - Price to sell, can be "MP"
* @param all - Sell in all city
*/
sellProduct(
divisionName: string,
cityName: string,
productName: string,
amt: number,
price: number,
amt: string,
price: string,
all: boolean,
): void;
/**
* Discontinue a product.
* @param divisionName - Name of the division
* @param productName - Name of the product
*/
discontinueProduct(divisionName: string, productName: string): void;
/**
* Set smart supply
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param enabled - smart supply enabled
*/
setSmartSupply(divisionName: string, cityName: string, enabled: boolean): void;
/**
* Set material buy data
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param amt - Amount of material to buy
*/
buyMaterial(divisionName: string, cityName: string, materialName: string, amt: number): void;
/**
* Get warehouse data
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @returns warehouse data
*/
getWarehouse(divisionName: string, cityName: string): Warehouse;
/**
* Get product data
* @param divisionName - Name of the division
* @param productName - Name of the product
* @returns product data
*/
getProduct(divisionName: string, productName: string): Product;
/**
* Get material data
* @param divisionName - Name of the division
* @param materialName - Name of the material
* @returns material data
*/
getMaterial(divisionName: string, cityName: string, materialName: string): Material;
/**
* Set market TA 1 for a material.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param on - market ta enabled
*/
setMaterialMarketTA1(divisionName: string, cityName: string, materialName: string, on: boolean): void;
/**
* Set market TA 2 for a material.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param on - market ta enabled
*/
setMaterialMarketTA2(divisionName: string, cityName: string, materialName: string, on: boolean): void;
/**
* Set market TA 1 for a product.
* @param divisionName - Name of the division
* @param productName - Name of the product
* @param on - market ta enabled
*/
setProductMarketTA1(divisionName: string, productName: string, on: boolean): void;
/**
* Set market TA 2 for a product.
* @param divisionName - Name of the division
* @param productName - Name of the product
* @param on - market ta enabled
*/
setProductMarketTA2(divisionName: string, productName: string, on: boolean): void;
/**
* Set material export data
* @param sourceDivision - Source division
* @param sourceCity - Source city
* @param targetDivision - Target division
* @param targetCity - Target city
* @param materialName - Name of the material
* @param amt - Amount of material to export.
*/
exportMaterial(
sourceDivision: string,
sourceCity: string,
@ -5528,6 +5767,15 @@ export declare interface WarehouseAPI {
materialName: string,
amt: number,
): void;
/**
* Cancel material export
* @param sourceDivision - Source division
* @param sourceCity - Source city
* @param targetDivision - Target division
* @param targetCity - Target city
* @param materialName - Name of the material
* @param amt - Amount of material to export.
*/
cancelExportMaterial(
sourceDivision: string,
sourceCity: string,
@ -5536,8 +5784,26 @@ export declare interface WarehouseAPI {
materialName: string,
amt: number,
): void;
/**
* Purchase warehouse for a new city
* @param divisionName - Name of the division
* @param cityName - Name of the city
*/
purchaseWarehouse(divisionName: string, cityName: string): void;
/**
* Upgrade warehouse
* @param divisionName - Name of the division
* @param cityName - Name of the city
*/
upgradeWarehouse(divisionName: string, cityName: string): void;
/**
* Create a new product
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param productName - Name of the product
* @param designInvest - Amount to invest for the design of the product.
* @param marketingInvest - Amount to invest for the marketing of the product.
*/
makeProduct(
divisionName: string,
cityName: string,

267
input/bitburner.api.json
View File

@ -5178,7 +5178,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Corporation:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Corporation API\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5209,7 +5209,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#expandCity:member(1)",
"docComment": "",
"docComment": "/**\n * Expand to a new city\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5268,11 +5268,11 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#expandIndustry:member(1)",
"docComment": "",
"docComment": "/**\n * Expand to a new industry\n *\n * @param industryType - Name of the industry\n *\n * @param divisionName - Name of the division\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "expandIndustry(industryName: "
"text": "expandIndustry(industryType: "
},
{
"kind": "Content",
@ -5308,7 +5308,7 @@
"overloadIndex": 1,
"parameters": [
{
"parameterName": "industryName",
"parameterName": "industryType",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
@ -5327,7 +5327,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#getCorporation:member(1)",
"docComment": "",
"docComment": "/**\n * Get corporation data\n *\n * @returns Corporation data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5356,7 +5356,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#getDivision:member(1)",
"docComment": "",
"docComment": "/**\n * Get division data\n *\n * @param divisionName - Name of the division\n *\n * @returns Division data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5401,7 +5401,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#issueDividends:member(1)",
"docComment": "",
"docComment": "/**\n * Issue dividends\n *\n * @param percent - Percent of profit to issue as dividends.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5445,7 +5445,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#levelUpgrade:member(1)",
"docComment": "",
"docComment": "/**\n * Level an upgrade.\n *\n * @param upgradeName - Name of the upgrade\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5489,7 +5489,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#unlockUpgrade:member(1)",
"docComment": "",
"docComment": "/**\n * Unlock an upgrade.\n *\n * @param upgradeName - Name of the upgrade\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5545,7 +5545,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!CorporationInfo:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * General info about a corporation\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5558,7 +5558,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#expenses:member",
"docComment": "",
"docComment": "/**\n * Expenses per second this cycle\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5584,7 +5584,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#funds:member",
"docComment": "",
"docComment": "/**\n * Funds available\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5610,7 +5610,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#issuedShares:member",
"docComment": "",
"docComment": "/**\n * Amount of shares issued\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5636,7 +5636,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#name:member",
"docComment": "",
"docComment": "/**\n * Name of the corporation\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5662,7 +5662,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#numShares:member",
"docComment": "",
"docComment": "/**\n * Amount of share owned\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5688,7 +5688,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#public:member",
"docComment": "",
"docComment": "/**\n * Is the company is public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5714,7 +5714,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#revenue:member",
"docComment": "",
"docComment": "/**\n * Revenue per second this cycle\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5740,7 +5740,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#sharePrice:member",
"docComment": "",
"docComment": "/**\n * Price of the shares\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5766,7 +5766,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#shareSaleCooldown:member",
"docComment": "",
"docComment": "/**\n * Cooldown until shares can be sold again\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5792,7 +5792,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#state:member",
"docComment": "",
"docComment": "/**\n * State of the corporation, like PRODUCTION or EXPORT\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -5818,7 +5818,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!CorporationInfo#totalShares:member",
"docComment": "",
"docComment": "/**\n * Total number of shares issues by this corporation\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6383,7 +6383,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Division:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Corporation division\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6396,7 +6396,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#awareness:member",
"docComment": "",
"docComment": "/**\n * Awareness of the division\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6422,7 +6422,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#cities:member",
"docComment": "",
"docComment": "/**\n * Cities in which this division has expanded\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6448,7 +6448,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#lastCycleExpenses:member",
"docComment": "",
"docComment": "/**\n * Expenses last cycle\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6474,7 +6474,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#lastCycleRevenue:member",
"docComment": "",
"docComment": "/**\n * Revenue last cycle\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6500,7 +6500,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#name:member",
"docComment": "",
"docComment": "/**\n * Name of the division\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6526,7 +6526,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#popularity:member",
"docComment": "",
"docComment": "/**\n * Popularity of the division\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6552,7 +6552,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#prodMult:member",
"docComment": "",
"docComment": "/**\n * Production multiplier\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6578,7 +6578,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#research:member",
"docComment": "",
"docComment": "/**\n * Amount of research in that division\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6604,7 +6604,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#thisCycleExpenses:member",
"docComment": "",
"docComment": "/**\n * Expenses this cycle\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6630,7 +6630,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#thisCycleRevenue:member",
"docComment": "",
"docComment": "/**\n * Revenue this cycle\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6656,7 +6656,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#type:member",
"docComment": "",
"docComment": "/**\n * Type of division, like Aggriculture\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6682,7 +6682,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Division#upgrades:member",
"docComment": "",
"docComment": "/**\n * All research bought\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6711,7 +6711,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Employee:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Employee in an office\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6802,7 +6802,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#ene:member",
"docComment": "",
"docComment": "/**\n * Energy\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6854,7 +6854,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#hap:member",
"docComment": "",
"docComment": "/**\n * Happiness\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6906,7 +6906,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#loc:member",
"docComment": "",
"docComment": "/**\n * City\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6932,7 +6932,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#mor:member",
"docComment": "",
"docComment": "/**\n * Morale\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6958,7 +6958,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#name:member",
"docComment": "",
"docComment": "/**\n * Name of the employee\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -6984,7 +6984,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#pos:member",
"docComment": "",
"docComment": "/**\n * Current job\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -7010,7 +7010,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Employee#sal:member",
"docComment": "",
"docComment": "/**\n * Salary\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -7039,7 +7039,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!EmployeeJobs:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Object representing the number of employee in each job.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -13763,7 +13763,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Material:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Material in a warehouse\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -13776,7 +13776,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Material#name:member",
"docComment": "",
"docComment": "/**\n * Name of the material\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -13802,7 +13802,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Material#qlt:member",
"docComment": "",
"docComment": "/**\n * Quality of the material\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -13828,7 +13828,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Material#qty:member",
"docComment": "",
"docComment": "/**\n * Amount of material\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19344,7 +19344,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Office:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Office for a division in a city.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19357,7 +19357,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#employeeProd:member",
"docComment": "",
"docComment": "/**\n * Positions of the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19384,7 +19384,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#employees:member",
"docComment": "",
"docComment": "/**\n * Name of all the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19410,7 +19410,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#loc:member",
"docComment": "",
"docComment": "/**\n * City of the office\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19436,7 +19436,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#maxEne:member",
"docComment": "",
"docComment": "/**\n * Maximum amount of energy of the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19462,7 +19462,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#maxHap:member",
"docComment": "",
"docComment": "/**\n * Maximum happiness of the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19488,7 +19488,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#maxMor:member",
"docComment": "",
"docComment": "/**\n * Maximum morale of the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19514,7 +19514,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#minEne:member",
"docComment": "",
"docComment": "/**\n * Minimum amount of energy of the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19540,7 +19540,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#minHap:member",
"docComment": "",
"docComment": "/**\n * Minimum happiness of the employees\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19566,7 +19566,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Office#size:member",
"docComment": "",
"docComment": "/**\n * Maximum number of employee\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19595,7 +19595,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!OfficeAPI:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Corporation Office API\n *\n * @remarks\n *\n * Requires the Office API upgrade from your corporation.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19608,7 +19608,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#assignJob:member(1)",
"docComment": "",
"docComment": "/**\n * Assign an employee to a job.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param employeeName - name of the employee\n *\n * @param job - Name of the job.\n *\n * @returns A promise that is fulfilled when the assignment is complete.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19702,7 +19702,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#buyCoffee:member(1)",
"docComment": "",
"docComment": "/**\n * Buy coffee for your employees\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns A promise that is fulfilled when the coffee is served.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19763,69 +19763,10 @@
],
"name": "buyCoffee"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#employees:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "employees(divisionName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", cityName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "divisionName",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "cityName",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "employees"
},
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#getEmployee:member(1)",
"docComment": "",
"docComment": "/**\n * Get data about an employee\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param employeeName - Name of the employee\n *\n * @returns Employee data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19900,7 +19841,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#getOffice:member(1)",
"docComment": "",
"docComment": "/**\n * Get data about an office\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns Office data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -19960,7 +19901,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#hireAdVert:member(1)",
"docComment": "",
"docComment": "/**\n * Hire AdVert.\n *\n * @param divisionName - Name of the division\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -20004,7 +19945,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#hireEmployee:member(1)",
"docComment": "",
"docComment": "/**\n * Assign an employee to a job.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns The newly hired employee, if any\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -20031,6 +19972,10 @@
"text": "Employee",
"canonicalReference": "bitburner!Employee:interface"
},
{
"kind": "Content",
"text": " | undefined"
},
{
"kind": "Content",
"text": ";"
@ -20039,7 +19984,7 @@
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
@ -20064,7 +20009,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#research:member(1)",
"docComment": "",
"docComment": "/**\n * Hire AdVert.\n *\n * @param divisionName - Name of the division\n *\n * @param researchName - Name of the research\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -20123,7 +20068,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#throwParty:member(1)",
"docComment": "",
"docComment": "/**\n * Assign an employee to a job.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param costPerEmployee - Amount to spend per employee.\n *\n * @returns Amount of happiness increased.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -20202,7 +20147,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!OfficeAPI#upgradeOfficeSize:member(1)",
"docComment": "",
"docComment": "/**\n * Upgrade office size.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param size - Amount of positions to open\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -22823,7 +22768,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Product:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Product in a warehouse\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -22836,7 +22781,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Product#cmp:member",
"docComment": "",
"docComment": "/**\n * Competition for the product\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -22862,7 +22807,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Product#dmd:member",
"docComment": "",
"docComment": "/**\n * Demand for the product\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -22888,7 +22833,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Product#name:member",
"docComment": "",
"docComment": "/**\n * Name of the product\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -22914,7 +22859,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Product#pCost:member",
"docComment": "",
"docComment": "/**\n * Production cost\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -22940,7 +22885,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Product#sCost:member",
"docComment": "",
"docComment": "/**\n * Sell cost, can be \"MP+5\"\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29502,7 +29447,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!Warehouse:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Warehouse for a division in a city\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29515,7 +29460,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Warehouse#level:member",
"docComment": "",
"docComment": "/**\n * Amount of size upgrade bought\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29541,7 +29486,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Warehouse#loc:member",
"docComment": "",
"docComment": "/**\n * City in which the warehouse is located\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29567,7 +29512,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Warehouse#size:member",
"docComment": "",
"docComment": "/**\n * Total space in the warehouse\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29593,7 +29538,7 @@
{
"kind": "PropertySignature",
"canonicalReference": "bitburner!Warehouse#sizeUsed:member",
"docComment": "",
"docComment": "/**\n * Used space in the warehouse\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29622,7 +29567,7 @@
{
"kind": "Interface",
"canonicalReference": "bitburner!WarehouseAPI:interface",
"docComment": "/**\n * @public\n */\n",
"docComment": "/**\n * Corporation Warehouse API\n *\n * @remarks\n *\n * Requires the Warehouse API upgrade from your corporation.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29635,7 +29580,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#buyMaterial:member(1)",
"docComment": "",
"docComment": "/**\n * Set material buy data\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param materialName - Name of the material\n *\n * @param amt - Amount of material to buy\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29724,7 +29669,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#cancelExportMaterial:member(1)",
"docComment": "",
"docComment": "/**\n * Cancel material export\n *\n * @param sourceDivision - Source division\n *\n * @param sourceCity - Source city\n *\n * @param targetDivision - Target division\n *\n * @param targetCity - Target city\n *\n * @param materialName - Name of the material\n *\n * @param amt - Amount of material to export.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29843,7 +29788,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#discontinueProduct:member(1)",
"docComment": "",
"docComment": "/**\n * Discontinue a product.\n *\n * @param divisionName - Name of the division\n *\n * @param productName - Name of the product\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -29902,7 +29847,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#exportMaterial:member(1)",
"docComment": "",
"docComment": "/**\n * Set material export data\n *\n * @param sourceDivision - Source division\n *\n * @param sourceCity - Source city\n *\n * @param targetDivision - Target division\n *\n * @param targetCity - Target city\n *\n * @param materialName - Name of the material\n *\n * @param amt - Amount of material to export.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30021,7 +29966,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#getMaterial:member(1)",
"docComment": "",
"docComment": "/**\n * Get material data\n *\n * @param divisionName - Name of the division\n *\n * @param materialName - Name of the material\n *\n * @returns material data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30096,7 +30041,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#getProduct:member(1)",
"docComment": "",
"docComment": "/**\n * Get product data\n *\n * @param divisionName - Name of the division\n *\n * @param productName - Name of the product\n *\n * @returns product data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30156,7 +30101,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#getWarehouse:member(1)",
"docComment": "",
"docComment": "/**\n * Get warehouse data\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns warehouse data\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30216,7 +30161,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#makeProduct:member(1)",
"docComment": "",
"docComment": "/**\n * Create a new product\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param productName - Name of the product\n *\n * @param designInvest - Amount to invest for the design of the product.\n *\n * @param marketingInvest - Amount to invest for the marketing of the product.\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30320,7 +30265,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#purchaseWarehouse:member(1)",
"docComment": "",
"docComment": "/**\n * Purchase warehouse for a new city\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30379,7 +30324,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#sellMaterial:member(1)",
"docComment": "",
"docComment": "/**\n * Set material sell data.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param materialName - Name of the material\n *\n * @param amt - Amount to sell, can be \"MAX\"\n *\n * @param price - Price to sell, can be \"MP\"\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30411,7 +30356,7 @@
},
{
"kind": "Content",
"text": "number"
"text": "string"
},
{
"kind": "Content",
@ -30419,7 +30364,7 @@
},
{
"kind": "Content",
"text": "number"
"text": "string"
},
{
"kind": "Content",
@ -30483,7 +30428,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#sellProduct:member(1)",
"docComment": "",
"docComment": "/**\n * Set product sell data.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param productName - Name of the product\n *\n * @param amt - Amount to sell, can be \"MAX\"\n *\n * @param price - Price to sell, can be \"MP\"\n *\n * @param all - Sell in all city\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30515,7 +30460,7 @@
},
{
"kind": "Content",
"text": "number"
"text": "string"
},
{
"kind": "Content",
@ -30523,7 +30468,7 @@
},
{
"kind": "Content",
"text": "number"
"text": "string"
},
{
"kind": "Content",
@ -30602,7 +30547,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#setMaterialMarketTA1:member(1)",
"docComment": "",
"docComment": "/**\n * Set market TA 1 for a material.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param materialName - Name of the material\n *\n * @param on - market ta enabled\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30691,7 +30636,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#setMaterialMarketTA2:member(1)",
"docComment": "",
"docComment": "/**\n * Set market TA 2 for a material.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param materialName - Name of the material\n *\n * @param on - market ta enabled\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30780,7 +30725,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#setProductMarketTA1:member(1)",
"docComment": "",
"docComment": "/**\n * Set market TA 1 for a product.\n *\n * @param divisionName - Name of the division\n *\n * @param productName - Name of the product\n *\n * @param on - market ta enabled\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30854,7 +30799,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#setProductMarketTA2:member(1)",
"docComment": "",
"docComment": "/**\n * Set market TA 2 for a product.\n *\n * @param divisionName - Name of the division\n *\n * @param productName - Name of the product\n *\n * @param on - market ta enabled\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -30928,7 +30873,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#setSmartSupply:member(1)",
"docComment": "",
"docComment": "/**\n * Set smart supply\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param enabled - smart supply enabled\n */\n",
"excerptTokens": [
{
"kind": "Content",
@ -31002,7 +30947,7 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#upgradeWarehouse:member(1)",
"docComment": "",
"docComment": "/**\n * Upgrade warehouse\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n */\n",
"excerptTokens": [
{
"kind": "Content",

6
markdown/bitburner.corporation.expandcity.md
View File

@ -4,6 +4,8 @@
## Corporation.expandCity() method
Expand to a new city
<b>Signature:</b>
```typescript
@ -14,8 +16,8 @@ expandCity(divisionName: string, cityName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>

8
markdown/bitburner.corporation.expandindustry.md
View File

@ -4,18 +4,20 @@
## Corporation.expandIndustry() method
Expand to a new industry
<b>Signature:</b>
```typescript
expandIndustry(industryName: string, divisionName: string): void;
expandIndustry(industryType: string, divisionName: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryName | string | |
| divisionName | string | |
| industryType | string | Name of the industry |
| divisionName | string | Name of the division |
<b>Returns:</b>

4
markdown/bitburner.corporation.getcorporation.md
View File

@ -4,6 +4,8 @@
## Corporation.getCorporation() method
Get corporation data
<b>Signature:</b>
```typescript
@ -13,3 +15,5 @@ getCorporation(): CorporationInfo;
[CorporationInfo](./bitburner.corporationinfo.md)
Corporation data

6
markdown/bitburner.corporation.getdivision.md
View File

@ -4,6 +4,8 @@
## Corporation.getDivision() method
Get division data
<b>Signature:</b>
```typescript
@ -14,9 +16,11 @@ getDivision(divisionName: string): Division;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| divisionName | string | Name of the division |
<b>Returns:</b>
[Division](./bitburner.division.md)
Division data

4
markdown/bitburner.corporation.issuedividends.md
View File

@ -4,6 +4,8 @@
## Corporation.issueDividends() method
Issue dividends
<b>Signature:</b>
```typescript
@ -14,7 +16,7 @@ issueDividends(percent: number): void;
| Parameter | Type | Description |
| --- | --- | --- |
| percent | number | |
| percent | number | Percent of profit to issue as dividends. |
<b>Returns:</b>

4
markdown/bitburner.corporation.levelupgrade.md
View File

@ -4,6 +4,8 @@
## Corporation.levelUpgrade() method
Level an upgrade.
<b>Signature:</b>
```typescript
@ -14,7 +16,7 @@ levelUpgrade(upgradeName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| upgradeName | string | |
| upgradeName | string | Name of the upgrade |
<b>Returns:</b>

15
markdown/bitburner.corporation.md
View File

@ -4,6 +4,7 @@
## Corporation interface
Corporation API
<b>Signature:</b>
@ -16,11 +17,11 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| Method | Description |
| --- | --- |
| [expandCity(divisionName, cityName)](./bitburner.corporation.expandcity.md) | |
| [expandIndustry(industryName, divisionName)](./bitburner.corporation.expandindustry.md) | |
| [getCorporation()](./bitburner.corporation.getcorporation.md) | |
| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | |
| [issueDividends(percent)](./bitburner.corporation.issuedividends.md) | |
| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | |
| [unlockUpgrade(upgradeName)](./bitburner.corporation.unlockupgrade.md) | |
| [expandCity(divisionName, cityName)](./bitburner.corporation.expandcity.md) | Expand to a new city |
| [expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) | Expand to a new industry |
| [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data |
| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data |
| [issueDividends(percent)](./bitburner.corporation.issuedividends.md) | Issue dividends |
| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level an upgrade. |
| [unlockUpgrade(upgradeName)](./bitburner.corporation.unlockupgrade.md) | Unlock an upgrade. |

4
markdown/bitburner.corporation.unlockupgrade.md
View File

@ -4,6 +4,8 @@
## Corporation.unlockUpgrade() method
Unlock an upgrade.
<b>Signature:</b>
```typescript
@ -14,7 +16,7 @@ unlockUpgrade(upgradeName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| upgradeName | string | |
| upgradeName | string | Name of the upgrade |
<b>Returns:</b>

2
markdown/bitburner.corporationinfo.expenses.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.expenses property
Expenses per second this cycle
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.funds.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.funds property
Funds available
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.issuedshares.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.issuedShares property
Amount of shares issued
<b>Signature:</b>
```typescript

23
markdown/bitburner.corporationinfo.md
View File

@ -4,6 +4,7 @@
## CorporationInfo interface
General info about a corporation
<b>Signature:</b>
@ -15,15 +16,15 @@ interface CorporationInfo
| Property | Type | Description |
| --- | --- | --- |
| [expenses](./bitburner.corporationinfo.expenses.md) | number | |
| [funds](./bitburner.corporationinfo.funds.md) | number | |
| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | |
| [name](./bitburner.corporationinfo.name.md) | string | |
| [numShares](./bitburner.corporationinfo.numshares.md) | number | |
| [public](./bitburner.corporationinfo.public.md) | boolean | |
| [revenue](./bitburner.corporationinfo.revenue.md) | number | |
| [sharePrice](./bitburner.corporationinfo.shareprice.md) | number | |
| [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) | number | |
| [state](./bitburner.corporationinfo.state.md) | string | |
| [totalShares](./bitburner.corporationinfo.totalshares.md) | number | |
| [expenses](./bitburner.corporationinfo.expenses.md) | number | Expenses per second this cycle |
| [funds](./bitburner.corporationinfo.funds.md) | number | Funds available |
| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of shares issued |
| [name](./bitburner.corporationinfo.name.md) | string | Name of the corporation |
| [numShares](./bitburner.corporationinfo.numshares.md) | number | Amount of share owned |
| [public](./bitburner.corporationinfo.public.md) | boolean | Is the company is public |
| [revenue](./bitburner.corporationinfo.revenue.md) | number | Revenue per second this cycle |
| [sharePrice](./bitburner.corporationinfo.shareprice.md) | number | Price of the shares |
| [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) | number | Cooldown until shares can be sold again |
| [state](./bitburner.corporationinfo.state.md) | string | State of the corporation, like PRODUCTION or EXPORT |
| [totalShares](./bitburner.corporationinfo.totalshares.md) | number | Total number of shares issues by this corporation |

2
markdown/bitburner.corporationinfo.name.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.name property
Name of the corporation
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.numshares.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.numShares property
Amount of share owned
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.public.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.public property
Is the company is public
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.revenue.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.revenue property
Revenue per second this cycle
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.shareprice.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.sharePrice property
Price of the shares
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.sharesalecooldown.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.shareSaleCooldown property
Cooldown until shares can be sold again
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.state.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.state property
State of the corporation, like PRODUCTION or EXPORT
<b>Signature:</b>
```typescript

2
markdown/bitburner.corporationinfo.totalshares.md
View File

@ -4,6 +4,8 @@
## CorporationInfo.totalShares property
Total number of shares issues by this corporation
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.awareness.md
View File

@ -4,6 +4,8 @@
## Division.awareness property
Awareness of the division
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.cities.md
View File

@ -4,6 +4,8 @@
## Division.cities property
Cities in which this division has expanded
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.lastcycleexpenses.md
View File

@ -4,6 +4,8 @@
## Division.lastCycleExpenses property
Expenses last cycle
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.lastcyclerevenue.md
View File

@ -4,6 +4,8 @@
## Division.lastCycleRevenue property
Revenue last cycle
<b>Signature:</b>
```typescript

25
markdown/bitburner.division.md
View File

@ -4,6 +4,7 @@
## Division interface
Corporation division
<b>Signature:</b>
@ -15,16 +16,16 @@ interface Division
| Property | Type | Description |
| --- | --- | --- |
| [awareness](./bitburner.division.awareness.md) | number | |
| [cities](./bitburner.division.cities.md) | string\[\] | |
| [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | number | |
| [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | number | |
| [name](./bitburner.division.name.md) | string | |
| [popularity](./bitburner.division.popularity.md) | number | |
| [prodMult](./bitburner.division.prodmult.md) | number | |
| [research](./bitburner.division.research.md) | number | |
| [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) | number | |
| [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) | number | |
| [type](./bitburner.division.type.md) | string | |
| [upgrades](./bitburner.division.upgrades.md) | number\[\] | |
| [awareness](./bitburner.division.awareness.md) | number | Awareness of the division |
| [cities](./bitburner.division.cities.md) | string\[\] | Cities in which this division has expanded |
| [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | number | Expenses last cycle |
| [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | number | Revenue last cycle |
| [name](./bitburner.division.name.md) | string | Name of the division |
| [popularity](./bitburner.division.popularity.md) | number | Popularity of the division |
| [prodMult](./bitburner.division.prodmult.md) | number | Production multiplier |
| [research](./bitburner.division.research.md) | number | Amount of research in that division |
| [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) | number | Expenses this cycle |
| [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) | number | Revenue this cycle |
| [type](./bitburner.division.type.md) | string | Type of division, like Aggriculture |
| [upgrades](./bitburner.division.upgrades.md) | number\[\] | All research bought |

2
markdown/bitburner.division.name.md
View File

@ -4,6 +4,8 @@
## Division.name property
Name of the division
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.popularity.md
View File

@ -4,6 +4,8 @@
## Division.popularity property
Popularity of the division
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.prodmult.md
View File

@ -4,6 +4,8 @@
## Division.prodMult property
Production multiplier
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.research.md
View File

@ -4,6 +4,8 @@
## Division.research property
Amount of research in that division
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.thiscycleexpenses.md
View File

@ -4,6 +4,8 @@
## Division.thisCycleExpenses property
Expenses this cycle
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.thiscyclerevenue.md
View File

@ -4,6 +4,8 @@
## Division.thisCycleRevenue property
Revenue this cycle
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.type.md
View File

@ -4,6 +4,8 @@
## Division.type property
Type of division, like Aggriculture
<b>Signature:</b>
```typescript

2
markdown/bitburner.division.upgrades.md
View File

@ -4,6 +4,8 @@
## Division.upgrades property
All research bought
<b>Signature:</b>
```typescript

2
markdown/bitburner.employee.ene.md
View File

@ -4,6 +4,8 @@
## Employee.ene property
Energy
<b>Signature:</b>
```typescript

2
markdown/bitburner.employee.hap.md
View File

@ -4,6 +4,8 @@
## Employee.hap property
Happiness
<b>Signature:</b>
```typescript

2
markdown/bitburner.employee.loc.md
View File

@ -4,6 +4,8 @@
## Employee.loc property
City
<b>Signature:</b>
```typescript

15
markdown/bitburner.employee.md
View File

@ -4,6 +4,7 @@
## Employee interface
Employee in an office
<b>Signature:</b>
@ -18,13 +19,13 @@ interface Employee
| [cha](./bitburner.employee.cha.md) | number | |
| [cre](./bitburner.employee.cre.md) | number | |
| [eff](./bitburner.employee.eff.md) | number | |
| [ene](./bitburner.employee.ene.md) | number | |
| [ene](./bitburner.employee.ene.md) | number | Energy |
| [exp](./bitburner.employee.exp.md) | number | |
| [hap](./bitburner.employee.hap.md) | number | |
| [hap](./bitburner.employee.hap.md) | number | Happiness |
| [int](./bitburner.employee.int.md) | number | |
| [loc](./bitburner.employee.loc.md) | string | |
| [mor](./bitburner.employee.mor.md) | number | |
| [name](./bitburner.employee.name.md) | string | |
| [pos](./bitburner.employee.pos.md) | string | |
| [sal](./bitburner.employee.sal.md) | number | |
| [loc](./bitburner.employee.loc.md) | string | City |
| [mor](./bitburner.employee.mor.md) | number | Morale |
| [name](./bitburner.employee.name.md) | string | Name of the employee |
| [pos](./bitburner.employee.pos.md) | string | Current job |
| [sal](./bitburner.employee.sal.md) | number | Salary |

2
markdown/bitburner.employee.mor.md
View File

@ -4,6 +4,8 @@
## Employee.mor property
Morale
<b>Signature:</b>
```typescript

2
markdown/bitburner.employee.name.md
View File

@ -4,6 +4,8 @@
## Employee.name property
Name of the employee
<b>Signature:</b>
```typescript

2
markdown/bitburner.employee.pos.md
View File

@ -4,6 +4,8 @@
## Employee.pos property
Current job
<b>Signature:</b>
```typescript

2
markdown/bitburner.employee.sal.md
View File

@ -4,6 +4,8 @@
## Employee.sal property
Salary
<b>Signature:</b>
```typescript

1
markdown/bitburner.employeejobs.md
View File

@ -4,6 +4,7 @@
## EmployeeJobs interface
Object representing the number of employee in each job.
<b>Signature:</b>

7
markdown/bitburner.material.md
View File

@ -4,6 +4,7 @@
## Material interface
Material in a warehouse
<b>Signature:</b>
@ -15,7 +16,7 @@ interface Material
| Property | Type | Description |
| --- | --- | --- |
| [name](./bitburner.material.name.md) | string | |
| [qlt](./bitburner.material.qlt.md) | number | |
| [qty](./bitburner.material.qty.md) | number | |
| [name](./bitburner.material.name.md) | string | Name of the material |
| [qlt](./bitburner.material.qlt.md) | number | Quality of the material |
| [qty](./bitburner.material.qty.md) | number | Amount of material |

2
markdown/bitburner.material.name.md
View File

@ -4,6 +4,8 @@
## Material.name property
Name of the material
<b>Signature:</b>
```typescript

2
markdown/bitburner.material.qlt.md
View File

@ -4,6 +4,8 @@
## Material.qlt property
Quality of the material
<b>Signature:</b>
```typescript

2
markdown/bitburner.material.qty.md
View File

@ -4,6 +4,8 @@
## Material.qty property
Amount of material
<b>Signature:</b>
```typescript

22
markdown/bitburner.md
View File

@ -19,12 +19,12 @@
| [CharacterMult](./bitburner.charactermult.md) | |
| [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt. |
| [CodingContract](./bitburner.codingcontract.md) | Coding Contact API |
| [Corporation](./bitburner.corporation.md) | |
| [CorporationInfo](./bitburner.corporationinfo.md) | |
| [Corporation](./bitburner.corporation.md) | Corporation API |
| [CorporationInfo](./bitburner.corporationinfo.md) | General info about a corporation |
| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. |
| [Division](./bitburner.division.md) | |
| [Employee](./bitburner.employee.md) | |
| [EmployeeJobs](./bitburner.employeejobs.md) | |
| [Division](./bitburner.division.md) | Corporation division |
| [Employee](./bitburner.employee.md) | Employee in an office |
| [EmployeeJobs](./bitburner.employeejobs.md) | Object representing the number of employee in each job. |
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
| [Formulas](./bitburner.formulas.md) | Formulas API |
| [Fragment](./bitburner.fragment.md) | |
@ -43,15 +43,15 @@
| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. |
| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
| [Material](./bitburner.material.md) | |
| [Material](./bitburner.material.md) | Material in a warehouse |
| [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. |
| [NS](./bitburner.ns.md) | Collection of all functions passed to scripts |
| [Office](./bitburner.office.md) | |
| [OfficeAPI](./bitburner.officeapi.md) | |
| [Office](./bitburner.office.md) | Office for a division in a city. |
| [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API |
| [Player](./bitburner.player.md) | |
| [PlayerSkills](./bitburner.playerskills.md) | Short summary of the players skills. |
| [ProcessInfo](./bitburner.processinfo.md) | A single process on a server. |
| [Product](./bitburner.product.md) | |
| [Product](./bitburner.product.md) | Product in a warehouse |
| [RunningScript](./bitburner.runningscript.md) | |
| [Server](./bitburner.server.md) | A single server. |
| [Singularity](./bitburner.singularity.md) | Singularity API |
@ -66,6 +66,6 @@
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md) |
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
| [TIX](./bitburner.tix.md) | Stock market API |
| [Warehouse](./bitburner.warehouse.md) | |
| [WarehouseAPI](./bitburner.warehouseapi.md) | |
| [Warehouse](./bitburner.warehouse.md) | Warehouse for a division in a city |
| [WarehouseAPI](./bitburner.warehouseapi.md) | Corporation Warehouse API |

2
markdown/bitburner.office.employeeprod.md
View File

@ -4,6 +4,8 @@
## Office.employeeProd property
Positions of the employees
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.employees.md
View File

@ -4,6 +4,8 @@
## Office.employees property
Name of all the employees
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.loc.md
View File

@ -4,6 +4,8 @@
## Office.loc property
City of the office
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.maxene.md
View File

@ -4,6 +4,8 @@
## Office.maxEne property
Maximum amount of energy of the employees
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.maxhap.md
View File

@ -4,6 +4,8 @@
## Office.maxHap property
Maximum happiness of the employees
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.maxmor.md
View File

@ -4,6 +4,8 @@
## Office.maxMor property
Maximum morale of the employees
<b>Signature:</b>
```typescript

19
markdown/bitburner.office.md
View File

@ -4,6 +4,7 @@
## Office interface
Office for a division in a city.
<b>Signature:</b>
@ -15,13 +16,13 @@ interface Office
| Property | Type | Description |
| --- | --- | --- |
| [employeeProd](./bitburner.office.employeeprod.md) | [EmployeeJobs](./bitburner.employeejobs.md) | |
| [employees](./bitburner.office.employees.md) | string\[\] | |
| [loc](./bitburner.office.loc.md) | string | |
| [maxEne](./bitburner.office.maxene.md) | number | |
| [maxHap](./bitburner.office.maxhap.md) | number | |
| [maxMor](./bitburner.office.maxmor.md) | number | |
| [minEne](./bitburner.office.minene.md) | number | |
| [minHap](./bitburner.office.minhap.md) | number | |
| [size](./bitburner.office.size.md) | number | |
| [employeeProd](./bitburner.office.employeeprod.md) | [EmployeeJobs](./bitburner.employeejobs.md) | Positions of the employees |
| [employees](./bitburner.office.employees.md) | string\[\] | Name of all the employees |
| [loc](./bitburner.office.loc.md) | string | City of the office |
| [maxEne](./bitburner.office.maxene.md) | number | Maximum amount of energy of the employees |
| [maxHap](./bitburner.office.maxhap.md) | number | Maximum happiness of the employees |
| [maxMor](./bitburner.office.maxmor.md) | number | Maximum morale of the employees |
| [minEne](./bitburner.office.minene.md) | number | Minimum amount of energy of the employees |
| [minHap](./bitburner.office.minhap.md) | number | Minimum happiness of the employees |
| [size](./bitburner.office.size.md) | number | Maximum number of employee |

2
markdown/bitburner.office.minene.md
View File

@ -4,6 +4,8 @@
## Office.minEne property
Minimum amount of energy of the employees
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.minhap.md
View File

@ -4,6 +4,8 @@
## Office.minHap property
Minimum happiness of the employees
<b>Signature:</b>
```typescript

2
markdown/bitburner.office.size.md
View File

@ -4,6 +4,8 @@
## Office.size property
Maximum number of employee
<b>Signature:</b>
```typescript

12
markdown/bitburner.officeapi.assignjob.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.assignJob() method
Assign an employee to a job.
<b>Signature:</b>
```typescript
@ -14,12 +16,14 @@ assignJob(divisionName: string, cityName: string, employeeName: string, job: str
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| employeeName | string | |
| job | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| employeeName | string | name of the employee |
| job | string | Name of the job. |
<b>Returns:</b>
Promise&lt;void&gt;
A promise that is fulfilled when the assignment is complete.

8
markdown/bitburner.officeapi.buycoffee.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.buyCoffee() method
Buy coffee for your employees
<b>Signature:</b>
```typescript
@ -14,10 +16,12 @@ buyCoffee(divisionName: string, cityName: string): Promise<void>;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>
Promise&lt;void&gt;
A promise that is fulfilled when the coffee is served.

23
markdown/bitburner.officeapi.employees.md
View File

@ -1,23 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OfficeAPI](./bitburner.officeapi.md) &gt; [employees](./bitburner.officeapi.employees.md)
## OfficeAPI.employees() method
<b>Signature:</b>
```typescript
employees(divisionName: string, cityName: string): string[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
<b>Returns:</b>
string\[\]

10
markdown/bitburner.officeapi.getemployee.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.getEmployee() method
Get data about an employee
<b>Signature:</b>
```typescript
@ -14,11 +16,13 @@ getEmployee(divisionName: string, cityName: string, employeeName: string): Emplo
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| employeeName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| employeeName | string | Name of the employee |
<b>Returns:</b>
[Employee](./bitburner.employee.md)
Employee data

8
markdown/bitburner.officeapi.getoffice.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.getOffice() method
Get data about an office
<b>Signature:</b>
```typescript
@ -14,10 +16,12 @@ getOffice(divisionName: string, cityName: string): Office;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>
[Office](./bitburner.office.md)
Office data

4
markdown/bitburner.officeapi.hireadvert.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.hireAdVert() method
Hire AdVert.
<b>Signature:</b>
```typescript
@ -14,7 +16,7 @@ hireAdVert(divisionName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| divisionName | string | Name of the division |
<b>Returns:</b>

12
markdown/bitburner.officeapi.hireemployee.md
View File

@ -4,20 +4,24 @@
## OfficeAPI.hireEmployee() method
Assign an employee to a job.
<b>Signature:</b>
```typescript
hireEmployee(divisionName: string, cityName: string): Employee;
hireEmployee(divisionName: string, cityName: string): Employee | undefined;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>
[Employee](./bitburner.employee.md)
[Employee](./bitburner.employee.md) \| undefined
The newly hired employee, if any

24
markdown/bitburner.officeapi.md
View File

@ -4,6 +4,7 @@
## OfficeAPI interface
Corporation Office API
<b>Signature:</b>
@ -11,18 +12,21 @@
export interface OfficeAPI
```
## Remarks
Requires the Office API upgrade from your corporation.
## Methods
| Method | Description |
| --- | --- |
| [assignJob(divisionName, cityName, employeeName, job)](./bitburner.officeapi.assignjob.md) | |
| [buyCoffee(divisionName, cityName)](./bitburner.officeapi.buycoffee.md) | |
| [employees(divisionName, cityName)](./bitburner.officeapi.employees.md) | |
| [getEmployee(divisionName, cityName, employeeName)](./bitburner.officeapi.getemployee.md) | |
| [getOffice(divisionName, cityName)](./bitburner.officeapi.getoffice.md) | |
| [hireAdVert(divisionName)](./bitburner.officeapi.hireadvert.md) | |
| [hireEmployee(divisionName, cityName)](./bitburner.officeapi.hireemployee.md) | |
| [research(divisionName, researchName)](./bitburner.officeapi.research.md) | |
| [throwParty(divisionName, cityName, costPerEmployee)](./bitburner.officeapi.throwparty.md) | |
| [upgradeOfficeSize(divisionName, cityName, size)](./bitburner.officeapi.upgradeofficesize.md) | |
| [assignJob(divisionName, cityName, employeeName, job)](./bitburner.officeapi.assignjob.md) | Assign an employee to a job. |
| [buyCoffee(divisionName, cityName)](./bitburner.officeapi.buycoffee.md) | Buy coffee for your employees |
| [getEmployee(divisionName, cityName, employeeName)](./bitburner.officeapi.getemployee.md) | Get data about an employee |
| [getOffice(divisionName, cityName)](./bitburner.officeapi.getoffice.md) | Get data about an office |
| [hireAdVert(divisionName)](./bitburner.officeapi.hireadvert.md) | Hire AdVert. |
| [hireEmployee(divisionName, cityName)](./bitburner.officeapi.hireemployee.md) | Assign an employee to a job. |
| [research(divisionName, researchName)](./bitburner.officeapi.research.md) | Hire AdVert. |
| [throwParty(divisionName, cityName, costPerEmployee)](./bitburner.officeapi.throwparty.md) | Assign an employee to a job. |
| [upgradeOfficeSize(divisionName, cityName, size)](./bitburner.officeapi.upgradeofficesize.md) | Upgrade office size. |

6
markdown/bitburner.officeapi.research.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.research() method
Hire AdVert.
<b>Signature:</b>
```typescript
@ -14,8 +16,8 @@ research(divisionName: string, researchName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| researchName | string | |
| divisionName | string | Name of the division |
| researchName | string | Name of the research |
<b>Returns:</b>

10
markdown/bitburner.officeapi.throwparty.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.throwParty() method
Assign an employee to a job.
<b>Signature:</b>
```typescript
@ -14,11 +16,13 @@ throwParty(divisionName: string, cityName: string, costPerEmployee: number): Pro
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| costPerEmployee | number | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| costPerEmployee | number | Amount to spend per employee. |
<b>Returns:</b>
Promise&lt;number&gt;
Amount of happiness increased.

8
markdown/bitburner.officeapi.upgradeofficesize.md
View File

@ -4,6 +4,8 @@
## OfficeAPI.upgradeOfficeSize() method
Upgrade office size.
<b>Signature:</b>
```typescript
@ -14,9 +16,9 @@ upgradeOfficeSize(divisionName: string, cityName: string, size: number): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| size | number | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| size | number | Amount of positions to open |
<b>Returns:</b>

2
markdown/bitburner.product.cmp.md
View File

@ -4,6 +4,8 @@
## Product.cmp property
Competition for the product
<b>Signature:</b>
```typescript

2
markdown/bitburner.product.dmd.md
View File

@ -4,6 +4,8 @@
## Product.dmd property
Demand for the product
<b>Signature:</b>
```typescript

11
markdown/bitburner.product.md
View File

@ -4,6 +4,7 @@
## Product interface
Product in a warehouse
<b>Signature:</b>
@ -15,9 +16,9 @@ interface Product
| Property | Type | Description |
| --- | --- | --- |
| [cmp](./bitburner.product.cmp.md) | number | |
| [dmd](./bitburner.product.dmd.md) | number | |
| [name](./bitburner.product.name.md) | string | |
| [pCost](./bitburner.product.pcost.md) | number | |
| [sCost](./bitburner.product.scost.md) | string \| number | |
| [cmp](./bitburner.product.cmp.md) | number | Competition for the product |
| [dmd](./bitburner.product.dmd.md) | number | Demand for the product |
| [name](./bitburner.product.name.md) | string | Name of the product |
| [pCost](./bitburner.product.pcost.md) | number | Production cost |
| [sCost](./bitburner.product.scost.md) | string \| number | Sell cost, can be "MP+5" |

2
markdown/bitburner.product.name.md
View File

@ -4,6 +4,8 @@
## Product.name property
Name of the product
<b>Signature:</b>
```typescript

2
markdown/bitburner.product.pcost.md
View File

@ -4,6 +4,8 @@
## Product.pCost property
Production cost
<b>Signature:</b>
```typescript

2
markdown/bitburner.product.scost.md
View File

@ -4,6 +4,8 @@
## Product.sCost property
Sell cost, can be "MP+5"
<b>Signature:</b>
```typescript

2
markdown/bitburner.warehouse.level.md
View File

@ -4,6 +4,8 @@
## Warehouse.level property
Amount of size upgrade bought
<b>Signature:</b>
```typescript

2
markdown/bitburner.warehouse.loc.md
View File

@ -4,6 +4,8 @@
## Warehouse.loc property
City in which the warehouse is located
<b>Signature:</b>
```typescript

9
markdown/bitburner.warehouse.md
View File

@ -4,6 +4,7 @@
## Warehouse interface
Warehouse for a division in a city
<b>Signature:</b>
@ -15,8 +16,8 @@ interface Warehouse
| Property | Type | Description |
| --- | --- | --- |
| [level](./bitburner.warehouse.level.md) | number | |
| [loc](./bitburner.warehouse.loc.md) | string | |
| [size](./bitburner.warehouse.size.md) | number | |
| [sizeUsed](./bitburner.warehouse.sizeused.md) | number | |
| [level](./bitburner.warehouse.level.md) | number | Amount of size upgrade bought |
| [loc](./bitburner.warehouse.loc.md) | string | City in which the warehouse is located |
| [size](./bitburner.warehouse.size.md) | number | Total space in the warehouse |
| [sizeUsed](./bitburner.warehouse.sizeused.md) | number | Used space in the warehouse |

2
markdown/bitburner.warehouse.size.md
View File

@ -4,6 +4,8 @@
## Warehouse.size property
Total space in the warehouse
<b>Signature:</b>
```typescript

2
markdown/bitburner.warehouse.sizeused.md
View File

@ -4,6 +4,8 @@
## Warehouse.sizeUsed property
Used space in the warehouse
<b>Signature:</b>
```typescript

10
markdown/bitburner.warehouseapi.buymaterial.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.buyMaterial() method
Set material buy data
<b>Signature:</b>
```typescript
@ -14,10 +16,10 @@ buyMaterial(divisionName: string, cityName: string, materialName: string, amt: n
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| materialName | string | |
| amt | number | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| materialName | string | Name of the material |
| amt | number | Amount of material to buy |
<b>Returns:</b>

14
markdown/bitburner.warehouseapi.cancelexportmaterial.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.cancelExportMaterial() method
Cancel material export
<b>Signature:</b>
```typescript
@ -21,12 +23,12 @@ cancelExportMaterial(
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDivision | string | |
| sourceCity | string | |
| targetDivision | string | |
| targetCity | string | |
| materialName | string | |
| amt | number | |
| sourceDivision | string | Source division |
| sourceCity | string | Source city |
| targetDivision | string | Target division |
| targetCity | string | Target city |
| materialName | string | Name of the material |
| amt | number | Amount of material to export. |
<b>Returns:</b>

6
markdown/bitburner.warehouseapi.discontinueproduct.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.discontinueProduct() method
Discontinue a product.
<b>Signature:</b>
```typescript
@ -14,8 +16,8 @@ discontinueProduct(divisionName: string, productName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| productName | string | |
| divisionName | string | Name of the division |
| productName | string | Name of the product |
<b>Returns:</b>

14
markdown/bitburner.warehouseapi.exportmaterial.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.exportMaterial() method
Set material export data
<b>Signature:</b>
```typescript
@ -21,12 +23,12 @@ exportMaterial(
| Parameter | Type | Description |
| --- | --- | --- |
| sourceDivision | string | |
| sourceCity | string | |
| targetDivision | string | |
| targetCity | string | |
| materialName | string | |
| amt | number | |
| sourceDivision | string | Source division |
| sourceCity | string | Source city |
| targetDivision | string | Target division |
| targetCity | string | Target city |
| materialName | string | Name of the material |
| amt | number | Amount of material to export. |
<b>Returns:</b>

8
markdown/bitburner.warehouseapi.getmaterial.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.getMaterial() method
Get material data
<b>Signature:</b>
```typescript
@ -14,11 +16,13 @@ getMaterial(divisionName: string, cityName: string, materialName: string): Mater
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| divisionName | string | Name of the division |
| cityName | string | |
| materialName | string | |
| materialName | string | Name of the material |
<b>Returns:</b>
[Material](./bitburner.material.md)
material data

8
markdown/bitburner.warehouseapi.getproduct.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.getProduct() method
Get product data
<b>Signature:</b>
```typescript
@ -14,10 +16,12 @@ getProduct(divisionName: string, productName: string): Product;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| productName | string | |
| divisionName | string | Name of the division |
| productName | string | Name of the product |
<b>Returns:</b>
[Product](./bitburner.product.md)
product data

8
markdown/bitburner.warehouseapi.getwarehouse.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.getWarehouse() method
Get warehouse data
<b>Signature:</b>
```typescript
@ -14,10 +16,12 @@ getWarehouse(divisionName: string, cityName: string): Warehouse;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>
[Warehouse](./bitburner.warehouse.md)
warehouse data

12
markdown/bitburner.warehouseapi.makeproduct.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.makeProduct() method
Create a new product
<b>Signature:</b>
```typescript
@ -20,11 +22,11 @@ makeProduct(
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| productName | string | |
| designInvest | number | |
| marketingInvest | number | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| productName | string | Name of the product |
| designInvest | number | Amount to invest for the design of the product. |
| marketingInvest | number | Amount to invest for the marketing of the product. |
<b>Returns:</b>

39
markdown/bitburner.warehouseapi.md
View File

@ -4,6 +4,7 @@
## WarehouseAPI interface
Corporation Warehouse API
<b>Signature:</b>
@ -11,25 +12,29 @@
export interface WarehouseAPI
```
## Remarks
Requires the Warehouse API upgrade from your corporation.
## Methods
| Method | Description |
| --- | --- |
| [buyMaterial(divisionName, cityName, materialName, amt)](./bitburner.warehouseapi.buymaterial.md) | |
| [cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.cancelexportmaterial.md) | |
| [discontinueProduct(divisionName, productName)](./bitburner.warehouseapi.discontinueproduct.md) | |
| [exportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.exportmaterial.md) | |
| [getMaterial(divisionName, cityName, materialName)](./bitburner.warehouseapi.getmaterial.md) | |
| [getProduct(divisionName, productName)](./bitburner.warehouseapi.getproduct.md) | |
| [getWarehouse(divisionName, cityName)](./bitburner.warehouseapi.getwarehouse.md) | |
| [makeProduct(divisionName, cityName, productName, designInvest, marketingInvest)](./bitburner.warehouseapi.makeproduct.md) | |
| [purchaseWarehouse(divisionName, cityName)](./bitburner.warehouseapi.purchasewarehouse.md) | |
| [sellMaterial(divisionName, cityName, materialName, amt, price)](./bitburner.warehouseapi.sellmaterial.md) | |
| [sellProduct(divisionName, cityName, productName, amt, price, all)](./bitburner.warehouseapi.sellproduct.md) | |
| [setMaterialMarketTA1(divisionName, cityName, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta1.md) | |
| [setMaterialMarketTA2(divisionName, cityName, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta2.md) | |
| [setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md) | |
| [setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md) | |
| [setSmartSupply(divisionName, cityName, enabled)](./bitburner.warehouseapi.setsmartsupply.md) | |
| [upgradeWarehouse(divisionName, cityName)](./bitburner.warehouseapi.upgradewarehouse.md) | |
| [buyMaterial(divisionName, cityName, materialName, amt)](./bitburner.warehouseapi.buymaterial.md) | Set material buy data |
| [cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.cancelexportmaterial.md) | Cancel material export |
| [discontinueProduct(divisionName, productName)](./bitburner.warehouseapi.discontinueproduct.md) | Discontinue a product. |
| [exportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.exportmaterial.md) | Set material export data |
| [getMaterial(divisionName, cityName, materialName)](./bitburner.warehouseapi.getmaterial.md) | Get material data |
| [getProduct(divisionName, productName)](./bitburner.warehouseapi.getproduct.md) | Get product data |
| [getWarehouse(divisionName, cityName)](./bitburner.warehouseapi.getwarehouse.md) | Get warehouse data |
| [makeProduct(divisionName, cityName, productName, designInvest, marketingInvest)](./bitburner.warehouseapi.makeproduct.md) | Create a new product |
| [purchaseWarehouse(divisionName, cityName)](./bitburner.warehouseapi.purchasewarehouse.md) | Purchase warehouse for a new city |
| [sellMaterial(divisionName, cityName, materialName, amt, price)](./bitburner.warehouseapi.sellmaterial.md) | Set material sell data. |
| [sellProduct(divisionName, cityName, productName, amt, price, all)](./bitburner.warehouseapi.sellproduct.md) | Set product sell data. |
| [setMaterialMarketTA1(divisionName, cityName, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta1.md) | Set market TA 1 for a material. |
| [setMaterialMarketTA2(divisionName, cityName, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta2.md) | Set market TA 2 for a material. |
| [setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md) | Set market TA 1 for a product. |
| [setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md) | Set market TA 2 for a product. |
| [setSmartSupply(divisionName, cityName, enabled)](./bitburner.warehouseapi.setsmartsupply.md) | Set smart supply |
| [upgradeWarehouse(divisionName, cityName)](./bitburner.warehouseapi.upgradewarehouse.md) | Upgrade warehouse |

6
markdown/bitburner.warehouseapi.purchasewarehouse.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.purchaseWarehouse() method
Purchase warehouse for a new city
<b>Signature:</b>
```typescript
@ -14,8 +16,8 @@ purchaseWarehouse(divisionName: string, cityName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>

14
markdown/bitburner.warehouseapi.sellmaterial.md
View File

@ -4,21 +4,23 @@
## WarehouseAPI.sellMaterial() method
Set material sell data.
<b>Signature:</b>
```typescript
sellMaterial(divisionName: string, cityName: string, materialName: string, amt: number, price: number): void;
sellMaterial(divisionName: string, cityName: string, materialName: string, amt: string, price: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| materialName | string | |
| amt | number | |
| price | number | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| materialName | string | Name of the material |
| amt | string | Amount to sell, can be "MAX" |
| price | string | Price to sell, can be "MP" |
<b>Returns:</b>

18
markdown/bitburner.warehouseapi.sellproduct.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.sellProduct() method
Set product sell data.
<b>Signature:</b>
```typescript
@ -11,8 +13,8 @@ sellProduct(
divisionName: string,
cityName: string,
productName: string,
amt: number,
price: number,
amt: string,
price: string,
all: boolean,
): void;
```
@ -21,12 +23,12 @@ sellProduct(
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| productName | string | |
| amt | number | |
| price | number | |
| all | boolean | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| productName | string | Name of the product |
| amt | string | Amount to sell, can be "MAX" |
| price | string | Price to sell, can be "MP" |
| all | boolean | Sell in all city |
<b>Returns:</b>

10
markdown/bitburner.warehouseapi.setmaterialmarketta1.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.setMaterialMarketTA1() method
Set market TA 1 for a material.
<b>Signature:</b>
```typescript
@ -14,10 +16,10 @@ setMaterialMarketTA1(divisionName: string, cityName: string, materialName: strin
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| materialName | string | |
| on | boolean | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| materialName | string | Name of the material |
| on | boolean | market ta enabled |
<b>Returns:</b>

10
markdown/bitburner.warehouseapi.setmaterialmarketta2.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.setMaterialMarketTA2() method
Set market TA 2 for a material.
<b>Signature:</b>
```typescript
@ -14,10 +16,10 @@ setMaterialMarketTA2(divisionName: string, cityName: string, materialName: strin
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| materialName | string | |
| on | boolean | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| materialName | string | Name of the material |
| on | boolean | market ta enabled |
<b>Returns:</b>

8
markdown/bitburner.warehouseapi.setproductmarketta1.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.setProductMarketTA1() method
Set market TA 1 for a product.
<b>Signature:</b>
```typescript
@ -14,9 +16,9 @@ setProductMarketTA1(divisionName: string, productName: string, on: boolean): voi
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| productName | string | |
| on | boolean | |
| divisionName | string | Name of the division |
| productName | string | Name of the product |
| on | boolean | market ta enabled |
<b>Returns:</b>

8
markdown/bitburner.warehouseapi.setproductmarketta2.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.setProductMarketTA2() method
Set market TA 2 for a product.
<b>Signature:</b>
```typescript
@ -14,9 +16,9 @@ setProductMarketTA2(divisionName: string, productName: string, on: boolean): voi
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| productName | string | |
| on | boolean | |
| divisionName | string | Name of the division |
| productName | string | Name of the product |
| on | boolean | market ta enabled |
<b>Returns:</b>

8
markdown/bitburner.warehouseapi.setsmartsupply.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.setSmartSupply() method
Set smart supply
<b>Signature:</b>
```typescript
@ -14,9 +16,9 @@ setSmartSupply(divisionName: string, cityName: string, enabled: boolean): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| enabled | boolean | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| enabled | boolean | smart supply enabled |
<b>Returns:</b>

6
markdown/bitburner.warehouseapi.upgradewarehouse.md
View File

@ -4,6 +4,8 @@
## WarehouseAPI.upgradeWarehouse() method
Upgrade warehouse
<b>Signature:</b>
```typescript
@ -14,8 +16,8 @@ upgradeWarehouse(divisionName: string, cityName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | |
| cityName | string | |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
<b>Returns:</b>

9
src/NetscriptFunctions/Corporation.ts
View File

@ -303,13 +303,6 @@ export function NetscriptCorporation(
};
const officeAPI: OfficeAPI = {
employees: function (adivisionName: any, acityName: any): any {
checkAccess("employees", 8);
const divisionName = helper.string("employees", "divisionName", adivisionName);
const cityName = helper.string("employees", "cityName", acityName);
const office = getOffice(divisionName, cityName);
return office.employees.map((e) => Object.assign({}, e));
},
assignJob: function (adivisionName: any, acityName: any, aemployeeName: any, ajob: any): Promise<void> {
checkAccess("assignJob", 8);
const divisionName = helper.string("assignJob", "divisionName", adivisionName);
@ -326,7 +319,7 @@ export function NetscriptCorporation(
const divisionName = helper.string("hireEmployee", "divisionName", adivisionName);
const cityName = helper.string("hireEmployee", "cityName", acityName);
const office = getOffice(divisionName, cityName);
office.hireRandomEmployee();
return office.hireRandomEmployee();
},
upgradeOfficeSize: function (adivisionName: any, acityName: any, asize: any): void {
checkAccess("upgradeOfficeSize", 8);

Some files were not shown because too many files have changed in this diff Show More