Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-22 07:33:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix changelog formatting

Browse Source
This commit is contained in:
Snarling 2023-01-02 17:14:41 -05:00 committed by GitHub
parent 6d72861304
commit 7a69639e8e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 62 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

131
doc/source/changelog.rst
View File

@ -8,99 +8,88 @@ v2.2.0 - Jan 2 2023 Development Reboot
Dev notes Dev notes
* The previous main developer, hydroflame, is stepping back from this project for the foreseeable future. * The previous main developer, hydroflame, is stepping back from this project for the foreseeable future. To facilitate this, we've moved the repo to a new location at https://github.com/bitburner-official/bitburner-src.
To facilitate this, we've moved the repo to a new location at https://github.com/bitburner-official/bitburner-src. * Sorry for the large number of API breaks in this version. To ease the pain here, attempting to use any of the removed functions will provide an error guiding you to the new replacement function to use instead.
* Sorry for the large number of API breaks in this version. To ease the pain here, attempting to use any of the
removed functions will provide an error guiding you to the new replacement function to use instead.
BREAKING API CHANGES: BREAKING API CHANGES:
* (ns2 only) ns functions use the 'this' value from ns: if you move the function to its own variable off of ns, it * (ns2 only) ns functions use the 'this' value from ns: if you move the function to its own variable off of ns, it needs to be bound to ns. The internal changes that make this necessary led to very large performance gains for running many scripts at once. e.g.:
needs to be bound to ns. e.g.:
const tprint1 = ns.tprint; // This doesn't work and will error out when calling tprint1();
const tprint = ns.tprint.bind(ns); // This works because the 'this' value is preserved.
The internal changes that make this necessary led to very large performance gains for running many scripts at once.
* ns.getPlayer no longer provides properties tor, inBladeburner, or hasCorporation. This information can be looked const tprint1 = ns.tprint; // This doesn't work and will error out when calling tprint1();
up using standlone functions: ns.hasTorRouter(), ns.bladeburner.inBladeburner(), ns.corporation.hasCorporation().
* Removed many functions, with replacement ways to get the same info. const tprint = ns.tprint.bind(ns); // This works because the 'this' value is preserved.
getServerRam: use getServerMaxRam and getServerUsedRam instead. * ns.getPlayer no longer provides properties tor, inBladeburner, or hasCorporation. This information can be looked up using standlone functions: ns.hasTorRouter(), ns.bladeburner.inBladeburner(), ns.corporation.hasCorporation().
corporation.assignJob: use setAutoJobAssignment instead. * Removed many functions, with replacement ways to get the same info.
corporation.getEmployee: No longer available (employees are not individual objects). * getServerRam: use getServerMaxRam and getServerUsedRam instead.
corporation.getExpandCityCost: use ns.corporation.getConstants().officeInitialCost * corporation.assignJob: use setAutoJobAssignment instead.
corporation.getExpandIndustryCost: use getIndustryData instead. * corporation.getEmployee: No longer available (employees are not individual objects).
corporation.getIndustryTypes: use ns.corporation.getConstants().industryNames * corporation.getExpandCityCost: use ns.corporation.getConstants().officeInitialCost
corporation.getMaterialNames: use ns.corporation.getConstants().materialNames * corporation.getExpandIndustryCost: use getIndustryData instead.
corporation.getPurchaseWarehouseCost: use ns.corporation.getConstants().warehouseInitialCost * corporation.getIndustryTypes: use ns.corporation.getConstants().industryNames
corporation.getResearchNames: use ns.corporation.getConstants().researchNames * corporation.getMaterialNames: use ns.corporation.getConstants().materialNames
corporation.getUnlockables: use ns.corporation.getConstants().unlockNames * corporation.getPurchaseWarehouseCost: use ns.corporation.getConstants().warehouseInitialCost
corporation.getUpgradeNames: use ns.corporation.getConstants().upgradeNames * corporation.getResearchNames: use ns.corporation.getConstants().researchNames
formulas.work.classGains: split into universityGains and gymGains * corporation.getUnlockables: use ns.corporation.getConstants().unlockNames
singularity.getAugmentationCost: use getAugmentationPrice and getAugmentationRepReq instead * corporation.getUpgradeNames: use ns.corporation.getConstants().upgradeNames
sleeve.getSleeveStats: use getSleeve instead * formulas.work.classGains: split into universityGains and gymGains
sleeve.getInformation: use getSleeve instead * singularity.getAugmentationCost: use getAugmentationPrice and getAugmentationRepReq instead
* sleeve.getSleeveStats: use getSleeve instead
* sleeve.getInformation: use getSleeve instead
* An error dialog will inform the player of the above API changes if the player tries to use one of the * An error dialog will inform the player of the above API changes if the player tries to use one of the removed functions above.
removed functions above. * enums.toast was renamed ToastVariant to provide consistency with internal code.
* enums.toast was renamed ToastVariant to provide consistency with internal code. * codingcontract.attempt always returns a string (empty string for a failed attempt). This may break player code if a direct boolean comparison (e.g. 'attemptResult === true') was being made. The string can be used directly as the conditional, because empty string evaluates to false as a boolean.
* codingcontract.attempt always returns a string (empty string for a failed attempt). This may break player code * corporation.getCorporation().divisions now returns an array of division names, instead of division objects. Use corporation.getDivision(name) to get the division info object.
if a direct boolean comparison (e.g. 'attemptResult === true') was being made. The string can be used directly as
the conditional, because empty string evaluates to false as a boolean.
* corporation.getCorporation().divisions now returns an array of division names, instead of division objects. Use
corporation.getDivision(name) to get the division info object.
DEVELOPMENT DEVELOPMENT
* Development repo moved to https://github.com/bitburner-official/bitburner-src * Development repo moved to https://github.com/bitburner-official/bitburner-src
* Dev version available on web at https://bitburner-official.github.io/bitburner-src/ * Dev version available on web at https://bitburner-official.github.io/bitburner-src/
* Development is active again for non-bugfix. * Development is active again for non-bugfix.
* A bunch of fixes, setup, and assistance related to moving to a new repo (@hydroflame) * A bunch of fixes, setup, and assistance related to moving to a new repo (@hydroflame)
TUTORIAL TUTORIAL
* Removed NS1/NS2 selection. Tutorial now only references .js files (NS1 is essentially deprecated) (@Mughur) * Removed NS1/NS2 selection. Tutorial now only references .js files (NS1 is essentially deprecated) (@Mughur)
* Fix Ram Text (by @jaculler) * Fix Ram Text (by @jaculler)
NETSCRIPT NETSCRIPT
* More enums and more types are exposed to the player instead of "magic strings"
* Added ns.pid property to access a script's PID without a function call. (@jeek) * Base NS API:
* Much faster API wrapping on script launch. (@d0sboots) To support this, ns functions need to keep their "this" * More enums and more types are exposed to the player instead of "magic strings", as type documentation and on ns.enums.
value from their parent object. * Added ns.pid property to access a script's PID without a function call. (@jeek)
* Expose more enums for player use under ns.enums (@Snarling) * Much faster API wrapping on script launch. (@d0sboots) To support this, ns functions need to keep their "this" value from their parent object.
* tFormat: Fix display for negative time * tFormat: Fix display for negative time
* ns.getPlayer: removed tor, inBladeburner, and hasCorporation properties * ns.getPlayer: removed tor, inBladeburner, and hasCorporation properties
* Added ns.hasTorRouter() function. * Added ns.hasTorRouter() function.
* CODING CONTRACT * Coding Contract API
* ns.codingcontract.attempt always returns a string. (@Snarling) * ns.codingcontract.attempt always returns a string. (@Snarling)
* CORPORATION * Corporation API
* Removed ns.corporation.getEmployee and ns.corporation.assignJob, due to employees no longer being objects. * Removed ns.corporation.getEmployee and ns.corporation.assignJob, due to employees no longer being objects.
* Added ns.corporation.hasCorporation(); * Added ns.corporation.hasCorporation()
* Reworked how ram costs are applied for corporation. * Reworked how ram costs are applied for corporation.
* FORMULAS * Formulas API
* ns.formulas.work.classGains removed, replaced with ns.formulas.work.universityGains and * ns.formulas.work.classGains removed, replaced with ns.formulas.work.universityGains and ns.formulas.work.gymGains (@Snarling)
ns.formulas.work.gymGains (@Snarling) * Add ns.formulas.work.companyGains function (@AlexeyKozhemiakin)
* Add ns.formulas.work.companyGains function (@AlexeyKozhemiakin) * Ports
* PORTS * added portHandle.nextWrite() (@LJNeon)
* added portHandle.nextWrite() (@LJNeon) * Make ns.writePort synchronous (@Snarling)
* Make ns.writePort synchronous (@Snarling) * Sleeve API
* SLEEVE * ns.sleeve.getSleeve added. getPlayer and getSleeve can both be used for formulas. (@Snarling)
* ns.sleeve.getSleeve added. getPlayer and getSleeve can both be used for formulas. (@Snarling) * getSleeve also includes storedCycles (i.e. bonusTime) (@zerbosh)
* getSleeve also includes storedCycles (i.e. bonusTime) (@zerbosh) * Stock API
* STOCK * ns.stock.getOrganization added for getting org from stock symbol (@SamuraiNinjaGuy)
* ns.stock.getOrganization added for getting org from stock symbol (@SamuraiNinjaGuy)
SCRIPTS SCRIPTS
* Fixed bug where zombie scripts could be created after a soft reset (@Snarling) | * Fixed bug where zombie scripts could be created after a soft reset (@Snarling)
* Scripts now have a maximum ram cost of 1024GB per thread. | * Scripts now have a maximum ram cost of 1024GB per thread.
SCRIPT LOGS SCRIPT LOGS
* Add ctrl-a support for selecting all text in tail window (@Snarling) | * Add ctrl-a support for selecting all text in tail window (@Snarling)
CORPORATION CORPORATION