Compare commits

..

1 Commits

Author SHA1 Message Date
Snarling
4f78fcab1b Resolve index files for script imports 2024-08-16 19:40:41 -04:00
657 changed files with 8772 additions and 18964 deletions

View File

@@ -1,12 +1,14 @@
node_modules/
test/
dist/
.app/
.github
.git
.gitattributes
.gitignore
.editorconfig
.dockerignore
Dockerfile
docker-compose.yml
*.md
Quotes.txt
netscript_tests/

View File

@@ -7,7 +7,6 @@ node_modules/
dist
input
assets
coverage
doc
markdown
electron

View File

@@ -9,8 +9,8 @@ module.exports = {
"plugin:@typescript-eslint/recommended",
"plugin:react/recommended",
"plugin:react-hooks/recommended",
"plugin:@typescript-eslint/recommended-requiring-type-checking",
"plugin:@typescript-eslint/strict",
//"plugin:@typescript-eslint/recommended-requiring-type-checking",
//"plugin:@typescript-eslint/strict",
],
parser: "@typescript-eslint/parser",
parserOptions: {
@@ -34,26 +34,10 @@ module.exports = {
"@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/no-explicit-any": "off",
"react/no-unescaped-entities": "off",
"@typescript-eslint/restrict-template-expressions": "off",
"@typescript-eslint/no-unsafe-enum-comparison": "off",
},
settings: {
react: {
version: "detect",
},
},
overrides: [
/**
* Some enums are subsets of other enums. For example, UniversityLocationName contains locations of 3 universities.
* With each member, we refer to the respective LocationName's member instead of using a literal string. This usage
* is okay, but it triggers the "prefer-literal-enum-member" rule. This rule is not useful in this case, so we
* suppress it in NetscriptDefinitions.d.ts.
*/
{
files: ["src/ScriptEditor/NetscriptDefinitions.d.ts"],
rules: {
"@typescript-eslint/prefer-literal-enum-member": ["off"],
},
},
],
};

1
.gitignore vendored
View File

@@ -3,7 +3,6 @@
.vscode
Changelog.txt
Netburner.txt
/coverage
/doc/build
/node_modules
/electron/node_modules

View File

@@ -3,7 +3,6 @@ package.json
dist
doc/build
doc/source
coverage
.build
.package
.app

View File

@@ -1,50 +0,0 @@
# Stage 1: Build the application
FROM node:lts-alpine AS builder
# Set working directory
WORKDIR /app
# Install necessary tools, including git
RUN apk update && \
apk add --no-cache git && \
apk add bash
# Copy dependencies
COPY package.json package-lock.json ./
COPY tools/ ./tools
# Install dependencies
RUN npm ci
# Copy source code
COPY . .
# Build the application
# Pass the build mode as a build argument
ARG BUILD_MODE
# Use shell logic to determine which version to install
RUN if [ "$BUILD_MODE" = "dev" ]; then \
echo "Installing development version"; \
npm run build:dev; \
else \
echo "Installing production version"; \
npm run build; \
fi
# Stage 2: Serve the application using Nginx
FROM nginx:stable-alpine AS runtime
# Security optimizations
RUN chmod -R 644 /etc/nginx/nginx.conf
# Copy the built application from the builder stage
COPY --from=builder /app/.app /usr/share/nginx/html
# Set permissions for security
RUN chmod -R 755 /usr/share/nginx/html
# Expose port
EXPOSE 80
# Start Nginx
CMD ["nginx", "-g", "daemon off;"]

View File

@@ -13,10 +13,9 @@ See the [frequently asked questions](./doc/FAQ.md) for more information . To dis
# Documentation
There are 2 types of documentation:
The game's official documentation can be found in-game.
- In-game documentation: It can be found in the Documentation tab. This is the best place to get up-to-date information. You can also read the web version at https://github.com/bitburner-official/bitburner-src/blob/stable/src/Documentation/doc/index.md.
- NS API documentation: It's generated from the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts). You can read it at https://github.com/bitburner-official/bitburner-src/blob/stable/markdown/bitburner.md.
The [in-game documentation](./markdown/bitburner.md) is generated from the [TypeScript definitions](./src/ScriptEditor/NetscriptDefinitions.d.ts).
Anyone is welcome to contribute to the documentation by editing the [source
files](/src/Documentation/doc) and then making a pull request with your contributions.

View File

