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.
This commit is contained in:
Snarling 2022-11-20 12:07:22 -05:00 committed by GitHub
parent 88d51e9a7e
commit 65cd14e33b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
369 changed files with 2767 additions and 2449 deletions

1397
dist/bitburner.d.ts vendored

File diff suppressed because it is too large Load Diff

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface ActiveFragment
interface ActiveFragment
```
## Properties

@ -9,7 +9,7 @@ Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasab
<b>Signature:</b>
```typescript
export interface AugmentPair
interface AugmentPair
```
## Properties

@ -9,7 +9,7 @@ Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow]
<b>Signature:</b>
```typescript
export interface BasicHGWOptions
interface BasicHGWOptions
```
## Properties

@ -9,7 +9,7 @@ All multipliers affecting the difficulty of the current challenge.
<b>Signature:</b>
```typescript
export interface BitNodeMultipliers
interface BitNodeMultipliers
```
## Properties

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [inBladeburner](./bitburner.bladeburner.inbladeburner.md)
## Bladeburner.inBladeburner() method
Returns whether player is a member of bladeburner division. Does not require API access.
<b>Signature:</b>
```typescript
inBladeburner(): boolean;
```
<b>Returns:</b>
boolean
whether player is a member of bladeburner division.
## Remarks
RAM cost: 1 GB

@ -46,6 +46,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [getSkillUpgradeCost(name, count)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. |
| [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. |
| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. |
| [inBladeburner()](./bitburner.bladeburner.inbladeburner.md) | Returns whether player is a member of bladeburner division. Does not require API access. |
| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. |
| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | Join the bladeburner faction. |
| [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | Set an action autolevel. |

@ -9,7 +9,7 @@ Bladeburner current action.
<b>Signature:</b>
```typescript
export interface BladeburnerCurAction
interface BladeburnerCurAction
```
## Properties

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [agility](./bitburner.charactermult.agility.md)
## CharacterMult.agility property
Agility stat
<b>Signature:</b>
```typescript
agility: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [agilityExp](./bitburner.charactermult.agilityexp.md)
## CharacterMult.agilityExp property
Agility exp
<b>Signature:</b>
```typescript
agilityExp: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [charisma](./bitburner.charactermult.charisma.md)
## CharacterMult.charisma property
Charisma stat
<b>Signature:</b>
```typescript
charisma: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [charismaExp](./bitburner.charactermult.charismaexp.md)
## CharacterMult.charismaExp property
Charisma exp
<b>Signature:</b>
```typescript
charismaExp: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [companyRep](./bitburner.charactermult.companyrep.md)
## CharacterMult.companyRep property
Company reputation
<b>Signature:</b>
```typescript
companyRep: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [crimeMoney](./bitburner.charactermult.crimemoney.md)
## CharacterMult.crimeMoney property
Money earned from crimes
<b>Signature:</b>
```typescript
crimeMoney: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [crimeSuccess](./bitburner.charactermult.crimesuccess.md)
## CharacterMult.crimeSuccess property
Crime success chance
<b>Signature:</b>
```typescript
crimeSuccess: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [defense](./bitburner.charactermult.defense.md)
## CharacterMult.defense property
Defense stat
<b>Signature:</b>
```typescript
defense: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [defenseExp](./bitburner.charactermult.defenseexp.md)
## CharacterMult.defenseExp property
Defense exp
<b>Signature:</b>
```typescript
defenseExp: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [dexterity](./bitburner.charactermult.dexterity.md)
## CharacterMult.dexterity property
Dexterity stat
<b>Signature:</b>
```typescript
dexterity: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [dexterityExp](./bitburner.charactermult.dexterityexp.md)
## CharacterMult.dexterityExp property
Dexterity exp
<b>Signature:</b>
```typescript
dexterityExp: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [factionRep](./bitburner.charactermult.factionrep.md)
## CharacterMult.factionRep property
Faction reputation
<b>Signature:</b>
```typescript
factionRep: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [hacking](./bitburner.charactermult.hacking.md)
## CharacterMult.hacking property
Hacking stat
<b>Signature:</b>
```typescript
hacking: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [hackingExp](./bitburner.charactermult.hackingexp.md)
## CharacterMult.hackingExp property
Hacking exp
<b>Signature:</b>
```typescript
hackingExp: number;
```

