Files
bitburner-src/markdown/bitburner.cloud.md
gmcew 7c0286222c API: Move and rename purchased server functions to cloud API (#2367)
* Convert purchased server functions to cloud API

- Create `ns.cloud`
- Change `bitnode multipliers` and `server constants` wording for consistency
- change `server`, `ram` and `getting started` docs for consistency
- Added changes to 3.0.0 API Break and `setRemovedFunctions` in NetscriptFunctions.js

Tested by
- running tutorial `purchase-server-8gb.js`, and a more typical player one
- buying manually using vendor (Alpha Ent in Sector 12)
- deleting them all using script, and checked all deleted functions gave correct error
- Imported completed save to ensure auto-transfer of function work

* Revision in line with comments

- changed more `purchased` to `cloud` references
- Added BN mults auto-conversion

* Update getting_started.md

 - Corrected function names for new `cloud API`

* Don't show `cloud API` warning

v3.0.0 API break auto-replaces `cloud` functions, not warning suggested.

* API Break correction

- `cloud` affected API break replacement changed to be more descriptive and functional

* Fix typo and add empty lines

* Update many things (check commit's description)

- Comments
- Terminal message
- UI Text
- TSDoc
- md docs
- Improve error messages in src\NetscriptFunctions\Cloud.ts
2025-11-07 12:10:33 -08:00

129 lines
1.7 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Cloud](./bitburner.cloud.md)
## Cloud interface
Cloud API
**Signature:**
```typescript
export interface Cloud
```
## Methods
<table><thead><tr><th>
Method
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[deleteServer(host)](./bitburner.cloud.deleteserver.md)
</td><td>
Delete a cloud server.
</td></tr>
<tr><td>
[getRamLimit()](./bitburner.cloud.getramlimit.md)
</td><td>
Returns the maximum RAM that a cloud server can have.
</td></tr>
<tr><td>
[getServerCost(ram)](./bitburner.cloud.getservercost.md)
</td><td>
Get cost of purchasing a cloud server.
</td></tr>
<tr><td>
[getServerLimit()](./bitburner.cloud.getserverlimit.md)
</td><td>
Returns the maximum number of cloud servers you can purchase.
</td></tr>
<tr><td>
[getServerNames(returnOpts)](./bitburner.cloud.getservernames.md)
</td><td>
Returns an array with the hostnames or IP addresses of all of the cloud servers you have purchased. Returns hostnames by default.
</td></tr>
<tr><td>
[getServerUpgradeCost(host, ram)](./bitburner.cloud.getserverupgradecost.md)
</td><td>
Get cost of upgrading a cloud server to the given RAM.
</td></tr>
<tr><td>
[purchaseServer(hostname, ram)](./bitburner.cloud.purchaseserver.md)
</td><td>
Purchase a cloud server.
</td></tr>
<tr><td>
[renameServer(hostname, newName)](./bitburner.cloud.renameserver.md)
</td><td>
Rename a cloud server.
</td></tr>
<tr><td>
[upgradeServer(host, ram)](./bitburner.cloud.upgradeserver.md)
</td><td>
Upgrade a cloud server's RAM.
</td></tr>
</tbody></table>