@@ -10,6 +10,6 @@ for i in $ROOTDIR/dist/icons/achievements/*.svg; do
echo $i
# Make background transparent and replace green with black
# The icons will be recolored by css filters matching the player's theme
sed -i"" "s/fill:#000000;/fill-opacity: 0%;/g" "$i"
sed -i"" "s/fill:#00ff00;/fill:#000000;/g" "$i"
sed -i "s/fill:#000000;/fill-opacity: 0%;/g" "$i"
sed -i "s/fill:#00ff00;/fill:#000000;/g" "$i"
done

View File

@@ -1,12 +0,0 @@
version: "3.8"
services:
bitburner-app:
build:
context: .
dockerfile: Dockerfile
args:
BUILD_MODE: production # Pass the build mode to the Dockerfile
ports:
- "8080:80" # Map port 8080 on the host to port 80 in the container
restart: unless-stopped

View File

@@ -286,14 +286,11 @@ function getMenu(window) {
click: () => {
dialog
.showMessageBox({
type: "warning",
type: "info",
title: "Bitburner > API Server Information",
message: "The API Server is used to write script files to your in-game home.",
detail:
`WARNING: This feature is deprecated. It may be removed in future versions.\n\n` +
`You should use external tools that support our Remote API feature. For details, please check the "Remote API" page in the in-game documentation. You can also check the "external-editors" channel in our Discord server for more information and support.\n\n` +
"--------------------------------------------------------------------------------\n\n" +
"There is an official Visual Studio Code extension that makes use of the API Server feature.\n\n" +
"There is an official Visual Studio Code extension that makes use of that feature.\n\n" +
"It allows you to write your script file in an external IDE and have them pushed over to the game automatically.\n" +
"If you want more information, head over to: https://github.com/bitburner-official/bitburner-vscode.",
buttons: ["Dismiss", "Open Extension Link (GitHub)"],

View File

@@ -1,12 +1,12 @@
{
"name": "bitburner",
"version": "2.8.0",
"version": "2.6.3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "bitburner",
"version": "2.8.0",
"version": "2.6.3",
"dependencies": {
"electron-log": "^4.4.8",
"electron-store": "^8.1.0",

View File

@@ -1,6 +1,6 @@
{
"name": "bitburner",
"version": "2.8.0",
"version": "2.6.3",
"description": "A cyberpunk-themed programming incremental game",
"main": "main.js",
"author": "Daniel Xie, hydroflame, et al.",

View File

@@ -2,7 +2,7 @@ module.exports = {
roots: ["<rootDir>/src/", "<rootDir>/test/"],
moduleFileExtensions: ["ts", "tsx", "js", "jsx"],
transform: {
"^.+\\.(js|jsx|ts|tsx|cjs|mjs)$": "<rootDir>/test/jest/config/babelTransform.js",
"^.+\\.(js|jsx|ts|tsx)$": "babel-jest",
},
transformIgnorePatterns: ["node_modules/(?!react-markdown)/"],
testPathIgnorePatterns: [".cypress", "node_modules", "dist"],
@@ -15,7 +15,7 @@ module.exports = {
".*?raw$": "<rootDir>/test/__mocks__/fileMock.js",
"@player": "<rootDir>/src/Player",
"@enums": "<rootDir>/src/Enums",
"@nsdefs": "<rootDir>/src/ScriptEditor/NetscriptDefinitions.d.ts",
"@nsdefs": "<rootDir>/src/ScriptEditor/NetscriptDefinitions",
"^monaco-editor$": "<rootDir>/test/__mocks__/NullMock.js",
"^monaco-vim$": "<rootDir>/test/__mocks__/NullMock.js",
"/utils/Protections$": "<rootDir>/test/__mocks__/NullMock.js",

View File

@@ -1,15 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [command](./bitburner.autocompletedata.command.md)
## AutocompleteData.command property
The raw command string that you have typed until you press \[Tab\] to use the autocomplete feature.
For example, if you type `[Space]run test.js[Space][Space][Space][Press tab to use autocomplete]`<!-- -->, "command" will contain all space characters (1 space character before "run" and 3 space characters after ".js").
**Signature:**
```typescript
command: string;
```

View File

@@ -4,8 +4,6 @@
## AutocompleteData.enums property
Netscript Enums
**Signature:**
```typescript

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [filename](./bitburner.autocompletedata.filename.md)
## AutocompleteData.filename property
The filename of the script about to be run
**Signature:**
```typescript
filename: string;
```

View File

@@ -4,8 +4,6 @@
## AutocompleteData.flags() method
Parses the flags schema on the already inputted flags
**Signature:**
```typescript

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [hostname](./bitburner.autocompletedata.hostname.md)
## AutocompleteData.hostname property
The hostname of the server the script would be running on
**Signature:**
```typescript
hostname: string;
```

View File

@@ -16,18 +16,14 @@ interface AutocompleteData
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [command](./bitburner.autocompletedata.command.md) | | string | <p>The raw command string that you have typed until you press \[Tab\] to use the autocomplete feature.</p><p>For example, if you type <code>[Space]run test.js[Space][Space][Space][Press tab to use autocomplete]</code>, "command" will contain all space characters (1 space character before "run" and 3 space characters after ".js").</p> |
| [enums](./bitburner.autocompletedata.enums.md) | | [NSEnums](./bitburner.nsenums.md) | Netscript Enums |
| [filename](./bitburner.autocompletedata.filename.md) | | string | The filename of the script about to be run |
| [hostname](./bitburner.autocompletedata.hostname.md) | | string | The hostname of the server the script would be running on |
| [processes](./bitburner.autocompletedata.processes.md) | | [ProcessInfo](./bitburner.processinfo.md)<!-- -->\[\] | The processes running on the host |
| [scripts](./bitburner.autocompletedata.scripts.md) | | string\[\] | All scripts on the current server |
| [servers](./bitburner.autocompletedata.servers.md) | | string\[\] | All server hostnames |
| [txts](./bitburner.autocompletedata.txts.md) | | string\[\] | All text files on the current server |
| [enums](./bitburner.autocompletedata.enums.md) | | [NSEnums](./bitburner.nsenums.md) | |
| [scripts](./bitburner.autocompletedata.scripts.md) | | string\[\] | |
| [servers](./bitburner.autocompletedata.servers.md) | | string\[\] | |
| [txts](./bitburner.autocompletedata.txts.md) | | string\[\] | |
## Methods
| Method | Description |
| --- | --- |
| [flags(schema)](./bitburner.autocompletedata.flags.md) | Parses the flags schema on the already inputted flags |
| [flags(schema)](./bitburner.autocompletedata.flags.md) | |

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [processes](./bitburner.autocompletedata.processes.md)
## AutocompleteData.processes property
The processes running on the host
**Signature:**
```typescript
processes: ProcessInfo[];
```

View File

@@ -4,8 +4,6 @@
## AutocompleteData.scripts property
All scripts on the current server
**Signature:**
```typescript

View File

@@ -4,8 +4,6 @@
## AutocompleteData.servers property
All server hostnames
**Signature:**
```typescript

View File

@@ -4,8 +4,6 @@
## AutocompleteData.txts property
All text files on the current server
**Signature:**
```typescript

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BaseTask](./bitburner.basetask.md) &gt; [cyclesWorked](./bitburner.basetask.cyclesworked.md)
## BaseTask.cyclesWorked property
The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms.
**Signature:**
```typescript
cyclesWorked: number;
```

View File

@@ -1,20 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BaseTask](./bitburner.basetask.md)
## BaseTask interface
Base interface of all tasks.
**Signature:**
```typescript
export interface BaseTask
```
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cyclesWorked](./bitburner.basetask.cyclesworked.md) | | number | The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms. |

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.CodingContractMoney property
Influences the amount of money gained from completing Coding Contracts.
Influences the amount of money gained from completing Coding Contracts
**Signature:**

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CompanyWorkRepGain](./bitburner.bitnodemultipliers.companyworkrepgain.md)
## BitNodeMultipliers.CompanyWorkRepGain property
Influences how much rep the player gains when performing work for a company.
**Signature:**
```typescript
CompanyWorkRepGain: number;
```

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.CorporationDivisions property
Influences the amount of divisions a corporation can have at the same time.
Influences the amount of divisions a corporation can have at the same time
**Signature:**

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.CorporationSoftcap property
Influences profits from corporation dividends and selling shares.
Influences the money gain from dividends of corporations created by the player.
**Signature:**

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CrimeSuccessRate](./bitburner.bitnodemultipliers.crimesuccessrate.md)
## BitNodeMultipliers.CrimeSuccessRate property
Influences the success chance of committing crimes
**Signature:**
```typescript
CrimeSuccessRate: number;
```

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.FactionWorkRepGain property
Influences how much rep the player gains when performing work for a faction or donating to it.
Influences how much rep the player gains when performing work for a faction.
**Signature:**

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [GangUniqueAugs](./bitburner.bitnodemultipliers.ganguniqueaugs.md)
## BitNodeMultipliers.GangUniqueAugs property
Percentage of unique augs that the gang has.
**Signature:**
```typescript
GangUniqueAugs: number;
```

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [GoPower](./bitburner.bitnodemultipliers.gopower.md)
## BitNodeMultipliers.GoPower property
Percentage multiplier on the effect of the IPvGO rewards \*
**Signature:**
```typescript
GoPower: number;
```

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [HackingSpeedMultiplier](./bitburner.bitnodemultipliers.hackingspeedmultiplier.md)
## BitNodeMultipliers.HackingSpeedMultiplier property
Influences how quickly the player's hack(), grow() and weaken() calls run
**Signature:**
```typescript
HackingSpeedMultiplier: number;
```

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.HacknetNodeMoney property
Influences how much money is produced by Hacknet Nodes. Influences the hash rate of Hacknet Servers (unlocked in BitNode-9)
Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9)
**Signature:**

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.ManualHackMoney property
Influences how much money the player actually gains when they hack a server via the terminal. This is different from ScriptHackMoney. When the player hack a server via the terminal, the amount of money in that server is reduced, but they do not gain that same amount.
Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal.
**Signature:**

View File

@@ -23,49 +23,44 @@ interface BitNodeMultipliers
| [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md) | | number | Influences the cost of skill levels from Bladeburner. |
| [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md) | | number | Influences how quickly the player's charisma level (not exp) scales |
| [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md) | | number | Influences the experience gained for each ability when a player completes a class. |
| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | | number | Influences the amount of money gained from completing Coding Contracts. |
| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | | number | Influences the amount of money gained from completing Coding Contracts |
| [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) | | number | Influences the experience gained for each ability when the player completes working their job. |
| [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) | | number | Influences how much money the player earns when completing working their job. |
| [CompanyWorkRepGain](./bitburner.bitnodemultipliers.companyworkrepgain.md) | | number | Influences how much rep the player gains when performing work for a company. |
| [CorporationDivisions](./bitburner.bitnodemultipliers.corporationdivisions.md) | | number | Influences the amount of divisions a corporation can have at the same time. |
| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | | number | Influences profits from corporation dividends and selling shares. |
| [CorporationDivisions](./bitburner.bitnodemultipliers.corporationdivisions.md) | | number | Influences the amount of divisions a corporation can have at the same time |
| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | | number | Influences the money gain from dividends of corporations created by the player. |
| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | | number | Influences the valuation of corporations created by the player. |
| [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) | | number | Influences the base experience gained for each ability when the player commits a crime. |
| [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | | number | Influences the base money gained when the player commits a crime. |
| [CrimeSuccessRate](./bitburner.bitnodemultipliers.crimesuccessrate.md) | | number | Influences the success chance of committing crimes |
| [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md) | | number | Influences how many Augmentations you need in order to get invited to the Daedalus faction |
| [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md) | | number | Influences how quickly the player's defense level (not exp) scales |
| [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md) | | number | Influences how quickly the player's dexterity level (not exp) scales |
| [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) | | number | Influences how much rep the player gains in each faction simply by being a member. |
| [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) | | number | Influences the experience gained for each ability when the player completes work for a Faction. |
| [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | | number | Influences how much rep the player gains when performing work for a faction or donating to it. |
| [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | | number | Influences how much rep the player gains when performing work for a faction. |
| [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) | | number | Influences how much it costs to unlock the stock market's 4S Market Data API |
| [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) | | number | Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) |
| [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) | | number | Influences the respect gain and money gain of your gang. |
| [GangUniqueAugs](./bitburner.bitnodemultipliers.ganguniqueaugs.md) | | number | Percentage of unique augs that the gang has. |
| [GoPower](./bitburner.bitnodemultipliers.gopower.md) | | number | Percentage multiplier on the effect of the IPvGO rewards \* |
| [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | | number | Influences the experienced gained when hacking a server. |
| [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | | number | Influences how quickly the player's hacking level (not experience) scales |
| [HackingSpeedMultiplier](./bitburner.bitnodemultipliers.hackingspeedmultiplier.md) | | number | Influences how quickly the player's hack(), grow() and weaken() calls run |
| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | | number | Influences how much money is produced by Hacknet Nodes. Influences the hash rate of Hacknet Servers (unlocked in BitNode-9) |
| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) |
| [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md) | | number | Influences how much money it costs to upgrade your home computer's RAM |
| [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md) | | number | Influences how much money is gained when the player infiltrates a company. |
| [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md) | | number | Influences how much rep the player can gain from factions when selling stolen documents and secrets |
| [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) | | number | Influences how much money the player actually gains when they hack a server via the terminal. This is different from ScriptHackMoney. When the player hack a server via the terminal, the amount of money in that server is reduced, but they do not gain that same amount. |
| [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) | | number | Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. |
| [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | | number | Influence how much it costs to purchase a server |
| [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | | number | Influences the maximum number of purchased servers you can have |
| [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | | number | Influences the maximum allowed RAM for a purchased server |
| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | | number | Influence how much it costs to purchase a server |
| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | | number | Influences cost of any purchased server at or above 128GB |
| [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. |
| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | | number | Influences how much money is stolen from a server when the player performs a hack against it. |
| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | | number | Influences how much money the player actually gains when a script hacks a server. This is different from ScriptHackMoney. When a script hacks a server, the amount of money in that server is reduced, but the player does not gain that same amount. |
| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | | number | Influences how much the money on a server can be reduced when a script performs a hack against it. |
| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. |
| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | | number | Influences the growth percentage per cycle against a server. |
| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | | number | Influences the maximum money that a server can grow to. |
| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | | number | Influences the initial money that a server starts with. |
| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | | number | Influences the initial security level (hackDifficulty) of a server. |
| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | | number | Influences the weaken amount per invocation against a server. |
| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | | number | Influences the size of the gift. |
| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | | number | Influences the power of the gift. |
| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | | number | Influences the size of the gift |
| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | | number | Influences the power of the gift |
| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | | number | Influences how quickly the player's strength level (not exp) scales |
| [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) | | number | Influences the hacking skill required to backdoor the world daemon. |

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.PurchasedServerSoftcap property
Influence how much it costs to purchase a server
Influences cost of any purchased server at or above 128GB
**Signature:**

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.ScriptHackMoney property
Influences how much money is stolen from a server when the player performs a hack against it.
Influences how much the money on a server can be reduced when a script performs a hack against it.
**Signature:**

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.ScriptHackMoneyGain property
Influences how much money the player actually gains when a script hacks a server. This is different from ScriptHackMoney. When a script hacks a server, the amount of money in that server is reduced, but the player does not gain that same amount.
Influences how much of the money stolen by a scripted hack will be added to the player's money.
**Signature:**

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.StaneksGiftExtraSize property
Influences the size of the gift.
Influences the size of the gift
**Signature:**

View File

@@ -4,7 +4,7 @@
## BitNodeMultipliers.StaneksGiftPowerMultiplier property
Influences the power of the gift.
Influences the power of the gift
**Signature:**

View File

@@ -9,18 +9,15 @@ Get whether an action is set to autolevel.
**Signature:**
```typescript
getActionAutolevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): boolean;
getActionAutolevel(type: string, name: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get action count remaining.
**Signature:**
```typescript
getActionCountRemaining(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionCountRemaining(type: string, name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
**Returns:**
@@ -34,9 +31,5 @@ RAM cost: 4 GB
Returns the remaining count of the specified action.
Note:
- This function is meant to be used for Contracts and Operations. It returns Infinity for General actions (Training, Field Analysis, etc.). It returns 1 for BlackOps not yet completed, regardless of whether the player has the required rank to attempt the mission.
- With Contracts and Operations, the returned value is a floating-point number. The UI shows the rounded-down value.
Note that this is meant to be used for Contracts and Operations. This function will return Infinity for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of whether the player has the required rank to attempt the mission or not.

View File

@@ -9,18 +9,15 @@ Get the current level of an action.
**Signature:**
```typescript
getActionCurrentLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionCurrentLevel(type: string, name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Get estimate success chance of an action.
**Signature:**
```typescript
getActionEstimatedSuccessChance(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
sleeveNumber?: number,
): [number, number];
getActionEstimatedSuccessChance(type: string, name: string, sleeveNumber?: number): [number, number];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| sleeveNumber | number | _(Optional)_ Optional. Index of the sleeve to retrieve information. |
**Returns:**
@@ -34,5 +30,5 @@ Estimated success chance for the specified action.
RAM cost: 4 GB
Returns the estimated success chance for the specified action. This chance is returned in the range 0-1. (e.g. if you have an estimated success chance of 80%, then this function will return 0.8, NOT 80). Returns 2 values, value\[0\] - MIN Chance, value\[1\] - MAX Chance
Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). Returns 2 values, value\[0\] - MIN Chance, value\[1\] - MAX Chance

View File

@@ -9,18 +9,15 @@ Get the maximum level of an action.
**Signature:**
```typescript
getActionMaxLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionMaxLevel(type: string, name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Get the reputation gain of an action.
**Signature:**
```typescript
getActionRepGain(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
level?: number,
): number;
getActionRepGain(type: string, name: string, level?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| level | number | _(Optional)_ Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get action successes.
**Signature:**
```typescript
getActionSuccesses(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionSuccesses(type: string, name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,18 +9,15 @@ Get the time to complete an action.
**Signature:**
```typescript
getActionTime(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getActionTime(type: string, name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,17 +9,17 @@ List all black ops.
**Signature:**
```typescript
getBlackOpNames(): BladeburnerBlackOpName[];
getBlackOpNames(): string[];
```
**Returns:**
[BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md)<!-- -->\[\]
string\[\]
Array of strings containing the names of all Bladeburner Black Ops.
## Remarks
RAM cost: 0 GB
RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner Black Ops.

View File

@@ -9,14 +9,14 @@ Get black op required rank.
**Signature:**
```typescript
getBlackOpRank(name: BladeburnerBlackOpName): number;
getBlackOpRank(name: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | Name of BlackOp. Must be an exact match. |
| name | string | Name of BlackOp. Must be an exact match. |
**Returns:**

View File

@@ -9,17 +9,17 @@ List all contracts.
**Signature:**
```typescript
getContractNames(): BladeburnerContractName[];
getContractNames(): string[];
```
**Returns:**
[BladeburnerContractName](./bitburner.bladeburnercontractname.md)<!-- -->\[\]
string\[\]
Array of strings containing the names of all Bladeburner contracts.
## Remarks
RAM cost: 0 GB
RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner contracts.

View File

@@ -9,17 +9,17 @@ List all general actions.
**Signature:**
```typescript
getGeneralActionNames(): BladeburnerGeneralActionName[];
getGeneralActionNames(): string[];
```
**Returns:**
[BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)<!-- -->\[\]
string\[\]
Array of strings containing the names of all general Bladeburner actions.
## Remarks
RAM cost: 0 GB
RAM cost: 0.4 GB
Returns an array of strings containing the names of all general Bladeburner actions.

View File

@@ -9,11 +9,11 @@ Get an object with the name and rank requirement of the next BlackOp that can be
**Signature:**
```typescript
getNextBlackOp(): { name: BladeburnerBlackOpName; rank: number } | null;
getNextBlackOp(): { name: string; rank: number } | null;
```
**Returns:**
{ name: [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md)<!-- -->; rank: number } \| null
{ name: string; rank: number } \| null
An object with the `.name` and `.rank` properties of the available BlackOp, or `null`<!-- -->.

View File

@@ -9,17 +9,17 @@ List all operations.
**Signature:**
```typescript
getOperationNames(): BladeburnerOperationName[];
getOperationNames(): string[];
```
**Returns:**
[BladeburnerOperationName](./bitburner.bladeburneroperationname.md)<!-- -->\[\]
string\[\]
Array of strings containing the names of all Bladeburner operations.
## Remarks
RAM cost: 0 GB
RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner operations.

View File

@@ -9,14 +9,14 @@ Get skill level.
**Signature:**
```typescript
getSkillLevel(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`): number;
getSkillLevel(skillName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill. Case-sensitive and must be an exact match. |
| skillName | string | Name of skill. Case-sensitive and must be an exact match. |
**Returns:**

View File

@@ -9,17 +9,17 @@ List all skills.
**Signature:**
```typescript
getSkillNames(): BladeburnerSkillName[];
getSkillNames(): string[];
```
**Returns:**
[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->\[\]
string\[\]
Array of strings containing the names of all general Bladeburner skills.
## Remarks
RAM cost: 0 GB
RAM cost: 0.4 GB
Returns an array of strings containing the names of all general Bladeburner skills.

View File

@@ -9,14 +9,14 @@ Get cost to upgrade skill.
**Signature:**
```typescript
getSkillUpgradeCost(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): number;
getSkillUpgradeCost(skillName: string, count?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill. Case-sensitive and must be an exact match. |
| skillName | string | Name of skill. Case-sensitive and must be an exact match. |
| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. |
**Returns:**
@@ -31,11 +31,5 @@ RAM cost: 4 GB
This function returns the number of skill points needed to upgrade the specified skill the specified number of times.
The function may return 0 or Infinity in special cases:
- Return 0 if the current skill level is too high and the specified count is too small. In normal situations, you don't need to worry about this case. It only happens when involved numbers surpass Number.MAX\_SAFE\_INTEGER and be affected by the floating-point inaccuracy.
- Return Infinity if the sum of the current level and count exceeds the maximum level.
[skillMaxUpgradeCount](./bitburner.bladeburnerformulas.skillmaxupgradecount.md) is the inverse function of this one.
The function returns Infinity if the sum of the current level and count exceeds the maximum level.

View File

@@ -9,18 +9,15 @@ Get team size.
**Signature:**
```typescript
getTeamSize(
type?: BladeburnerActionType | `${BladeburnerActionType}`,
name?: BladeburnerActionName | `${BladeburnerActionName}`,
): number;
getTeamSize(type?: string, name?: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | _(Optional)_ Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | _(Optional)_ Name of action. Must be an exact match. |
| type | string | _(Optional)_ Type of action. |
| name | string | _(Optional)_ Name of action. Must be an exact match. |
**Returns:**

View File

@@ -9,19 +9,15 @@ Set an action autolevel.
**Signature:**
```typescript
setActionAutolevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
autoLevel: boolean,
): void;
setActionAutolevel(type: string, name: string, autoLevel: boolean): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| autoLevel | boolean | Whether or not to autolevel this action |
**Returns:**

View File

@@ -9,19 +9,15 @@ Set the level of an action.
**Signature:**
```typescript
setActionLevel(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
level: number,
): void;
setActionLevel(type: string, name: string, level: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| level | number | Level to set this action to. |
**Returns:**

View File

@@ -9,20 +9,16 @@ Set team size.
**Signature:**
```typescript
setTeamSize(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
size: number,
): number;
setTeamSize(type: string, name: string, size: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
| size | number | Number of team members to set. Must be a non-negative integer. |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match. |
| size | number | Number of team members to set. Will be converted using Math.round(). |
**Returns:**

View File

@@ -9,18 +9,15 @@ Start an action.
**Signature:**
```typescript
startAction(
type: BladeburnerActionType | `${BladeburnerActionType}`,
name: BladeburnerActionName | `${BladeburnerActionName}`,
): boolean;
startAction(type: string, name: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match |
| type | string | Type of action. |
| name | string | Name of action. Must be an exact match |
**Returns:**

View File

@@ -9,14 +9,14 @@ Upgrade skill.
**Signature:**
```typescript
upgradeSkill(skillName: BladeburnerSkillName | `${BladeburnerSkillName}`, count?: number): boolean;
upgradeSkill(skillName: string, count?: number): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Name of skill to be upgraded. Case-sensitive and must be an exact match. |
| skillName | string | Name of skill to be upgraded. Case-sensitive and must be an exact match. |
| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. |
**Returns:**

View File

@@ -1,18 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerActionName](./bitburner.bladeburneractionname.md)
## BladeburnerActionName type
**Signature:**
```typescript
export type BladeburnerActionName =
| BladeburnerGeneralActionName
| BladeburnerContractName
| BladeburnerOperationName
| BladeburnerBlackOpName;
```
**References:** [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)<!-- -->, [BladeburnerContractName](./bitburner.bladeburnercontractname.md)<!-- -->, [BladeburnerOperationName](./bitburner.bladeburneroperationname.md)<!-- -->, [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.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; [BladeburnerActionType](./bitburner.bladeburneractiontype.md)
## BladeburnerActionType enum
Action types of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerActionType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| BlackOp | <code>&quot;Black Operations&quot;</code> | |
| Contract | <code>&quot;Contracts&quot;</code> | |
| General | <code>&quot;General&quot;</code> | |
| Operation | <code>&quot;Operations&quot;</code> | |

View File

@@ -1,16 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md)
## BladeburnerActionTypeForSleeve type
**Signature:**
```typescript
export type BladeburnerActionTypeForSleeve =
| Exclude<BladeburnerGeneralActionName, BladeburnerGeneralActionName.InciteViolence>
| SpecialBladeburnerActionTypeForSleeve;
```
**References:** [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)<!-- -->, [BladeburnerGeneralActionName.InciteViolence](./bitburner.bladeburnergeneralactionname.md)<!-- -->, [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md)

View File

@@ -1,40 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md)
## BladeburnerBlackOpName enum
Black Operation names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerBlackOpName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| OperationAnnihilus | <code>&quot;Operation Annihilus&quot;</code> | |
| OperationArchangel | <code>&quot;Operation Archangel&quot;</code> | |
| OperationAres | <code>&quot;Operation Ares&quot;</code> | |
| OperationCenturion | <code>&quot;Operation Centurion&quot;</code> | |
| OperationDaedalus | <code>&quot;Operation Daedalus&quot;</code> | |
| OperationDeckard | <code>&quot;Operation Deckard&quot;</code> | |
| OperationHyron | <code>&quot;Operation Hyron&quot;</code> | |
| OperationIonStorm | <code>&quot;Operation Ion Storm&quot;</code> | |
| OperationJuggernaut | <code>&quot;Operation Juggernaut&quot;</code> | |
| OperationK | <code>&quot;Operation K&quot;</code> | |
| OperationMorpheus | <code>&quot;Operation Morpheus&quot;</code> | |
| OperationRedDragon | <code>&quot;Operation Red Dragon&quot;</code> | |
| OperationShoulderOfOrion | <code>&quot;Operation Shoulder of Orion&quot;</code> | |
| OperationTitan | <code>&quot;Operation Titan&quot;</code> | |
| OperationTyphoon | <code>&quot;Operation Typhoon&quot;</code> | |
| OperationTyrell | <code>&quot;Operation Tyrell&quot;</code> | |
| OperationUltron | <code>&quot;Operation Ultron&quot;</code> | |
| OperationVindictus | <code>&quot;Operation Vindictus&quot;</code> | |
| OperationWallace | <code>&quot;Operation Wallace&quot;</code> | |
| OperationX | <code>&quot;Operation X&quot;</code> | |
| OperationZero | <code>&quot;Operation Zero&quot;</code> | |

View File

@@ -1,22 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerContractName](./bitburner.bladeburnercontractname.md)
## BladeburnerContractName enum
Contract names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerContractName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| BountyHunter | <code>&quot;Bounty Hunter&quot;</code> | |
| Retirement | <code>&quot;Retirement&quot;</code> | |
| Tracking | <code>&quot;Tracking&quot;</code> | |

View File

@@ -9,20 +9,16 @@ Calculate the number of times that you can upgrade a skill.
**Signature:**
```typescript
skillMaxUpgradeCount(
name: BladeburnerSkillName | `${BladeburnerSkillName}`,
level: number,
skillPoints: number,
): number;
skillMaxUpgradeCount(name: string, level: number, skillPoints: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) \| \`${[BladeburnerSkillName](./bitburner.bladeburnerskillname.md)<!-- -->}\` | Skill name. It's case-sensitive and must be an exact match. |
| name | string | Skill name. It's case-sensitive and must be an exact match. |
| level | number | Skill level. It must be a non-negative number. |
| skillPoints | number | Number of skill points to upgrade the skill. It must be a non-negative number. |
| skillPoints | number | Number of skill points to upgrade the skill. It must be a positive number. |
**Returns:**

View File

@@ -1,25 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md)
## BladeburnerGeneralActionName enum
General action names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerGeneralActionName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Diplomacy | <code>&quot;Diplomacy&quot;</code> | |
| FieldAnalysis | <code>&quot;Field Analysis&quot;</code> | |
| HyperbolicRegen | <code>&quot;Hyperbolic Regeneration Chamber&quot;</code> | |
| InciteViolence | <code>&quot;Incite Violence&quot;</code> | |
| Recruitment | <code>&quot;Recruitment&quot;</code> | |
| Training | <code>&quot;Training&quot;</code> | |

View File

@@ -1,25 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerOperationName](./bitburner.bladeburneroperationname.md)
## BladeburnerOperationName enum
Operation names of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerOperationName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Assassination | <code>&quot;Assassination&quot;</code> | |
| Investigation | <code>&quot;Investigation&quot;</code> | |
| Raid | <code>&quot;Raid&quot;</code> | |
| StealthRetirement | <code>&quot;Stealth Retirement Operation&quot;</code> | |
| Sting | <code>&quot;Sting Operation&quot;</code> | |
| Undercover | <code>&quot;Undercover Operation&quot;</code> | |

View File

@@ -1,31 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerSkillName](./bitburner.bladeburnerskillname.md)
## BladeburnerSkillName enum
Skill names type of Bladeburner
**Signature:**
```typescript
declare enum BladeburnerSkillName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| BladesIntuition | <code>&quot;Blade's Intuition&quot;</code> | |
| Cloak | <code>&quot;Cloak&quot;</code> | |
| CybersEdge | <code>&quot;Cyber's Edge&quot;</code> | |
| Datamancer | <code>&quot;Datamancer&quot;</code> | |
| DigitalObserver | <code>&quot;Digital Observer&quot;</code> | |
| EvasiveSystem | <code>&quot;Evasive System&quot;</code> | |
| HandsOfMidas | <code>&quot;Hands of Midas&quot;</code> | |
| Hyperdrive | <code>&quot;Hyperdrive&quot;</code> | |
| Overclock | <code>&quot;Overclock&quot;</code> | |
| Reaper | <code>&quot;Reaper&quot;</code> | |
| ShortCircuit | <code>&quot;Short-Circuit&quot;</code> | |
| Tracer | <code>&quot;Tracer&quot;</code> | |

View File

@@ -9,14 +9,14 @@ Attempts a coding contract, returning a reward string on success or empty string
**Signature:**
```typescript
attempt(answer: any, filename: string, host?: string): string;
attempt(answer: string | number | any[], filename: string, host?: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| answer | any | Attempted solution for the contract. This can be a string formatted like submitting manually, or the answer in the format of the specific contract type. |
| answer | string \| number \| any\[\] | Attempted solution for the contract. |
| filename | string | Filename of the contract. |
| host | string | _(Optional)_ Hostname of the server containing the contract. Optional. Defaults to current server if not provided. |
@@ -36,9 +36,7 @@ Attempts to solve the Coding Contract with the provided solution.
```js
const reward = ns.codingcontract.attempt("[solution, as, a, string]", filename, hostname);
// or
const reward = ns.codingcontract.attempt(["answer", "as", "an", "array"], filename, hostname);
const reward = ns.codingcontract.attempt(yourSolution, filename, hostname);
if (reward) {
ns.tprint(`Contract solved successfully! Reward: ${reward}`);
} else {

View File

@@ -1,44 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContract](./bitburner.codingcontract.md) &gt; [getContract](./bitburner.codingcontract.getcontract.md)
## CodingContract.getContract() method
Get various data about a specific contract.
**Signature:**
```typescript
getContract(filename: string, host?: string): CodingContractObject;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filename | string | Filename of the contract. |
| host | string | _(Optional)_ Host of the server containing the contract. Optional. Default to the current server if not provided. |
**Returns:**
[CodingContractObject](./bitburner.codingcontractobject.md)
An object containing various data about the contract specified.
## Remarks
RAM cost: 15 GB
The returned object includes the type, data, description as well as methods for getting the number of tries remaining and submitting your answer. Depending on the type of the contract, the data is typed differently. Using type-narrowing, you can get the correct type of the data:
## Example
```js
const contract = ns.codingcontract.getContract(fileName, hostName);
if (contract.type === ns.enums.CodingContractName.FindLargestPrimeFactor) {
const data = contract.data;
// ^? data: number
}
```

View File

@@ -9,7 +9,7 @@ Get the type of a coding contract.
**Signature:**
```typescript
getContractType(filename: string, host?: string): `${CodingContractName}`;
getContractType(filename: string, host?: string): string;
```
## Parameters
@@ -21,7 +21,7 @@ getContractType(filename: string, host?: string): `${CodingContractName}`;
**Returns:**
\`${[CodingContractName](./bitburner.codingcontractname.md)<!-- -->}\`
string
Name describing the type of problem posed by the Coding Contract.

View File

@@ -9,13 +9,13 @@ List all contract types.
**Signature:**
```typescript
getContractTypes(): `${CodingContractName}`[];
getContractTypes(): string[];
```
**Returns:**
\`${[CodingContractName](./bitburner.codingcontractname.md)<!-- -->}\`\[\]
string\[\]
## Remarks
RAM cost: 0 GB
RAM cost: 2 GB

View File

@@ -9,7 +9,7 @@ Get the input data.
**Signature:**
```typescript
getData(filename: string, host?: string): any;
getData(filename: string, host?: string): CodingContractData;
```
## Parameters
@@ -21,7 +21,7 @@ getData(filename: string, host?: string): any;
**Returns:**
any
[CodingContractData](./bitburner.codingcontractdata.md)
The specified contracts data, data type depends on contract type.

View File

@@ -18,7 +18,6 @@ export interface CodingContract
| --- | --- |
| [attempt(answer, filename, host)](./bitburner.codingcontract.attempt.md) | Attempts a coding contract, returning a reward string on success or empty string on failure. |
| [createDummyContract(type)](./bitburner.codingcontract.createdummycontract.md) | Generate a dummy contract. |
| [getContract(filename, host)](./bitburner.codingcontract.getcontract.md) | Get various data about a specific contract. |
| [getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. |
| [getContractTypes()](./bitburner.codingcontract.getcontracttypes.md) | List all contract types. |
| [getData(filename, host)](./bitburner.codingcontract.getdata.md) | Get the input data. |

View File

@@ -1,15 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractAnswer](./bitburner.codingcontractanswer.md)
## CodingContractAnswer type
**Signature:**
```typescript
export type CodingContractAnswer<T extends string> = T extends `${keyof CodingContractSignatures}`
? CodingContractSignatures[T][1]
: any;
```
**References:** [CodingContractSignatures](./bitburner.codingcontractsignatures.md)

View File

@@ -4,12 +4,10 @@
## CodingContractData type
Coding contract data will differ depending on coding contract.
**Signature:**
```typescript
export type CodingContractData<T extends string> = T extends `${keyof CodingContractSignatures}`
? CodingContractSignatures[T][0]
: any;
type CodingContractData = any;
```
**References:** [CodingContractSignatures](./bitburner.codingcontractsignatures.md)

View File

@@ -1,45 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractName](./bitburner.codingcontractname.md)
## CodingContractName enum
**Signature:**
```typescript
declare enum CodingContractName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| AlgorithmicStockTraderI | <code>&quot;Algorithmic Stock Trader I&quot;</code> | |
| AlgorithmicStockTraderII | <code>&quot;Algorithmic Stock Trader II&quot;</code> | |
| AlgorithmicStockTraderIII | <code>&quot;Algorithmic Stock Trader III&quot;</code> | |
| AlgorithmicStockTraderIV | <code>&quot;Algorithmic Stock Trader IV&quot;</code> | |
| ArrayJumpingGame | <code>&quot;Array Jumping Game&quot;</code> | |
| ArrayJumpingGameII | <code>&quot;Array Jumping Game II&quot;</code> | |
| CompressionIIILZCompression | <code>&quot;Compression III: LZ Compression&quot;</code> | |
| CompressionIILZDecompression | <code>&quot;Compression II: LZ Decompression&quot;</code> | |
| CompressionIRLECompression | <code>&quot;Compression I: RLE Compression&quot;</code> | |
| EncryptionICaesarCipher | <code>&quot;Encryption I: Caesar Cipher&quot;</code> | |
| EncryptionIIVigenereCipher | <code>&quot;Encryption II: Vigenère Cipher&quot;</code> | |
| FindAllValidMathExpressions | <code>&quot;Find All Valid Math Expressions&quot;</code> | |
| FindLargestPrimeFactor | <code>&quot;Find Largest Prime Factor&quot;</code> | |
| GenerateIPAddresses | <code>&quot;Generate IP Addresses&quot;</code> | |
| HammingCodesEncodedBinaryToInteger | <code>&quot;HammingCodes: Encoded Binary to Integer&quot;</code> | |
| HammingCodesIntegerToEncodedBinary | <code>&quot;HammingCodes: Integer to Encoded Binary&quot;</code> | |
| MergeOverlappingIntervals | <code>&quot;Merge Overlapping Intervals&quot;</code> | |
| MinimumPathSumInATriangle | <code>&quot;Minimum Path Sum in a Triangle&quot;</code> | |
| Proper2ColoringOfAGraph | <code>&quot;Proper 2-Coloring of a Graph&quot;</code> | |
| SanitizeParenthesesInExpression | <code>&quot;Sanitize Parentheses in Expression&quot;</code> | |
| ShortestPathInAGrid | <code>&quot;Shortest Path in a Grid&quot;</code> | |
| SpiralizeMatrix | <code>&quot;Spiralize Matrix&quot;</code> | |
| SquareRoot | <code>&quot;Square Root&quot;</code> | |
| SubarrayWithMaximumSum | <code>&quot;Subarray with Maximum Sum&quot;</code> | |
| TotalWaysToSum | <code>&quot;Total Ways to Sum&quot;</code> | |
| TotalWaysToSumII | <code>&quot;Total Ways to Sum II&quot;</code> | |
| UniquePathsInAGridI | <code>&quot;Unique Paths in a Grid I&quot;</code> | |
| UniquePathsInAGridII | <code>&quot;Unique Paths in a Grid II&quot;</code> | |

View File

@@ -1,21 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractObject](./bitburner.codingcontractobject.md)
## CodingContractObject type
**Signature:**
```typescript
export type CodingContractObject = {
[T in keyof CodingContractSignatures]: {
type: T;
data: CodingContractSignatures[T][0];
submit: (answer: CodingContractSignatures[T][1] | string) => string;
description: string;
numTriesRemaining: () => number;
};
}[keyof CodingContractSignatures];
```
**References:** [CodingContractSignatures](./bitburner.codingcontractsignatures.md)

View File

@@ -1,42 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CodingContractSignatures](./bitburner.codingcontractsignatures.md)
## CodingContractSignatures type
**Signature:**
```typescript
export type CodingContractSignatures = {
[CodingContractName.FindLargestPrimeFactor]: [number, number];
[CodingContractName.SubarrayWithMaximumSum]: [number[], number];
[CodingContractName.TotalWaysToSum]: [number, number];
[CodingContractName.TotalWaysToSumII]: [[number, number[]], number];
[CodingContractName.SpiralizeMatrix]: [number[][], number[]];
[CodingContractName.ArrayJumpingGame]: [number[], 1 | 0];
[CodingContractName.ArrayJumpingGameII]: [number[], number];
[CodingContractName.MergeOverlappingIntervals]: [[number, number][], [number, number][]];
[CodingContractName.GenerateIPAddresses]: [string, string[]];
[CodingContractName.AlgorithmicStockTraderI]: [number[], number];
[CodingContractName.AlgorithmicStockTraderII]: [number[], number];
[CodingContractName.AlgorithmicStockTraderIII]: [number[], number];
[CodingContractName.AlgorithmicStockTraderIV]: [[number, number[]], number];
[CodingContractName.MinimumPathSumInATriangle]: [number[][], number];
[CodingContractName.UniquePathsInAGridI]: [[number, number], number];
[CodingContractName.UniquePathsInAGridII]: [(1 | 0)[][], number];
[CodingContractName.ShortestPathInAGrid]: [(1 | 0)[][], string];
[CodingContractName.SanitizeParenthesesInExpression]: [string, string[]];
[CodingContractName.FindAllValidMathExpressions]: [[string, number], string[]];
[CodingContractName.HammingCodesIntegerToEncodedBinary]: [number, string];
[CodingContractName.HammingCodesEncodedBinaryToInteger]: [string, number];
[CodingContractName.Proper2ColoringOfAGraph]: [[number, [number, number][]], (1 | 0)[]];
[CodingContractName.CompressionIRLECompression]: [string, string];
[CodingContractName.CompressionIILZDecompression]: [string, string];
[CodingContractName.CompressionIIILZCompression]: [string, string];
[CodingContractName.EncryptionICaesarCipher]: [[string, number], string];
[CodingContractName.EncryptionIIVigenereCipher]: [[string, string], string];
[CodingContractName.SquareRoot]: [bigint, bigint, [string, string]];
};
```
**References:** [CodingContractName.FindLargestPrimeFactor](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SubarrayWithMaximumSum](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.TotalWaysToSum](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.TotalWaysToSumII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SpiralizeMatrix](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.ArrayJumpingGame](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.ArrayJumpingGameII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.MergeOverlappingIntervals](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.GenerateIPAddresses](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderI](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderIII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.AlgorithmicStockTraderIV](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.MinimumPathSumInATriangle](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.UniquePathsInAGridI](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.UniquePathsInAGridII](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.ShortestPathInAGrid](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SanitizeParenthesesInExpression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.FindAllValidMathExpressions](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.HammingCodesIntegerToEncodedBinary](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.HammingCodesEncodedBinaryToInteger](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.Proper2ColoringOfAGraph](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.CompressionIRLECompression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.CompressionIILZDecompression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.CompressionIIILZCompression](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.EncryptionICaesarCipher](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.EncryptionIIVigenereCipher](./bitburner.codingcontractname.md)<!-- -->, [CodingContractName.SquareRoot](./bitburner.codingcontractname.md)

View File

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

View File

@@ -9,9 +9,8 @@ Company Work
**Signature:**
```typescript
export interface CompanyWorkTask extends BaseTask
export interface CompanyWorkTask
```
**Extends:** [BaseTask](./bitburner.basetask.md)
## Remarks
@@ -22,5 +21,6 @@ An object representing the current work for a company
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [companyName](./bitburner.companyworktask.companyname.md) | | [CompanyName](./bitburner.companyname.md) | |
| [cyclesWorked](./bitburner.companyworktask.cyclesworked.md) | | number | |
| [type](./bitburner.companyworktask.type.md) | | "COMPANY" | |

View File

@@ -4,13 +4,7 @@
## Corporation.bribe() method
Bribe a faction. You must satisfy these conditions:
- The corporation valuation must be greater than or equal to a threshold. You can use [getCorporation](./bitburner.corporation.getcorporation.md) and [getConstants](./bitburner.corporation.getconstants.md) to get this information.
- You must be a member of the specified faction.
- The specified faction must offer at least 1 type of work. You can use [getFactionWorkTypes](./bitburner.singularity.getfactionworktypes.md) to get the list of work types of a faction.
Bribe a faction.
**Signature:**

View File

@@ -1,30 +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; [canCreateCorporation](./bitburner.corporation.cancreatecorporation.md)
## Corporation.canCreateCorporation() method
Return whether the player can create a corporation. Does not require API access.
**Signature:**
```typescript
canCreateCorporation(selfFund: boolean): CreatingCorporationCheckResult;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| selfFund | boolean | true if you want to self-fund, false otherwise |
**Returns:**
[CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md)
Result of the check
## Remarks
RAM cost: 0 GB

View File

@@ -4,11 +4,7 @@
## Corporation.createCorporation() method
Create a Corporation. You should use [canCreateCorporation](./bitburner.corporation.cancreatecorporation.md) to check if you are unsure you can do it, because it throws an error in these cases:
- Use seed money outside BitNode 3.
- Be in a BitNode that has CorporationSoftcap (a BitNode modifier) less than 0.15.
Create a Corporation.
**Signature:**
@@ -20,7 +16,7 @@ createCorporation(corporationName: string, selfFund: boolean): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| corporationName | string | Name of the corporation. It must be a non-empty string. |
| corporationName | string | Name of the corporation |
| selfFund | boolean | If you want to self-fund. Defaults to true, false will only work in BitNode 3. |
**Returns:**
@@ -33,3 +29,9 @@ true if created and false if not
RAM cost: 20 GB
This function throws an error if:
- Try to self-fund outside BitNode 3.
- Be in a BitNode that has CorporationSoftcap (a BN modifier) less than 0.15. Use [getBitNodeMultipliers](./bitburner.ns.getbitnodemultipliers.md) to get the value of this modifier.

View File

@@ -4,7 +4,7 @@
## Corporation.hasCorporation() method
Return whether the player has a corporation. Does not require API access.
Returns whether the player has a corporation. Does not require API access.
**Signature:**

View File

@@ -18,10 +18,9 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| Method | Description |
| --- | --- |
| [acceptInvestmentOffer()](./bitburner.corporation.acceptinvestmentoffer.md) | Accept the investment offer. The value of offer is based on current corporation valuation. |
| [bribe(factionName, amountCash)](./bitburner.corporation.bribe.md) | <p>Bribe a faction. You must satisfy these conditions:</p><p>- The corporation valuation must be greater than or equal to a threshold. You can use [getCorporation](./bitburner.corporation.getcorporation.md) and [getConstants](./bitburner.corporation.getconstants.md) to get this information.</p><p>- You must be a member of the specified faction.</p><p>- The specified faction must offer at least 1 type of work. You can use [getFactionWorkTypes](./bitburner.singularity.getfactionworktypes.md) to get the list of work types of a faction.</p> |
| [bribe(factionName, amountCash)](./bitburner.corporation.bribe.md) | Bribe a faction. |
| [buyBackShares(amount)](./bitburner.corporation.buybackshares.md) | Buyback shares. Spend money from the player's wallet to transfer shares from public traders to the CEO. |
| [canCreateCorporation(selfFund)](./bitburner.corporation.cancreatecorporation.md) | Return whether the player can create a corporation. Does not require API access. |
| [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) | <p>Create a Corporation. You should use [canCreateCorporation](./bitburner.corporation.cancreatecorporation.md) to check if you are unsure you can do it, because it throws an error in these cases:</p><p>- Use seed money outside BitNode 3.</p><p>- Be in a BitNode that has CorporationSoftcap (a BitNode modifier) less than 0.15.</p> |
| [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) | Create a Corporation. |
| [expandCity(divisionName, city)](./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 corporation progress faster. |
@@ -35,7 +34,7 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| [getUpgradeLevel(upgradeName)](./bitburner.corporation.getupgradelevel.md) | Get the level of a levelable upgrade. |
| [getUpgradeLevelCost(upgradeName)](./bitburner.corporation.getupgradelevelcost.md) | Get the cost to unlock the next level of a levelable upgrade. |
| [goPublic(numShares)](./bitburner.corporation.gopublic.md) | Go public. |
| [hasCorporation()](./bitburner.corporation.hascorporation.md) | Return whether the player has a corporation. Does not require API access. |
| [hasCorporation()](./bitburner.corporation.hascorporation.md) | Returns whether the player has a corporation. Does not require API access. |
| [hasUnlock(upgradeName)](./bitburner.corporation.hasunlock.md) | Check if you have a one-time unlockable upgrade. |
| [issueDividends(rate)](./bitburner.corporation.issuedividends.md) | Issue dividends. |
| [issueNewShares(amount)](./bitburner.corporation.issuenewshares.md) | Issue new shares. |

View File

@@ -34,5 +34,4 @@ interface CorporationInfo
| [sharePrice](./bitburner.corporationinfo.shareprice.md) | | number | Price of the shares |
| [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) | | number | Cooldown until shares can be sold again |
| [totalShares](./bitburner.corporationinfo.totalshares.md) | | number | Total number of shares issued by this corporation. |
| [valuation](./bitburner.corporationinfo.valuation.md) | | number | Corporation valuation |

View File

@@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorporationInfo](./bitburner.corporationinfo.md) &gt; [valuation](./bitburner.corporationinfo.valuation.md)
## CorporationInfo.valuation property
Corporation valuation
**Signature:**
```typescript
valuation: number;
```

View File

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

View File

@@ -9,9 +9,8 @@ Create Program
**Signature:**
```typescript
export interface CreateProgramWorkTask extends BaseTask
export interface CreateProgramWorkTask
```
**Extends:** [BaseTask](./bitburner.basetask.md)
## Remarks
@@ -21,6 +20,7 @@ An object representing the status of the program being created
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [cyclesWorked](./bitburner.createprogramworktask.cyclesworked.md) | | number | |
| [programName](./bitburner.createprogramworktask.programname.md) | | string | |
| [type](./bitburner.createprogramworktask.type.md) | | "CREATE\_PROGRAM" | |

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; [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md)
## CreatingCorporationCheckResult enum
**Signature:**
```typescript
declare enum CreatingCorporationCheckResult
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| CorporationExists | <code>&quot;CorporationExists&quot;</code> | |
| DisabledBySoftCap | <code>&quot;DisabledBySoftCap&quot;</code> | |
| NoSf3OrDisabled | <code>&quot;NoSf3OrDisabled&quot;</code> | |
| Success | <code>&quot;Success&quot;</code> | |
| UseSeedMoneyOutsideBN3 | <code>&quot;UseSeedMoneyOutsideBN3&quot;</code> | |

View File

@@ -4,7 +4,7 @@
## CrimeStats.agility\_success\_weight property
Impact of agility level on success chance of the crime
agility level impact on success change of the crime
**Signature:**

View File

@@ -4,7 +4,7 @@
## CrimeStats.charisma\_success\_weight property
Impact of charisma level on success chance of the crime
charisma level impact on success change of the crime
**Signature:**

View File

@@ -4,7 +4,7 @@
## CrimeStats.defense\_success\_weight property
Impact of defense level on success chance of the crime
defense level impact on success change of the crime
**Signature:**

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