@ -1,35 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md)
## CharacterMult interface
<b>Signature:</b>
```typescript
export interface CharacterMult
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [agility](./bitburner.charactermult.agility.md) | number | Agility stat |
| [agilityExp](./bitburner.charactermult.agilityexp.md) | number | Agility exp |
| [charisma](./bitburner.charactermult.charisma.md) | number | Charisma stat |
| [charismaExp](./bitburner.charactermult.charismaexp.md) | number | Charisma exp |
| [companyRep](./bitburner.charactermult.companyrep.md) | number | Company reputation |
| [crimeMoney](./bitburner.charactermult.crimemoney.md) | number | Money earned from crimes |
| [crimeSuccess](./bitburner.charactermult.crimesuccess.md) | number | Crime success chance |
| [defense](./bitburner.charactermult.defense.md) | number | Defense stat |
| [defenseExp](./bitburner.charactermult.defenseexp.md) | number | Defense exp |
| [dexterity](./bitburner.charactermult.dexterity.md) | number | Dexterity stat |
| [dexterityExp](./bitburner.charactermult.dexterityexp.md) | number | Dexterity exp |
| [factionRep](./bitburner.charactermult.factionrep.md) | number | Faction reputation |
| [hacking](./bitburner.charactermult.hacking.md) | number | Hacking stat |
| [hackingExp](./bitburner.charactermult.hackingexp.md) | number | Hacking exp |
| [strength](./bitburner.charactermult.strength.md) | number | Strength stat |
| [strengthExp](./bitburner.charactermult.strengthexp.md) | number | Strength exp |
| [workMoney](./bitburner.charactermult.workmoney.md) | number | Money earned from jobs |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [strength](./bitburner.charactermult.strength.md)
## CharacterMult.strength property
Strength stat
<b>Signature:</b>
```typescript
strength: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [strengthExp](./bitburner.charactermult.strengthexp.md)
## CharacterMult.strengthExp property
Strength exp
<b>Signature:</b>
```typescript
strengthExp: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CharacterMult](./bitburner.charactermult.md) &gt; [workMoney](./bitburner.charactermult.workmoney.md)
## CharacterMult.workMoney property
Money earned from jobs
<b>Signature:</b>
```typescript
workMoney: number;
```

@ -9,7 +9,7 @@ Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md
<b>Signature:</b>
```typescript
export interface CodingAttemptOptions
interface CodingAttemptOptions
```
## Properties

@ -0,0 +1,56 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyPosName](./bitburner.companyposname.md)
## CompanyPosName enum
<b>Signature:</b>
```typescript
declare enum CompanyPosName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| agent0 | <code>&quot;Field Agent&quot;</code> | |
| agent1 | <code>&quot;Secret Agent&quot;</code> | |
| agent2 | <code>&quot;Special Operative&quot;</code> | |
| bus0 | <code>&quot;Business Intern&quot;</code> | |
| bus1 | <code>&quot;Business Analyst&quot;</code> | |
| bus2 | <code>&quot;Business Manager&quot;</code> | |
| bus3 | <code>&quot;Operations Manager&quot;</code> | |
| bus4 | <code>&quot;Chief Financial Officer&quot;</code> | |
| bus5 | <code>&quot;Chief Executive Officer&quot;</code> | |
| busCons0 | <code>&quot;Business Consultant&quot;</code> | |
| busCons1 | <code>&quot;Senior Business Consultant&quot;</code> | |
| employee | <code>&quot;Employee&quot;</code> | |
| employeePT | <code>&quot;Part-time Employee&quot;</code> | |
| IT0 | <code>&quot;IT Intern&quot;</code> | |
| IT1 | <code>&quot;IT Analyst&quot;</code> | |
| IT2 | <code>&quot;IT Manager&quot;</code> | |
| IT3 | <code>&quot;Systems Administrator&quot;</code> | |
| netEng0 | <code>&quot;Network Engineer&quot;</code> | |
| netEng1 | <code>&quot;Network Administrator&quot;</code> | |
| sec0 | <code>&quot;Police Officer&quot;</code> | |
| sec1 | <code>&quot;Police Chief&quot;</code> | |
| sec2 | <code>&quot;Security Guard&quot;</code> | |
| sec3 | <code>&quot;Security Officer&quot;</code> | |
| sec4 | <code>&quot;Security Supervisor&quot;</code> | |
| sec5 | <code>&quot;Head of Security&quot;</code> | |
| secEng | <code>&quot;Security Engineer&quot;</code> | |
| softCons0 | <code>&quot;Software Consultant&quot;</code> | |
| softCons1 | <code>&quot;Senior Software Consultant&quot;</code> | |
| sw0 | <code>&quot;Software Engineering Intern&quot;</code> | |
| sw1 | <code>&quot;Junior Software Engineer&quot;</code> | |
| sw2 | <code>&quot;Senior Software Engineer&quot;</code> | |
| sw3 | <code>&quot;Lead Software Developer&quot;</code> | |
| sw4 | <code>&quot;Head of Software&quot;</code> | |
| sw5 | <code>&quot;Head of Engineering&quot;</code> | |
| sw6 | <code>&quot;Vice President of Technology&quot;</code> | |
| sw7 | <code>&quot;Chief Technology Officer&quot;</code> | |
| waiter | <code>&quot;Waiter&quot;</code> | |
| waiterPT | <code>&quot;Part-time Waiter&quot;</code> | |

@ -16,7 +16,7 @@ createCorporation(corporationName: string, selfFund: boolean): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| corporationName | string | |
| corporationName | string | Name of the corporation |
| selfFund | boolean | If you should self fund, defaults to true, false will only work on Bitnode 3 |
<b>Returns:</b>

@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [enums](./bitburner.corporation.enums.md)
## Corporation.enums property
Enums specific to the corporation game mechanic.
<b>Signature:</b>
```typescript
enums: {
EmployeePositions: typeof EmployeePositions;
IndustryType: typeof IndustryType;
};
```

