From 8b526071132719edeeae7bfd2d3b2e702e3b9ea7 Mon Sep 17 00:00:00 2001 From: pigalot Date: Sun, 16 Jan 2022 16:13:45 +0000 Subject: [PATCH] Update docs after rebase --- dist/bitburner.d.ts | 164 +++- input/bitburner.api.json | 1317 +++++++++++++++++++++++++- markdown/bitburner.iport.clear.md | 13 - markdown/bitburner.iport.empty.md | 13 - markdown/bitburner.iport.full.md | 13 - markdown/bitburner.iport.md | 26 - markdown/bitburner.iport.peek.md | 13 - markdown/bitburner.iport.read.md | 13 - markdown/bitburner.iport.trywrite.md | 13 - markdown/bitburner.iport.write.md | 13 - markdown/bitburner.md | 1 - 11 files changed, 1473 insertions(+), 126 deletions(-) delete mode 100644 markdown/bitburner.iport.clear.md delete mode 100644 markdown/bitburner.iport.empty.md delete mode 100644 markdown/bitburner.iport.full.md delete mode 100644 markdown/bitburner.iport.md delete mode 100644 markdown/bitburner.iport.peek.md delete mode 100644 markdown/bitburner.iport.read.md delete mode 100644 markdown/bitburner.iport.trywrite.md delete mode 100644 markdown/bitburner.iport.write.md diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 4dc51389c..9b6fe3938 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -852,6 +852,74 @@ export declare interface CodingContract { * @public */ export declare interface Corporation extends WarehouseAPI, OfficeAPI { + /** + * Create a Corporation + * @param divisionName - Name of the division + * @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3 + * @returns true if created and false if not + */ + createCorporation(corporationName: string, selfFund: boolean): boolean; + /** + * Check if you have a one time unlockable upgrade + * @param upgradeName - Name of the upgrade + * @returns true if unlocked and false if not + */ + hasUnlockUpgrade(upgradeName: string): boolean; + /** + * Gets the cost to unlock a one time unlockable upgrade + * @param upgradeName - Name of the upgrade + * @returns cost of the upgrade + */ + getUnlockUpgradeCost(upgradeName: string): number; + /** + * Get the level of a levelable upgrade + * @param upgradeName - Name of the upgrade + * @returns the level of the upgrade + */ + getUpgradeLevel(upgradeName: string): number; + /** + * Gets the cost to unlock the next level of a levelable upgrade + * @param upgradeName - Name of the upgrade + * @returns cost of the upgrade + */ + getUpgradeLevelCost(upgradeName: string): number; + /** + * Gets the cost to expand into a new industry + * @param industryName - Name of the industry + * @returns cost + */ + getExpandIndustryCost(industryName: string): number; + /** + * Gets the cost to expand into a new city + * @returns cost + */ + getExpandCityCost(): number; + /** + * Get an offer for investment based on you companies current valuation + * @returns An offer of investment + */ + getInvestmentOffer(): InvestmentOffer; + /** + * Accept investment based on you companies current valuation + * @remarks + * Is based on current valuation and will not honer a specific Offer + * @returns An offer of investment + */ + acceptInvestmentOffer(): boolean; + /** + * Go public + * @param numShares - number of shares you would like to issue for your IPO + * @returns true if you successfully go public, false if not + */ + goPublic(numShares: number): boolean; + /** + * Bribe a faction + * @param factionName - Faction name + * @param amountCash - Amount of money to bribe + * @param amountShares - Amount of shares to bribe + * @returns True if successful, false if not + */ + bribe(factionName: string, amountCash: number, amountShares: number): boolean; /** * Get corporation data * @returns Corporation data @@ -876,7 +944,7 @@ export declare interface Corporation extends WarehouseAPI, OfficeAPI { */ expandCity(divisionName: string, cityName: string): void; /** - * Unlock an upgrade. + * Unlock an upgrade * @param upgradeName - Name of the upgrade */ unlockUpgrade(upgradeName: string): void; @@ -919,6 +987,8 @@ export declare interface CorporationInfo { sharePrice: number; /** State of the corporation. Possible states are START, PURCHASE, PRODUCTION, SALE, EXPORT. */ state: string; + /** Array of all divisions */ + divisions: Division[]; } /** @@ -997,6 +1067,8 @@ export declare interface Division { upgrades: number[]; /** Cities in which this division has expanded */ cities: string[]; + /** Products developed by this division */ + products: string[]; } /** @@ -2213,6 +2285,19 @@ export declare interface HacknetServersFormulas { constants(): HacknetServerConstants; } +/** + * Corporation investment offer + * @public + */ +export declare interface InvestmentOffer { + /** Amount of funds you will get from this investment */ + funds: number; + /** Amount of share you will give in exchange for this investment */ + shares: number; + /** Current round of funding (max 4) */ + round: number; +} + /** * Interface Styles * @internal @@ -2233,6 +2318,10 @@ export declare interface Material { qty: number; /** Quality of the material */ qlt: number; + /** Amount of material produced */ + prod: number; + /** Amount of material sold */ + sell: number; } /** @@ -4377,7 +4466,7 @@ export declare interface OfficeAPI { */ assignJob(divisionName: string, cityName: string, employeeName: string, job: string): Promise; /** - * Assign an employee to a job. + * Hire an employee. * @param divisionName - Name of the division * @param cityName - Name of the city * @returns The newly hired employee, if any @@ -4391,7 +4480,7 @@ export declare interface OfficeAPI { */ upgradeOfficeSize(divisionName: string, cityName: string, size: number): void; /** - * Assign an employee to a job. + * Throw a party for your employees * @param divisionName - Name of the division * @param cityName - Name of the city * @param costPerEmployee - Amount to spend per employee. @@ -4411,7 +4500,7 @@ export declare interface OfficeAPI { */ hireAdVert(divisionName: string): void; /** - * Hire AdVert. + * Purchase a research * @param divisionName - Name of the division * @param researchName - Name of the research */ @@ -4431,6 +4520,49 @@ export declare interface OfficeAPI { * @returns Employee data */ getEmployee(divisionName: string, cityName: string, employeeName: string): Employee; + /** + * Get the cost to Hire AdVert + * @param divisionName - Name of the division + * @returns Cost + */ + getHireAdVertCost(divisionName: string): number; + /** + * Get the number of times you have Hired AdVert + * @param divisionName - Name of the division + * @returns Number of times you have Hired AdVert + */ + getHireAdVertCount(adivisionName: string): number; + /** + * Get the cost to unlock research + * @param divisionName - Name of the division + * @param cityName - Name of the city + * @returns cost + */ + getResearchCost(divisionName: string, researchName: string): number; + /** + * Gets if you have unlocked a research + * @param divisionName - Name of the division + * @param cityName - Name of the city + * @returns true is unlocked, false if not + */ + hasResearched(divisionName: string, researchName: string): boolean; + /** + * Set the auto job assignment for a job + * @param divisionName - Name of the division + * @param cityName - Name of the city + * @param job - Name of the job + * @param amount - Number of employees to assign to that job + * @returns A promise that is fulfilled when the assignment is complete. + */ + setAutoJobAssignment(divisionName: string, cityName: string, job: string, amount: number): Promise; + /** + * Cost to Upgrade office size. + * @param divisionName - Name of the division + * @param cityName - Name of the city + * @param size - Amount of positions to open + * @returns Cost of upgrading the office + */ + getOfficeSizeUpgradeCost(divisionName: string, cityName: string, asize: number): number; } /** @@ -4533,6 +4665,7 @@ export declare interface Player { jobs: any; factions: string[]; tor: boolean; + hasCorporation: boolean; } /** @@ -4594,6 +4727,12 @@ export declare interface Product { pCost: number; /** Sell cost, can be "MP+5" */ sCost: string | number; + /** Data refers to the production, sale, and quantity of the products + * These values are specific to a city + * For each city, the data is [qty, prod, sell] */ + cityData: {[key: string]:number[]}; + /** Creation progress - A number between 0-100 representing percentage */ + developmentProgress: number; } /** @@ -6404,6 +6543,8 @@ export declare interface Warehouse { size: number; /** Used space in the warehouse */ sizeUsed: number; + /** Smart Supply status in the warehouse */ + smartSupplyEnabled: boolean; } /** @@ -6572,6 +6713,21 @@ export declare interface WarehouseAPI { designInvest: number, marketingInvest: number, ): void; + /** + * Gets the cost to purchase a warehouse + * @returns cost + */ + getPurchaseWarehouseCost(): number; + /** + * Gets the cost to upgrade a warehouse to the next level + * @returns cost to upgrade + */ + getUpgradeWarehouseCost(adivisionName: any, acityName: any): number; + /** + * Check if you have a warehouse in city + * @returns true if warehouse is present, false if not + */ + hasWarehouse(adivisionName: any, acityName: any): boolean; } export { } diff --git a/input/bitburner.api.json b/input/bitburner.api.json index 478af67a9..0d49c5fb9 100644 --- a/input/bitburner.api.json +++ b/input/bitburner.api.json @@ -5362,6 +5362,167 @@ "releaseTag": "Public", "name": "Corporation", "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#acceptInvestmentOffer:member(1)", + "docComment": "/**\n * Accept investment based on you companies current valuation\n *\n * @remarks\n *\n * Is based on current valuation and will not honer a specific Offer\n *\n * @returns An offer of investment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "acceptInvestmentOffer(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "acceptInvestmentOffer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#bribe:member(1)", + "docComment": "/**\n * Bribe a faction\n *\n * @param factionName - Faction name\n *\n * @param amountCash - Amount of money to bribe\n *\n * @param amountShares - Amount of shares to bribe\n *\n * @returns True if successful, false if not\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bribe(factionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", amountCash: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", amountShares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "factionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "amountCash", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "amountShares", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "bribe" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#createCorporation:member(1)", + "docComment": "/**\n * Create a Corporation\n *\n * @param divisionName - Name of the division\n *\n * @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3\n *\n * @returns true if created and false if not\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createCorporation(corporationName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", selfFund: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "corporationName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "selfFund", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "createCorporation" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!Corporation#expandCity:member(1)", @@ -5554,6 +5715,327 @@ ], "name": "getDivision" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#getExpandCityCost:member(1)", + "docComment": "/**\n * Gets the cost to expand into a new city\n *\n * @returns cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getExpandCityCost(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getExpandCityCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#getExpandIndustryCost:member(1)", + "docComment": "/**\n * Gets the cost to expand into a new industry\n *\n * @param industryName - Name of the industry\n *\n * @returns cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getExpandIndustryCost(industryName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "industryName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getExpandIndustryCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#getInvestmentOffer:member(1)", + "docComment": "/**\n * Get an offer for investment based on you companies current valuation\n *\n * @returns An offer of investment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInvestmentOffer(): " + }, + { + "kind": "Reference", + "text": "InvestmentOffer", + "canonicalReference": "bitburner!InvestmentOffer:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getInvestmentOffer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#getUnlockUpgradeCost:member(1)", + "docComment": "/**\n * Gets the cost to unlock a one time unlockable upgrade\n *\n * @param upgradeName - Name of the upgrade\n *\n * @returns cost of the upgrade\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUnlockUpgradeCost(upgradeName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgradeName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getUnlockUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#getUpgradeLevel:member(1)", + "docComment": "/**\n * Get the level of a levelable upgrade\n *\n * @param upgradeName - Name of the upgrade\n *\n * @returns the level of the upgrade\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUpgradeLevel(upgradeName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgradeName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getUpgradeLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#getUpgradeLevelCost:member(1)", + "docComment": "/**\n * Gets the cost to unlock the next level of a levelable upgrade\n *\n * @param upgradeName - Name of the upgrade\n *\n * @returns cost of the upgrade\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUpgradeLevelCost(upgradeName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgradeName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getUpgradeLevelCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#goPublic:member(1)", + "docComment": "/**\n * Go public\n *\n * @param numShares - number of shares you would like to issue for your IPO\n *\n * @returns true if you successfully go public, false if not\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "goPublic(numShares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "numShares", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "goPublic" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Corporation#hasUnlockUpgrade:member(1)", + "docComment": "/**\n * Check if you have a one time unlockable upgrade\n *\n * @param upgradeName - Name of the upgrade\n *\n * @returns true if unlocked and false if not\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasUnlockUpgrade(upgradeName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgradeName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hasUnlockUpgrade" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!Corporation#issueDividends:member(1)", @@ -5645,7 +6127,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!Corporation#unlockUpgrade:member(1)", - "docComment": "/**\n * Unlock an upgrade.\n *\n * @param upgradeName - Name of the upgrade\n */\n", + "docComment": "/**\n * Unlock an upgrade\n *\n * @param upgradeName - Name of the upgrade\n */\n", "excerptTokens": [ { "kind": "Content", @@ -5711,6 +6193,37 @@ "releaseTag": "Public", "name": "CorporationInfo", "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CorporationInfo#divisions:member", + "docComment": "/**\n * Array of all divisions\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "divisions: " + }, + { + "kind": "Reference", + "text": "Division", + "canonicalReference": "bitburner!Division:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "divisions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!CorporationInfo#expenses:member", @@ -6731,6 +7244,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Division#products:member", + "docComment": "/**\n * Products developed by this division\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "products: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "products", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!Division#research:member", @@ -14793,6 +15332,100 @@ ], "extendsTokenRanges": [] }, + { + "kind": "Interface", + "canonicalReference": "bitburner!InvestmentOffer:interface", + "docComment": "/**\n * Corporation investment offer\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface InvestmentOffer " + } + ], + "releaseTag": "Public", + "name": "InvestmentOffer", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!InvestmentOffer#funds:member", + "docComment": "/**\n * Amount of funds you will get from this investment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "funds: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "funds", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!InvestmentOffer#round:member", + "docComment": "/**\n * Current round of funding (max 4)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "round: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "round", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!InvestmentOffer#shares:member", + "docComment": "/**\n * Amount of share you will give in exchange for this investment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "shares", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, { "kind": "Interface", "canonicalReference": "bitburner!Material:interface", @@ -14832,6 +15465,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Material#prod:member", + "docComment": "/**\n * Amount of material produced\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "prod: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "prod", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!Material#qlt:member", @@ -14883,6 +15542,32 @@ "startIndex": 1, "endIndex": 2 } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Material#sell:member", + "docComment": "/**\n * Amount of material sold\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sell: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sell", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } } ], "extendsTokenRanges": [] @@ -21378,6 +22063,94 @@ ], "name": "getEmployee" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!OfficeAPI#getHireAdVertCost:member(1)", + "docComment": "/**\n * Get the cost to Hire AdVert\n *\n * @param divisionName - Name of the division\n *\n * @returns Cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHireAdVertCost(divisionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "divisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getHireAdVertCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!OfficeAPI#getHireAdVertCount:member(1)", + "docComment": "/**\n * Get the number of times you have Hired AdVert\n *\n * @param divisionName - Name of the division\n *\n * @returns Number of times you have Hired AdVert\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHireAdVertCount(adivisionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "adivisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getHireAdVertCount" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!OfficeAPI#getOffice:member(1)", @@ -21438,6 +22211,198 @@ ], "name": "getOffice" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!OfficeAPI#getOfficeSizeUpgradeCost:member(1)", + "docComment": "/**\n * Cost to Upgrade office size.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param size - Amount of positions to open\n *\n * @returns Cost of upgrading the office\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOfficeSizeUpgradeCost(divisionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", cityName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", asize: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "divisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "cityName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "asize", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getOfficeSizeUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!OfficeAPI#getResearchCost:member(1)", + "docComment": "/**\n * Get the cost to unlock research\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getResearchCost(divisionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", researchName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "divisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "researchName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getResearchCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!OfficeAPI#hasResearched:member(1)", + "docComment": "/**\n * Gets if you have unlocked a research\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns true is unlocked, false if not\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasResearched(divisionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", researchName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "divisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "researchName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "hasResearched" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!OfficeAPI#hireAdVert:member(1)", @@ -21485,7 +22450,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!OfficeAPI#hireEmployee:member(1)", - "docComment": "/**\n * Assign an employee to a job.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns The newly hired employee, if any\n */\n", + "docComment": "/**\n * Hire an employee.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @returns The newly hired employee, if any\n */\n", "excerptTokens": [ { "kind": "Content", @@ -21549,7 +22514,7 @@ { "kind": "MethodSignature", "canonicalReference": "bitburner!OfficeAPI#research:member(1)", - "docComment": "/**\n * Hire AdVert.\n *\n * @param divisionName - Name of the division\n *\n * @param researchName - Name of the research\n */\n", + "docComment": "/**\n * Purchase a research\n *\n * @param divisionName - Name of the division\n *\n * @param researchName - Name of the research\n */\n", "excerptTokens": [ { "kind": "Content", @@ -21605,10 +22570,104 @@ ], "name": "research" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!OfficeAPI#setAutoJobAssignment:member(1)", + "docComment": "/**\n * Set the auto job assignment for a job\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param job - Name of the job\n *\n * @param amount - Number of employees to assign to that job\n *\n * @returns A promise that is fulfilled when the assignment is complete.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setAutoJobAssignment(divisionName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", cityName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", job: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", amount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "divisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "cityName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "job", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "amount", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "setAutoJobAssignment" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!OfficeAPI#throwParty:member(1)", - "docComment": "/**\n * Assign an employee to a job.\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param costPerEmployee - Amount to spend per employee.\n *\n * @returns Amount of happiness increased.\n */\n", + "docComment": "/**\n * Throw a party for your employees\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param costPerEmployee - Amount to spend per employee.\n *\n * @returns Amount of happiness increased.\n */\n", "excerptTokens": [ { "kind": "Content", @@ -23147,6 +24206,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Player#hasCorporation:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasCorporation: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hasCorporation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!Player#hasTixApiAccess:member", @@ -24500,6 +25585,32 @@ "releaseTag": "Public", "name": "Product", "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Product#cityData:member", + "docComment": "/**\n * Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is [qty, prod, sell]\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cityData: " + }, + { + "kind": "Content", + "text": "{[key: string]:number[]}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cityData", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!Product#cmp:member", @@ -24526,6 +25637,32 @@ "endIndex": 2 } }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Product#developmentProgress:member", + "docComment": "/**\n * Creation progress - A number between 0-100 representing percentage\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "developmentProgress: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "developmentProgress", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, { "kind": "PropertySignature", "canonicalReference": "bitburner!Product#dmd:member", @@ -31651,6 +32788,32 @@ "startIndex": 1, "endIndex": 2 } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Warehouse#smartSupplyEnabled:member", + "docComment": "/**\n * Smart Supply status in the warehouse\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "smartSupplyEnabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "smartSupplyEnabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } } ], "extendsTokenRanges": [] @@ -32189,6 +33352,93 @@ ], "name": "getProduct" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!WarehouseAPI#getPurchaseWarehouseCost:member(1)", + "docComment": "/**\n * Gets the cost to purchase a warehouse\n *\n * @returns cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchaseWarehouseCost(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchaseWarehouseCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!WarehouseAPI#getUpgradeWarehouseCost:member(1)", + "docComment": "/**\n * Gets the cost to upgrade a warehouse to the next level\n *\n * @returns cost to upgrade\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUpgradeWarehouseCost(adivisionName: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", acityName: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "adivisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "acityName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getUpgradeWarehouseCost" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!WarehouseAPI#getWarehouse:member(1)", @@ -32249,6 +33499,65 @@ ], "name": "getWarehouse" }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!WarehouseAPI#hasWarehouse:member(1)", + "docComment": "/**\n * Check if you have a warehouse in city\n *\n * @returns true if warehouse is present, false if not\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasWarehouse(adivisionName: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": ", acityName: " + }, + { + "kind": "Content", + "text": "any" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "adivisionName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "acityName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "hasWarehouse" + }, { "kind": "MethodSignature", "canonicalReference": "bitburner!WarehouseAPI#makeProduct:member(1)", diff --git a/markdown/bitburner.iport.clear.md b/markdown/bitburner.iport.clear.md deleted file mode 100644 index 94b81b098..000000000 --- a/markdown/bitburner.iport.clear.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [clear](./bitburner.iport.clear.md) - -## IPort.clear property - -removes all data from port - -Signature: - -```typescript -clear: () => void; -``` diff --git a/markdown/bitburner.iport.empty.md b/markdown/bitburner.iport.empty.md deleted file mode 100644 index 28e84e351..000000000 --- a/markdown/bitburner.iport.empty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [empty](./bitburner.iport.empty.md) - -## IPort.empty property - -check if port is empty - -Signature: - -```typescript -empty: () => boolean; -``` diff --git a/markdown/bitburner.iport.full.md b/markdown/bitburner.iport.full.md deleted file mode 100644 index dde575071..000000000 --- a/markdown/bitburner.iport.full.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [full](./bitburner.iport.full.md) - -## IPort.full property - -check if port is full - -Signature: - -```typescript -full: () => boolean; -``` diff --git a/markdown/bitburner.iport.md b/markdown/bitburner.iport.md deleted file mode 100644 index 6eb648526..000000000 --- a/markdown/bitburner.iport.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) - -## IPort interface - -Interface of a netscript port - -Signature: - -```typescript -export interface IPort -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [clear](./bitburner.iport.clear.md) | () => void | removes all data from port | -| [empty](./bitburner.iport.empty.md) | () => boolean | check if port is empty | -| [full](./bitburner.iport.full.md) | () => boolean | check if port is full | -| [peek](./bitburner.iport.peek.md) | () => any | reads first element without removing it from port if no data in port returns "NULL PORT DATA" | -| [read](./bitburner.iport.read.md) | () => any | reads and removes first element from port if no data in port returns "NULL PORT DATA" | -| [tryWrite](./bitburner.iport.trywrite.md) | (value: any) => boolean | add data to port if not full. | -| [write](./bitburner.iport.write.md) | (value: any) => any | write data to the port and removes and returns first element if full | - diff --git a/markdown/bitburner.iport.peek.md b/markdown/bitburner.iport.peek.md deleted file mode 100644 index bb3f76344..000000000 --- a/markdown/bitburner.iport.peek.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [peek](./bitburner.iport.peek.md) - -## IPort.peek property - -reads first element without removing it from port if no data in port returns "NULL PORT DATA" - -Signature: - -```typescript -peek: () => any; -``` diff --git a/markdown/bitburner.iport.read.md b/markdown/bitburner.iport.read.md deleted file mode 100644 index 2c1f64bfa..000000000 --- a/markdown/bitburner.iport.read.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [read](./bitburner.iport.read.md) - -## IPort.read property - -reads and removes first element from port if no data in port returns "NULL PORT DATA" - -Signature: - -```typescript -read: () => any; -``` diff --git a/markdown/bitburner.iport.trywrite.md b/markdown/bitburner.iport.trywrite.md deleted file mode 100644 index 84a814822..000000000 --- a/markdown/bitburner.iport.trywrite.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [tryWrite](./bitburner.iport.trywrite.md) - -## IPort.tryWrite property - -add data to port if not full. - -Signature: - -```typescript -tryWrite: (value: any) => boolean; -``` diff --git a/markdown/bitburner.iport.write.md b/markdown/bitburner.iport.write.md deleted file mode 100644 index e88c227fb..000000000 --- a/markdown/bitburner.iport.write.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [IPort](./bitburner.iport.md) > [write](./bitburner.iport.write.md) - -## IPort.write property - -write data to the port and removes and returns first element if full - -Signature: - -```typescript -write: (value: any) => any; -``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 875fc15fa..98fb4585d 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -53,7 +53,6 @@ | [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants | | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas | | [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer | -| [IPort](./bitburner.iport.md) | Interface of a netscript port | | [Material](./bitburner.material.md) | Material in a warehouse | | [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. |