From c7c582e9fa9e6008d5186a293622c5bfab15a1cb Mon Sep 17 00:00:00 2001 From: Olivier Gagnon Date: Sat, 16 Oct 2021 22:36:49 -0400 Subject: [PATCH] update doc --- doc/source/changelog.rst | 51 +++++++++++++++++++ doc/source/conf.py | 4 +- .../advancedfunctions/autocomplete.rst | 7 ++- doc/source/netscript/basicfunctions/toast.rst | 2 +- 4 files changed, 59 insertions(+), 5 deletions(-) diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index 3ef20dec6..d9d1bf35c 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -3,6 +3,57 @@ Changelog ========= +v0.57.0 - 2021-10-16 It was too cheap! (hydroflame & community) +------------------------------------------- + +** BREAKING (kindof) ** + +* purchased server cost now scales exponentially past 2^10. + I'm going to actually explain this one: Currently the cost of a 2^20GB server is 57b + Most players can get that before their first install. In an effort to nerf good players + a softcap was added. This softcap is different for every BN. + +** Script Editor ** + +* Added a theme that is close to monokai. Unfortunately a full monokai is impossible because + Monaco doesn't have a very good tokenizer. +* Opening a file and connecting to a new server will still save the file on the server that the file + was opened. + +** Netscript ** + +* New function: alert, which creates a textbox. +* New function: toast, creates a notification in the bottom right. +* New function: upgradeHomeCores (@Saynt_Garmo) +* New function: atExit, allows you to set a callback for when the script closes. +* New kindof function: autocomplete, this allows you to tell the game what it should + autocomplete on the terminal. + +** Augmentation ** + +* ENM Core (the Augmentation from The Black Hand with the highest rep cost) rep cost + reduced from 250 to 175. This will help new players transition from TBH to BitRunners more easily. + +** Bladeburner ** + +* New general action: Incite Violence. This action adds other action counts but increases chaos. + +** Misc. ** + +* Current bladeburner action is shown on the character overview. +* Fix blackop being #000 on #000. +* The last clicked Tail Box goes in front of the others. +* Fixed an issue where some values were loaded as 0 when they should be null. +* Implemented toasts. +* .msg are no longer saved in the text file. +* Tail boxes no longer display all the args, they use "..." after 30 characters. +* Fixed cancelation penalty bonus not being properly applied after the IP <-> hostname switch. +* Fixed an exploit where you could send non-strings or numbers to other scripts. +* Fixed issue when trying to work for a faction with a work type that doesn't exist while + already working for that faction. +* Fixed not being able to work for the CIA. (Don't ask) +* nerf noodle bar + v0.56.0 - 2021-10-11 Trimming the backlog (hydroflame & community) ------------------------------------------- diff --git a/doc/source/conf.py b/doc/source/conf.py index 180b87d5c..3d20e303f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -64,9 +64,9 @@ documentation_title = '{0} Documentation'.format(project) # built documents. # # The short X.Y version. -version = '0.56' +version = '0.57' # The full version, including alpha/beta/rc tags. -release = '0.56.0' +release = '0.57.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/source/netscript/advancedfunctions/autocomplete.rst b/doc/source/netscript/advancedfunctions/autocomplete.rst index c64020a82..be967e2e2 100644 --- a/doc/source/netscript/advancedfunctions/autocomplete.rst +++ b/doc/source/netscript/advancedfunctions/autocomplete.rst @@ -1,13 +1,13 @@ autocomplete() Netscript Function ============================ -.. warning:: This feature is not officially supported yet and the API might change. +.. warning:: This feature is not officially supported yet and the API might change. It is also only supported in ns2 .. js:function:: autocomplete(data, args) :RAM cost: 0 GB :param Object data: general data about the game you might want to autocomplete. - :param string[] args: current arguments. + :param string[] args: current arguments. Minus `run script.ns` data is an object with the following properties:: @@ -15,7 +15,10 @@ autocomplete() Netscript Function servers: list of all servers in the game. txts: list of all text files on the current server. scripts: list of all scripts on the current server. + flags: the same flags function as passed with ns. Calling this function adds all the flags as autocomplete arguments } + + This function is special as it must be declared as a top level function like `main`. Example: diff --git a/doc/source/netscript/basicfunctions/toast.rst b/doc/source/netscript/basicfunctions/toast.rst index 16a9443af..9a38bff78 100644 --- a/doc/source/netscript/basicfunctions/toast.rst +++ b/doc/source/netscript/basicfunctions/toast.rst @@ -7,7 +7,7 @@ toast() Netscript Function :param string message: message to display :param success|info|warning|error variant: color of the toast - Spawns a toast (those bottom left notifications). + Spawns a toast (those bottom right notifications). Example: