some documentation

This commit is contained in:
Olivier Gagnon 2021-11-09 23:46:22 -05:00
parent c87e9bdf84
commit 57cec546f0
5 changed files with 10 additions and 28 deletions

@ -8,7 +8,8 @@ v1.0.0 - 2021-11-10 Breaking the API :( (blame hydroflame)
** Announcement ** ** Announcement **
* Several API breaks have been implemented, a guide was written to help players migrate. * Several API breaks have been implemented.
* See the v1.0.0 migration guide https://bitburner.readthedocs.io/en/latest/v1.0.0_migration.html
* Everyone gets 10 free neuroflux level. * Everyone gets 10 free neuroflux level.
** Netscript ** ** Netscript **

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

@ -283,32 +283,11 @@ export const CONSTANTS: {
TotalNumBitNodes: 24, TotalNumBitNodes: 24,
LatestUpdate: ` LatestUpdate: `
v1.0.0 - 2021-XX-XX Pre-Steam v1.0.0 - 2021-11-10 Breaking the API :(
------------------------------------------- -----------------------------
** API BREAKS ** This update is very important. Please see the patch notes at
https://bitburner.readthedocs.io/en/latest/changelog.html
* bladeburner.getActionTime will return milliseconds instead of seconds.
* getHackTime will return milliseconds instead of seconds.
* getGrowTime will return milliseconds instead of seconds.
* getWeakenTime will return milliseconds instead of seconds.
* hackAnalyzePercent renamed to hackAnalyze
* hackAnalyzePercent will return decimal instead of percentage
* hackChance (not formulas.basic.hackChance) renamed to hackAnalyzeChance
* getPurchasedServers won't let you query for ips instead of hostnames.
* getStats is deprecated in favor getPlayer
* getCharacterInformation is deprecated in favor getPlayer
* getServerRam deprecated in favor of getServerMaxRam and getServerUsedRam
* getServerBaseSecurityLevel will be deprecated in favor of nothing, it's not really used.
* sleep can no longer be called simultenaously, a new function called asleep will let you.
* write returns promise (needs to be awaited).
* scp returns a promise (needs to be awaited).
* free port, write, read
* write, read does not support port anymore, writePort and readPort does.
** Misc. **
* nerf noodle bar
`, `,
}; };

@ -318,6 +318,8 @@ function loadGame(saveString: string): boolean {
createBetaUpdateText(); createBetaUpdateText();
} else if (ver !== CONSTANTS.VersionNumber) { } else if (ver !== CONSTANTS.VersionNumber) {
createNewUpdateText(); createNewUpdateText();
createNewUpdateText();
createNewUpdateText();
} }
} catch (e) { } catch (e) {
createNewUpdateText(); createNewUpdateText();