bitburner-src/markdown/bitburner.ns.getservermoneyavailable.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

1013 B
Raw Blame History

Home > bitburner > NS > getServerMoneyAvailable

NS.getServerMoneyAvailable() method

Get money available on a server.

Signature:

getServerMoneyAvailable(host: string): number;

Parameters

Parameter Type Description
host string Hostname of target server.

Returns:

number

Amount of money available on the server.

Remarks

RAM cost: 0.1 GB

Returns the amount of money available on a server. Running this function on the home computer will return the players money.

Example 1

// NS1:
getServerMoneyAvailable("foodnstuff");
getServerMoneyAvailable("home"); //Returns player's money

Example 2

// NS2:
ns.getServerMoneyAvailable("foodnstuff");
ns.getServerMoneyAvailable("home"); // Returns player's money