bitburner-src/markdown/bitburner.ns.getservermoneyavailable.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

39 lines
841 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
Returns the amount of money available on a server. Running this function on the home computer will return the players money.
<b>Signature:</b>
```typescript
getServerMoneyAvailable(host: Host): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| host | [Host](./bitburner.host.md) | Host or IP of target server |
<b>Returns:</b>
number
Amount of money available on the server.
## Remarks
0.1 GB
## Example
```js
getServerMoneyAvailable("foodnstuff");
getServerMoneyAvailable("home"); //Returns player's money
```