@ -9,14 +9,14 @@ Expand to a new industry
<b>Signature:</b>
```typescript
expandIndustry(industryType: string, divisionName: string): void;
expandIndustry(industryType: IndustryType | `${IndustryType}`, divisionName: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryType | string | Name of the industry |
| industryType | [IndustryType](./bitburner.industrytype.md) \| \`${[IndustryType](./bitburner.industrytype.md)<!-- -->}\` | Name of the industry |
| divisionName | string | Name of the division |
<b>Returns:</b>

@ -4,11 +4,7 @@
## Corporation.getBonusTime() method
Get bonus time.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
“Bonus time” makes the game progress faster.
Get bonus time. “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. “Bonus time” makes the game progress faster.
<b>Signature:</b>

@ -9,14 +9,14 @@ Gets the cost to expand into a new industry
<b>Signature:</b>
```typescript
getExpandIndustryCost(industryName: string): number;
getExpandIndustryCost(industryName: IndustryType | `${IndustryType}`): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryName | string | Name of the industry |
| industryName | [IndustryType](./bitburner.industrytype.md) \| \`${[IndustryType](./bitburner.industrytype.md)<!-- -->}\` | Name of the industry |
<b>Returns:</b>

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getIndustryTypes](./bitburner.corporation.getindustrytypes.md)
## Corporation.getIndustryTypes() method
Get list of industry types
<b>Signature:</b>
```typescript
getIndustryTypes(): string[];
```
<b>Returns:</b>
string\[\]
industry names

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [hasCorporation](./bitburner.corporation.hascorporation.md)
## Corporation.hasCorporation() method
Returns whether the player has a corporation. Does not require API access.
<b>Signature:</b>
```typescript
hasCorporation(): boolean;
```
<b>Returns:</b>
boolean
whether the player has a corporation

@ -13,6 +13,12 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
```
<b>Extends:</b> [WarehouseAPI](./bitburner.warehouseapi.md)<!-- -->, [OfficeAPI](./bitburner.officeapi.md)
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [enums](./bitburner.corporation.enums.md) | { EmployeePositions: typeof [EmployeePositions](./bitburner.employeepositions.md)<!-- -->; IndustryType: typeof [IndustryType](./bitburner.industrytype.md)<!-- -->; } | Enums specific to the corporation game mechanic. |
## Methods
| Method | Description |
@ -23,12 +29,11 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) | Create a Corporation |
| [expandCity(divisionName, cityName)](./bitburner.corporation.expandcity.md) | Expand to a new city |
| [expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) | Expand to a new industry |
| [getBonusTime()](./bitburner.corporation.getbonustime.md) | Get bonus time.<!-- -->“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.<!-- -->“Bonus time” makes the game progress faster. |
| [getBonusTime()](./bitburner.corporation.getbonustime.md) | Get bonus time. “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. “Bonus time” makes the game progress faster. |
| [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data |
| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data |
| [getExpandCityCost()](./bitburner.corporation.getexpandcitycost.md) | Gets the cost to expand into a new city |
| [getExpandIndustryCost(industryName)](./bitburner.corporation.getexpandindustrycost.md) | Gets the cost to expand into a new industry |
| [getIndustryTypes()](./bitburner.corporation.getindustrytypes.md) | Get list of industry types |
| [getInvestmentOffer()](./bitburner.corporation.getinvestmentoffer.md) | Get an offer for investment based on you companies current valuation |
| [getMaterialNames()](./bitburner.corporation.getmaterialnames.md) | Get list of materials |
| [getResearchNames()](./bitburner.corporation.getresearchnames.md) | Get list of research names |
@ -38,6 +43,7 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| [getUpgradeLevelCost(upgradeName)](./bitburner.corporation.getupgradelevelcost.md) | Gets the cost to unlock the next level of a levelable upgrade |
| [getUpgradeNames()](./bitburner.corporation.getupgradenames.md) | Get list of upgrade names |
| [goPublic(numShares)](./bitburner.corporation.gopublic.md) | Go public |
| [hasCorporation()](./bitburner.corporation.hascorporation.md) | Returns whether the player has a corporation. Does not require API access. |
| [hasUnlockUpgrade(upgradeName)](./bitburner.corporation.hasunlockupgrade.md) | Check if you have a one time unlockable upgrade |
| [issueDividends(rate)](./bitburner.corporation.issuedividends.md) | Issue dividends |
| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level an upgrade. |

@ -9,7 +9,7 @@ Data representing the internal values of a crime.
<b>Signature:</b>
```typescript
export interface CrimeStats
interface CrimeStats
```
## Properties
@ -31,7 +31,6 @@ export interface CrimeStats
| [karma](./bitburner.crimestats.karma.md) | number | Amount of karma lost for successfully committing this crime |
| [kills](./bitburner.crimestats.kills.md) | number | How many people die as a result of this crime |
| [money](./bitburner.crimestats.money.md) | number | How much money is given |
| [name](./bitburner.crimestats.name.md) | string | Name of crime |
| [strength\_exp](./bitburner.crimestats.strength_exp.md) | number | strength exp gained from crime |
| [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) | number | strength level impact on success change of the crime |
| [time](./bitburner.crimestats.time.md) | number | Milliseconds it takes to attempt the crime |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeStats](./bitburner.crimestats.md) &gt; [name](./bitburner.crimestats.name.md)
## CrimeStats.name property
Name of crime
<b>Signature:</b>
```typescript
name: string;
```

