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

33 lines
859 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; [getTask](./bitburner.sleeve.gettask.md)
## sleeve.getTask() method
Get task of a sleeve.
<b>Signature:</b>
```typescript
getTask(sleeveNumber: number): SleeveTask | null;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to retrieve task from. |
<b>Returns:</b>
[SleeveTask](./bitburner.sleevetask.md) \| null
Object containing information for the current task that the sleeve is performing.
## Remarks
RAM cost: 4 GB
Return the current task that the sleeve is performing, or null if the sleeve is idle. All tasks have a "type" property, and other available properties depend on the type of task.