Updated Hacknet Node API documentation for the BN-9 changes. netscript functions now properly fail for Hacknet Servers

This commit is contained in:
danielyxie
2019-03-30 19:53:57 -07:00
parent b6b6d8e9fa
commit 804e4c23e3
5 changed files with 117 additions and 118 deletions

View File

@@ -0,0 +1,19 @@
upgradeCache() Netscript Function
=================================
.. warning:: This page contains spoilers for the game
.. js:function:: upgradeCache(i, n)
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of cache levels to purchase. Must be positive. Rounded to nearest integer
.. note:: This function is only applicable for Hacknet Servers (the upgraded version of
a Hacknet Node).
Tries to upgrade the specified Hacknet Server's cache *n* times.
Returns true if it successfully upgrades the Server's cache *n* times, or if
it purchases some positive amount and the Server reaches its max cache level.
Returns false otherwise.