@ -0,0 +1,30 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CrimeType](./bitburner.crimetype.md)
## CrimeType enum
<b>Signature:</b>
```typescript
declare enum CrimeType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| assassination | <code>&quot;Assassination&quot;</code> | |
| bondForgery | <code>&quot;Bond Forgery&quot;</code> | |
| dealDrugs | <code>&quot;Deal Drugs&quot;</code> | |
| grandTheftAuto | <code>&quot;Grand Theft Auto&quot;</code> | |
| heist | <code>&quot;Heist&quot;</code> | |
| homicide | <code>&quot;Homicide&quot;</code> | |
| kidnap | <code>&quot;Kidnap&quot;</code> | |
| larceny | <code>&quot;Larceny&quot;</code> | |
| mug | <code>&quot;Mug&quot;</code> | |
| robStore | <code>&quot;Rob Store&quot;</code> | |
| shoplift | <code>&quot;Shoplift&quot;</code> | |
| traffickArms | <code>&quot;Traffick Arms&quot;</code> | |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [cha](./bitburner.employee.cha.md)
## Employee.cha property
Charisma of the employee
<b>Signature:</b>
```typescript
cha: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [cre](./bitburner.employee.cre.md)
## Employee.cre property
Creativity of the employee
<b>Signature:</b>
```typescript
cre: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [eff](./bitburner.employee.eff.md)
## Employee.eff property
Efficiency of the employee
<b>Signature:</b>
```typescript
eff: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [ene](./bitburner.employee.ene.md)
## Employee.ene property
Energy of the employee
<b>Signature:</b>
```typescript
ene: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [exp](./bitburner.employee.exp.md)
## Employee.exp property
Experience of the employee
<b>Signature:</b>
```typescript
exp: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [hap](./bitburner.employee.hap.md)
## Employee.hap property
Happiness of the employee
<b>Signature:</b>
```typescript
hap: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [int](./bitburner.employee.int.md)
## Employee.int property
Intelligence of the employee
<b>Signature:</b>
```typescript
int: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [loc](./bitburner.employee.loc.md)
## Employee.loc property
Current Location (city)
<b>Signature:</b>
```typescript
loc: string;
```

@ -1,31 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md)
## Employee interface
Employee in an office
<b>Signature:</b>
```typescript
export interface Employee
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [cha](./bitburner.employee.cha.md) | number | Charisma of the employee |
| [cre](./bitburner.employee.cre.md) | number | Creativity of the employee |
| [eff](./bitburner.employee.eff.md) | number | Efficiency of the employee |
| [ene](./bitburner.employee.ene.md) | number | Energy of the employee |
| [exp](./bitburner.employee.exp.md) | number | Experience of the employee |
| [hap](./bitburner.employee.hap.md) | number | Happiness of the employee |
| [int](./bitburner.employee.int.md) | number | Intelligence of the employee |
| [loc](./bitburner.employee.loc.md) | string | Current Location (city) |
| [mor](./bitburner.employee.mor.md) | number | Morale of the employee |
| [name](./bitburner.employee.name.md) | string | Name of the employee |
| [pos](./bitburner.employee.pos.md) | string | Current job position |
| [sal](./bitburner.employee.sal.md) | number | Salary of the employee |

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [mor](./bitburner.employee.mor.md)
## Employee.mor property
Morale of the employee
<b>Signature:</b>
```typescript
mor: number;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [name](./bitburner.employee.name.md)
## Employee.name property
Name of the employee
<b>Signature:</b>
```typescript
name: string;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [pos](./bitburner.employee.pos.md)
## Employee.pos property
Current job position
<b>Signature:</b>
```typescript
pos: string;
```

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Employee](./bitburner.employee.md) &gt; [sal](./bitburner.employee.sal.md)
## Employee.sal property
Salary of the employee
<b>Signature:</b>
```typescript
sal: number;
```

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; ["Research &amp; Development"](./bitburner.employeejobs._research___development_.md)
## EmployeeJobs."Research &amp; Development" property
<b>Signature:</b>
```typescript
"Research & Development": number;
```

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; [Business](./bitburner.employeejobs.business.md)
## EmployeeJobs.Business property
<b>Signature:</b>
```typescript
Business: number;
```

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; [Engineer](./bitburner.employeejobs.engineer.md)
## EmployeeJobs.Engineer property
<b>Signature:</b>
```typescript
Engineer: number;
```

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; [Management](./bitburner.employeejobs.management.md)
## EmployeeJobs.Management property
<b>Signature:</b>
```typescript
Management: number;
```

@ -1,26 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md)
## EmployeeJobs interface
Object representing the number of employee in each job.
<b>Signature:</b>
```typescript
interface EmployeeJobs
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| ["Research &amp; Development"](./bitburner.employeejobs._research___development_.md) | number | |
| [Business](./bitburner.employeejobs.business.md) | number | |
| [Engineer](./bitburner.employeejobs.engineer.md) | number | |
| [Management](./bitburner.employeejobs.management.md) | number | |
| [Operations](./bitburner.employeejobs.operations.md) | number | |
| [Training](./bitburner.employeejobs.training.md) | number | |
| [Unassigned](./bitburner.employeejobs.unassigned.md) | number | |

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; [Operations](./bitburner.employeejobs.operations.md)
## EmployeeJobs.Operations property
<b>Signature:</b>
```typescript
Operations: number;
```

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; [Training](./bitburner.employeejobs.training.md)
## EmployeeJobs.Training property
<b>Signature:</b>
```typescript
Training: number;
```

