Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-18 05:33:54 +01:00
Code Issues Packages Projects Releases Wiki Activity
93aab87a16
bitburner-src/markdown/bitburner.sleeve.getsleeve.md

33 lines
697 B
Markdown
Raw Normal View History

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 18:07:22 +01:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
Fix documentation for ns.sleeve (#227)
2022-11-24 14:19:51 +01:00
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Sleeve](./bitburner.sleeve.md) &gt; [getSleeve](./bitburner.sleeve.getsleeve.md)
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 18:07:22 +01:00
Fix documentation for ns.sleeve (#227)
2022-11-24 14:19:51 +01:00
## Sleeve.getSleeve() method
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 18:07:22 +01:00
Get information about a sleeve.
<b>Signature:</b>
```typescript
Fix documentation for ns.sleeve (#227)
2022-11-24 14:19:51 +01:00
getSleeve(sleeveNumber: number): SleevePerson;
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 18:07:22 +01:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to retrieve information. |
<b>Returns:</b>
Fix documentation for ns.sleeve (#227)
2022-11-24 14:19:51 +01:00
[SleevePerson](./bitburner.sleeveperson.md)
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 18:07:22 +01:00
Object containing information about this sleeve.
## Remarks
RAM cost: 4 GB
Return a person object for this sleeve
Reference in New Issue Copy Permalink