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

51 lines
1013 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [getServerMoneyAvailable](./bitburner.ns.getservermoneyavailable.md)
## NS.getServerMoneyAvailable() method
Get money available on a server.
<b>Signature:</b>
```typescript
getServerMoneyAvailable(host: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Hostname of target server. |
<b>Returns:</b>
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
```ts
// NS1:
getServerMoneyAvailable("foodnstuff");
getServerMoneyAvailable("home"); //Returns player's money
```
## Example 2
```ts
// NS2:
ns.getServerMoneyAvailable("foodnstuff");
ns.getServerMoneyAvailable("home"); // Returns player's money
```