@ -1,11 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeeJobs](./bitburner.employeejobs.md) &gt; [Unassigned](./bitburner.employeejobs.unassigned.md)
## EmployeeJobs.Unassigned property
<b>Signature:</b>
```typescript
Unassigned: number;
```

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeePositions](./bitburner.employeepositions.md)
## EmployeePositions enum
<b>Signature:</b>
```typescript
declare enum EmployeePositions
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Business | <code>&quot;Business&quot;</code> | |
| Engineer | <code>&quot;Engineer&quot;</code> | |
| Management | <code>&quot;Management&quot;</code> | |
| Operations | <code>&quot;Operations&quot;</code> | |
| RandD | <code>&quot;Research &amp; Development&quot;</code> | |
| Training | <code>&quot;Training&quot;</code> | |
| Unassigned | <code>&quot;Unassigned&quot;</code> | |

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [enums](./bitburner.enums.md)
## enums variable
<b>Signature:</b>
```typescript
enums = {
toast: {
SUCCESS: "success",
WARNING: "warning",
ERROR: "error",
INFO: "info",
},
}
```

@ -9,7 +9,7 @@ Object representing data representing a gang member equipment.
<b>Signature:</b>
```typescript
export interface EquipmentStats
interface EquipmentStats
```
## Properties

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FactionWorkType](./bitburner.factionworktype.md)
## FactionWorkType enum
<b>Signature:</b>
```typescript
declare enum FactionWorkType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| field | <code>&quot;field&quot;</code> | |
| hacking | <code>&quot;hacking&quot;</code> | |
| security | <code>&quot;security&quot;</code> | |

@ -32,6 +32,7 @@ You need Formulas.exe on your home computer to use this API.
| Method | Description |
| --- | --- |
| [mockPerson()](./bitburner.formulas.mockperson.md) | |
| [mockPlayer()](./bitburner.formulas.mockplayer.md) | |
| [mockServer()](./bitburner.formulas.mockserver.md) | |

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Formulas](./bitburner.formulas.md) &gt; [mockPerson](./bitburner.formulas.mockperson.md)
## Formulas.mockPerson() method
<b>Signature:</b>
```typescript
mockPerson(): Person;
```
<b>Returns:</b>
[Person](./bitburner.person.md)

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface Fragment
interface Fragment
```
## Properties

@ -21,5 +21,7 @@ True if a member can currently be recruited, false otherwise.
RAM cost: 1 GB
Returns boolean indicating whether a member can currently be recruited
Returns a boolean indicating whether a member can currently be recruited.
Once you have successfully created a gang by using the function [createGang](./bitburner.gang.creategang.md)<!-- -->, you can immediately recruit a small number of members to your gang. After you have recruited the founding members, to recruit another member you must increase your respect. The more members you want to recruit, the more respect you require. If your gang has the maximum number of members, then this function would return false.

@ -9,7 +9,7 @@ Gang general info.
<b>Signature:</b>
```typescript
export interface GangGenInfo
interface GangGenInfo
```
## Properties

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface GangMemberAscension
interface GangMemberAscension
```
## Properties

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface GangMemberInfo
interface GangMemberInfo
```
## Properties

@ -8,5 +8,5 @@
<b>Signature:</b>
```typescript
export interface GangOtherInfo
interface GangOtherInfo
```

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface GangOtherInfoObject
interface GangOtherInfoObject
```
## Properties

@ -9,7 +9,7 @@ Object representing data representing a gang member task.
<b>Signature:</b>
```typescript
export interface GangTaskStats
interface GangTaskStats
```
## Properties

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface GangTerritory
interface GangTerritory
```
## Properties

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [GymType](./bitburner.gymtype.md)
## GymType enum
<b>Signature:</b>
```typescript
declare enum GymType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| agility | <code>&quot;agi&quot;</code> | |
| defense | <code>&quot;def&quot;</code> | |
| dexterity | <code>&quot;dex&quot;</code> | |
| strength | <code>&quot;str&quot;</code> | |

