bitburner-src/doc/source/netscript/basicfunctions/getServerRam.rst

26 lines
977 B
ReStructuredText
Raw Normal View History

getServerRam() Netscript Function
=================================
2021-03-12 08:51:56 +01:00
.. js:function:: getServerRam(hostname)
.. warning:: This function is deprecated. It still functions, but new
scripts should prefer :doc:`getServerMaxRam<getServerMaxRam>`
and :doc:`getServerUsedRam<getServerUsedRam>` instead.
:RAM cost: 0.1 GB
2021-03-12 08:51:56 +01:00
:param string hostname: Hostname of target server.
:returns: An array of 2 numbers; the first number is the total RAM, and the
second is the used RAM.
Returns an array with two elements that gives information about a server's memory (RAM). The first
element in the array is the amount of RAM that the server has total (in GB). The second element in
the array is the amount of RAM that is currently being used on the server (in GB).
2021-03-12 08:51:56 +01:00
Example:
2021-03-12 08:51:56 +01:00
.. code-block:: javascript
res = getServerRam("helios"); // returns: [5, 10]
totalRam = res[0];
ramUsed = res[1];