bitburner-src/markdown/bitburner.sleeve.getinformation.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

33 lines
829 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; [getInformation](./bitburner.sleeve.getinformation.md)
## Sleeve.getInformation() method
If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.
Return a struct containing tons of information about this sleeve
<b>Signature:</b>
```typescript
getInformation(sleeveNumber: number): SleeveInformation;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to retrieve information. |
<b>Returns:</b>
[SleeveInformation](./bitburner.sleeveinformation.md)
Object containing tons of information about this sleeve.
## Remarks
RAM cost: 4 GB