@ -9,7 +9,7 @@ Calculate the percent a server would grow to. (Ex: 3.0 would would grow the serv
<b>Signature:</b>
```typescript
growPercent(server: Server, threads: number, player: Player, cores?: number): number;
growPercent(server: Server, threads: number, player: Person, cores?: number): number;
```
## Parameters
@ -18,7 +18,7 @@ growPercent(server: Server, threads: number, player: Player, cores?: number): nu
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| threads | number | Amount of thread. |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| cores | number | Number of cores on the computer that will execute grow. |
<b>Returns:</b>

@ -9,7 +9,7 @@ Calculate grow time.
<b>Signature:</b>
```typescript
growTime(server: Server, player: Player): number;
growTime(server: Server, player: Person): number;
```
## Parameters
@ -17,7 +17,7 @@ growTime(server: Server, player: Player): number;
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>

@ -9,7 +9,7 @@ Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.)
<b>Signature:</b>
```typescript
hackChance(server: Server, player: Player): number;
hackChance(server: Server, player: Person): number;
```
## Parameters
@ -17,7 +17,7 @@ hackChance(server: Server, player: Player): number;
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>

@ -9,7 +9,7 @@ Calculate hack exp for one thread.
<b>Signature:</b>
```typescript
hackExp(server: Server, player: Player): number;
hackExp(server: Server, player: Person): number;
```
## Parameters
@ -17,7 +17,7 @@ hackExp(server: Server, player: Player): number;
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>

@ -9,7 +9,7 @@ Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's
<b>Signature:</b>
```typescript
hackPercent(server: Server, player: Player): number;
hackPercent(server: Server, player: Person): number;
```
## Parameters
@ -17,7 +17,7 @@ hackPercent(server: Server, player: Player): number;
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>

@ -9,7 +9,7 @@ Calculate hack time.
<b>Signature:</b>
```typescript
hackTime(server: Server, player: Player): number;
hackTime(server: Server, player: Person): number;
```
## Parameters
@ -17,7 +17,7 @@ hackTime(server: Server, player: Player): number;
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>

@ -9,7 +9,7 @@ Calculate weaken time.
<b>Signature:</b>
```typescript
weakenTime(server: Server, player: Player): number;
weakenTime(server: Server, player: Person): number;
```
## Parameters
@ -17,7 +17,7 @@ weakenTime(server: Server, player: Player): number;
| Parameter | Type | Description |
| --- | --- | --- |
| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
| player | [Person](./bitburner.person.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>

@ -9,7 +9,7 @@ Hack related multipliers.
<b>Signature:</b>
```typescript
export interface HackingMultipliers
interface HackingMultipliers
```
## Properties

@ -9,7 +9,7 @@ Hacknet related multipliers.
<b>Signature:</b>
```typescript
export interface HacknetMultipliers
interface HacknetMultipliers
```
## Properties

@ -9,7 +9,7 @@ Hacknet node related constants
<b>Signature:</b>
```typescript
export interface HacknetNodeConstants
interface HacknetNodeConstants
```
## Properties

@ -9,7 +9,7 @@ Hacknet server related constants
<b>Signature:</b>
```typescript
export interface HacknetServerConstants
interface HacknetServerConstants
```
## Properties

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface HP
interface HP
```
## Properties

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface ILocation
interface ILocation
```
## Properties

@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IndustryType](./bitburner.industrytype.md)
## IndustryType enum
<b>Signature:</b>
```typescript
declare enum IndustryType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Agriculture | <code>&quot;Agriculture&quot;</code> | |
| Chemical | <code>&quot;Chemical&quot;</code> | |
| Computers | <code>&quot;Computer Hardware&quot;</code> | |
| Energy | <code>&quot;Energy&quot;</code> | |
| Fishing | <code>&quot;Fishing&quot;</code> | |
| Food | <code>&quot;Food&quot;</code> | |
| Healthcare | <code>&quot;Healthcare&quot;</code> | |
| Mining | <code>&quot;Mining&quot;</code> | |
| Pharmaceutical | <code>&quot;Pharmaceutical&quot;</code> | |
| RealEstate | <code>&quot;RealEstate&quot;</code> | |
| Robotics | <code>&quot;Robotics&quot;</code> | |
| Software | <code>&quot;Software&quot;</code> | |
| Tobacco | <code>&quot;Tobacco&quot;</code> | |
| Utilities | <code>&quot;Water Utilities&quot;</code> | |

@ -9,11 +9,11 @@ Get all locations that can be infiltrated.
<b>Signature:</b>
```typescript
getPossibleLocations(): PossibleInfiltrationLocation[];
getPossibleLocations(): ILocation[];
```
<b>Returns:</b>
[PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md)<!-- -->\[\]
[ILocation](./bitburner.ilocation.md)<!-- -->\[\]
all locations that can be infiltrated.

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface InfiltrationLocation
interface InfiltrationLocation
```
## Properties

@ -8,7 +8,7 @@
<b>Signature:</b>
```typescript
export interface InfiltrationReward
interface InfiltrationReward
```
## Properties

