felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 07:18:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

0.47.3 patch 2 fix documentation (#810)

Browse Source
This commit is contained in:
hydroflame
2021-03-07 04:37:56 -05:00
committed by GitHub
parent e9dfe3c389
commit 4145ddad39
81 changed files with 132 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/netscript/hacknetnodeapi/getCacheUpgradeCost.rst
View File

@@ -5,6 +5,8 @@ getCacheUpgradeCost() Netscript Function
.. js:function:: getCacheUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade cache. Must be positive. Rounded to nearest integer
@@ -15,5 +17,3 @@ getCacheUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Server is already at the max cache level, then Infinity is returned.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/getCoreUpgradeCost.rst
View File

@@ -3,6 +3,8 @@ getCoreUpgradeCost() Netscript Function
.. js:function:: getCoreUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade cores. Must be positive. Rounded to nearest integer
@@ -10,5 +12,3 @@ getCoreUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Node is already at the max number of cores, then Infinity is returned.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/getLevelUpgradeCost.rst
View File

@@ -3,6 +3,8 @@ getLevelUpgradeCost() Netscript Function
.. js:function:: getLevelUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of levels to upgrade. Must be positive. Rounded to nearest integer
@@ -10,5 +12,3 @@ getLevelUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Node is already at max level, then Infinity is returned.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/getNodeStats.rst
View File

@@ -5,6 +5,8 @@ getNodeStats() Netscript Function
.. js:function:: getNodeStats(i)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
Returns an object containing a variety of stats about the specified Hacknet Node::
@@ -20,8 +22,6 @@ getNodeStats() Netscript Function
timeOnline: Number of seconds since Node has been purchased,
totalProduction: Total amount that the Node has produced
}
:RAM cost: 0 GB
.. note:: Note that for Hacknet Nodes, production refers to the amount of money the node generates.
For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount

4
doc/source/netscript/hacknetnodeapi/getPurchaseNodeCost.rst
View File

@@ -3,6 +3,6 @@ getPurchaseNodeCost() Netscript Function
.. js:function:: getPurchaseNodeCost()
Returns the cost of purchasing a new Hacknet Node
:RAM cost: 0 GB
Returns the cost of purchasing a new Hacknet Node

4
doc/source/netscript/hacknetnodeapi/getRamUpgradeCost.rst
View File

@@ -3,6 +3,8 @@ getRamUpgradeCost() Netscript Function
.. js:function:: getRamUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade RAM. Must be positive. Rounded to nearest integer
@@ -10,5 +12,3 @@ getRamUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Node is already at max RAM, then Infinity is returned.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/hashCost.rst
View File

@@ -5,6 +5,8 @@ hashCost() Netscript Function
.. js:function:: hashCost(upgName)
:RAM cost: 0 GB
:param string upgName: Name of upgrade to get the cost of. Must be an exact match
.. note:: This function is only applicable for Hacknet Servers (the upgraded version
@@ -12,8 +14,6 @@ hashCost() Netscript Function
Returns the number of hashes required for the specified upgrade. The name of the
upgrade must be an exact match.
:RAM cost: 0 GB
Example:

4
doc/source/netscript/hacknetnodeapi/numHashes.rst
View File

@@ -5,9 +5,9 @@ numHashes() Netscript Function
.. js:function:: numHashes()
:RAM cost: 0 GB
.. note:: This function is only applicable for Hacknet Servers (the upgraded version
of a Hacknet Node).
Returns the number of hashes you have
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/numNodes.rst
View File

@@ -3,6 +3,6 @@ numNodes() Netscript Function
.. js:function:: numNodes()
Returns the number of Hacknet Nodes you own.
:RAM cost: 0 GB
Returns the number of Hacknet Nodes you own.

4
doc/source/netscript/hacknetnodeapi/purchaseNode.rst
View File

@@ -3,11 +3,11 @@ purchaseNode() Netscript Function
.. js:function:: purchaseNode()
:RAM cost: 0 GB
Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node.
This index is equivalent to the number at the end of the Hacknet Node's name
(e.g The Hacknet Node named 'hacknet-node-4' will have an index of 4).
If the player cannot afford to purchase a new Hacknet Node then the function
will return -1.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/spendHashes.rst
View File

@@ -5,6 +5,8 @@ spendHashes() Netscript Function
.. js:function:: spendHashes(upgName, upgTarget)
:RAM cost: 0 GB
:param string upgName: Name of upgrade to spend hashes on. Must be an exact match
:param string upgTarget: Object to which upgrade applies. Required for certain upgrades
@@ -24,5 +26,3 @@ spendHashes() Netscript Function
hacknet.spendHashes("Sell for Corporation Funds");
hacknet.spendHashes("Increase Maximum Money", "foodnstuff");
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/upgradeCache.rst
View File

@@ -5,6 +5,8 @@ upgradeCache() Netscript Function
.. js:function:: upgradeCache(i, n)
:RAM cost: 0 GB
: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
@@ -17,5 +19,3 @@ upgradeCache() Netscript Function
it purchases some positive amount and the Server reaches its max cache level.
Returns false otherwise.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/upgradeCore.rst
View File

@@ -3,6 +3,8 @@ upgradeCore() Netscript Function
.. js:function:: upgradeCore(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of cores to purchase. Must be positive. Rounded to nearest integer
@@ -12,5 +14,3 @@ upgradeCore() Netscript Function
it purchases some positive amount and the Node reaches its max number of cores.
Returns false otherwise.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/upgradeLevel.rst
View File

@@ -3,6 +3,8 @@ upgradeLevel() Netscript Function
.. js:function:: upgradeLevel(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of levels to purchase. Must be positive. Rounded to nearest integer
@@ -12,5 +14,3 @@ upgradeLevel() Netscript Function
if it is upgraded by some positive amount and the Node reaches its max level.
Returns false otherwise.
:RAM cost: 0 GB

4
doc/source/netscript/hacknetnodeapi/upgradeRam.rst
View File

@@ -3,6 +3,8 @@ upgradeRam() Netscript Function
.. js:function:: upgradeRam(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade RAM. Must be positive. Rounded to nearest integer
@@ -14,5 +16,3 @@ upgradeRam() Netscript Function
it is upgraded some positive number of times and the Node reaches it max RAM.
Returns false otherwise.
:RAM cost: 0 GB