bitburner-src/markdown/bitburner.sleeve.purchasesleeveaug.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

34 lines
823 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [sleeve](./bitburner.sleeve.md) &gt; [purchaseSleeveAug](./bitburner.sleeve.purchasesleeveaug.md)
## sleeve.purchaseSleeveAug() method
Purchase an aug for a sleeve.
<b>Signature:</b>
```typescript
purchaseSleeveAug(sleeveNumber: number, augName: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to buy an aug for. |
| augName | string | Name of the aug to buy. Must be an exact match. |
<b>Returns:</b>
boolean
True if the aug was purchased and installed on the sleeve, false otherwise.
## Remarks
RAM cost: 4 GB
Return true if the aug was purchased and installed on the sleeve.