@ -0,0 +1,75 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [LocationName](./bitburner.locationname.md)
## LocationName enum
Names of all locations
<b>Signature:</b>
```typescript
declare enum LocationName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| AevumAeroCorp | <code>&quot;AeroCorp&quot;</code> | |
| AevumBachmanAndAssociates | <code>&quot;Bachman &amp; Associates&quot;</code> | |
| AevumCasino | <code>&quot;Iker Molina Casino&quot;</code> | |
| AevumClarkeIncorporated | <code>&quot;Clarke Incorporated&quot;</code> | |
| AevumCrushFitnessGym | <code>&quot;Crush Fitness Gym&quot;</code> | |
| AevumECorp | <code>&quot;ECorp&quot;</code> | |
| AevumFulcrumTechnologies | <code>&quot;Fulcrum Technologies&quot;</code> | |
| AevumGalacticCybersystems | <code>&quot;Galactic Cybersystems&quot;</code> | |
| AevumNetLinkTechnologies | <code>&quot;NetLink Technologies&quot;</code> | |
| AevumPolice | <code>&quot;Aevum Police Headquarters&quot;</code> | |
| AevumRhoConstruction | <code>&quot;Rho Construction&quot;</code> | |
| AevumSnapFitnessGym | <code>&quot;Snap Fitness Gym&quot;</code> | |
| AevumSummitUniversity | <code>&quot;Summit University&quot;</code> | |
| AevumWatchdogSecurity | <code>&quot;Watchdog Security&quot;</code> | |
| ChongqingChurchOfTheMachineGod | <code>&quot;Church of the Machine God&quot;</code> | |
| ChongqingKuaiGongInternational | <code>&quot;KuaiGong International&quot;</code> | |
| ChongqingSolarisSpaceSystems | <code>&quot;Solaris Space Systems&quot;</code> | |
| Hospital | <code>&quot;Hospital&quot;</code> | |
| IshimaGlitch | <code>&quot;0x6C1&quot;</code> | |
| IshimaNovaMedical | <code>&quot;Nova Medical&quot;</code> | |
| IshimaOmegaSoftware | <code>&quot;Omega Software&quot;</code> | |
| IshimaStormTechnologies | <code>&quot;Storm Technologies&quot;</code> | |
| NewTokyoArcade | <code>&quot;Arcade&quot;</code> | |
| NewTokyoDefComm | <code>&quot;DefComm&quot;</code> | |
| NewTokyoGlobalPharmaceuticals | <code>&quot;Global Pharmaceuticals&quot;</code> | |
| NewTokyoNoodleBar | <code>&quot;Noodle Bar&quot;</code> | |
| NewTokyoVitaLife | <code>&quot;VitaLife&quot;</code> | |
| Sector12AlphaEnterprises | <code>&quot;Alpha Enterprises&quot;</code> | |
| Sector12BladeIndustries | <code>&quot;Blade Industries&quot;</code> | |
| Sector12CarmichaelSecurity | <code>&quot;Carmichael Security&quot;</code> | |
| Sector12CIA | <code>&quot;Central Intelligence Agency&quot;</code> | |
| Sector12CityHall | <code>&quot;Sector-12 City Hall&quot;</code> | |
| Sector12DeltaOne | <code>&quot;DeltaOne&quot;</code> | |
| Sector12FoodNStuff | <code>&quot;FoodNStuff&quot;</code> | |
| Sector12FourSigma | <code>&quot;Four Sigma&quot;</code> | |
| Sector12IcarusMicrosystems | <code>&quot;Icarus Microsystems&quot;</code> | |
| Sector12IronGym | <code>&quot;Iron Gym&quot;</code> | |
| Sector12JoesGuns | <code>&quot;Joe's Guns&quot;</code> | |
| Sector12MegaCorp | <code>&quot;MegaCorp&quot;</code> | |
| Sector12NSA | <code>&quot;National Security Agency&quot;</code> | |
| Sector12PowerhouseGym | <code>&quot;Powerhouse Gym&quot;</code> | |
| Sector12RothmanUniversity | <code>&quot;Rothman University&quot;</code> | |
| Sector12UniversalEnergy | <code>&quot;Universal Energy&quot;</code> | |
| Slums | <code>&quot;The Slums&quot;</code> | |
| TravelAgency | <code>&quot;Travel Agency&quot;</code> | |
| Void | <code>&quot;The Void&quot;</code> | |
| VolhavenCompuTek | <code>&quot;CompuTek&quot;</code> | |
| VolhavenHeliosLabs | <code>&quot;Helios Labs&quot;</code> | |
| VolhavenLexoCorp | <code>&quot;LexoCorp&quot;</code> | |
| VolhavenMilleniumFitnessGym | <code>&quot;Millenium Fitness Gym&quot;</code> | |
| VolhavenNWO | <code>&quot;NWO&quot;</code> | |
| VolhavenOmniaCybersystems | <code>&quot;Omnia Cybersystems&quot;</code> | |
| VolhavenOmniTekIncorporated | <code>&quot;OmniTek Incorporated&quot;</code> | |
| VolhavenSysCoreSecurities | <code>&quot;SysCore Securities&quot;</code> | |
| VolhavenZBInstituteOfTechnology | <code>&quot;ZB Institute of Technology&quot;</code> | |
| WorldStockExchange | <code>&quot;World Stock Exchange&quot;</code> | |

@ -8,8 +8,17 @@
| Enumeration | Description |
| --- | --- |
| [CompanyPosName](./bitburner.companyposname.md) | |
| [CrimeType](./bitburner.crimetype.md) | |
| [EmployeePositions](./bitburner.employeepositions.md) | |
| [FactionWorkType](./bitburner.factionworktype.md) | |
| [GymType](./bitburner.gymtype.md) | |
| [IndustryType](./bitburner.industrytype.md) | |
| [LocationName](./bitburner.locationname.md) | Names of all locations |
| [OrderTypes](./bitburner.ordertypes.md) | |
| [PositionTypes](./bitburner.positiontypes.md) | |
| [ToastVariant](./bitburner.toastvariant.md) | |
| [UniversityClassType](./bitburner.universityclasstype.md) | |
## Interfaces
@ -22,15 +31,12 @@
| [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. |
| [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API |
| [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. |
| [CharacterMult](./bitburner.charactermult.md) | |
| [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt. |
| [CodingContract](./bitburner.codingcontract.md) | Coding Contract API |
| [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) | 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. |
| [Export](./bitburner.export.md) | Export order for a material |
| [Formulas](./bitburner.formulas.md) | Formulas API |
@ -62,14 +68,16 @@
| [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer |
| [IStyleSettings](./bitburner.istylesettings.md) | Interface Styles |
| [Material](./bitburner.material.md) | Material in a warehouse |
| [MoneySource](./bitburner.moneysource.md) | |
| [MoneySources](./bitburner.moneysources.md) | |
| [Multipliers](./bitburner.multipliers.md) | |
| [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. |
| [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) | Office for a division in a city. |
| [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API |
| [Person](./bitburner.person.md) | |
| [Player](./bitburner.player.md) | |
| [PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md) | |
| [ProcessInfo](./bitburner.processinfo.md) | A single process on a server. |
| [Product](./bitburner.product.md) | Product in a warehouse |
| [RecentScript](./bitburner.recentscript.md) | |
@ -79,10 +87,8 @@
| [Singularity](./bitburner.singularity.md) | Singularity API |
| [Skills](./bitburner.skills.md) | |
| [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
| [Sleeve](./bitburner.sleeve.md) | Sleeve API |
| [SleeveInformation](./bitburner.sleeveinformation.md) | Object representing sleeve information. |
| [SleeveSkills](./bitburner.sleeveskills.md) | Object representing a sleeve stats. |
| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | |
| [sleeve](./bitburner.sleeve.md) | Sleeve API |
| [Sleeve](./bitburner.sleeve.md) | |
| [SourceFileLvl](./bitburner.sourcefilelvl.md) | |
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)<!-- -->Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) |
@ -95,12 +101,6 @@
| [WorkFormulas](./bitburner.workformulas.md) | Work formulas |
| [WorkStats](./bitburner.workstats.md) | |
## Variables
| Variable | Description |
| --- | --- |
| [enums](./bitburner.enums.md) | |
## Type Aliases
| Type Alias | Description |
@ -110,7 +110,14 @@
| [NSEnums](./bitburner.nsenums.md) | |
| [PortData](./bitburner.portdata.md) | |
| [ScriptArg](./bitburner.scriptarg.md) | |
| [SleeveBladeburnerTask](./bitburner.sleevebladeburnertask.md) | |
| [SleeveClassTask](./bitburner.sleeveclasstask.md) | |
| [SleeveCompanyTask](./bitburner.sleevecompanytask.md) | |
| [SleeveCrimeTask](./bitburner.sleevecrimetask.md) | |
| [SleeveFactionTask](./bitburner.sleevefactiontask.md) | |
| [SleeveInfiltrateTask](./bitburner.sleeveinfiltratetask.md) | |
| [SleeveRecoveryTask](./bitburner.sleeverecoverytask.md) | |
| [SleeveSupportTask](./bitburner.sleevesupporttask.md) | |
| [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) | |
| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. |
| [ToastVariant](./bitburner.toastvariant.md) | |
| [ValuesFrom](./bitburner.valuesfrom.md) | |

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [MoneySource](./bitburner.moneysource.md) &gt; [augmentations](./bitburner.moneysource.augmentations.md)
## MoneySource.augmentations property
<b>Signature:</b>
```typescript
augmentations: number;
```

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [MoneySource](./bitburner.moneysource.md) &gt; [bladeburner](./bitburner.moneysource.bladeburner.md)
## MoneySource.bladeburner property
<b>Signature:</b>
```typescript
bladeburner: number;
```

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [MoneySource](./bitburner.moneysource.md) &gt; [casino](./bitburner.moneysource.casino.md)
## MoneySource.casino property
<b>Signature:</b>
```typescript
casino: number;
```

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [MoneySource](./bitburner.moneysource.md) &gt; [class](./bitburner.moneysource.class.md)
## MoneySource.class property
<b>Signature:</b>
```typescript
class: number;
```

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [MoneySource](./bitburner.moneysource.md) &gt; [codingcontract](./bitburner.moneysource.codingcontract.md)
## MoneySource.codingcontract property
<b>Signature:</b>
```typescript
codingcontract: number;
```

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