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

33 lines
853 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- 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
If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.
Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isnt doing anything.
<b>Signature:</b>
```typescript
getTask(sleeveNumber: number): SleeveTask;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to retrieve task from. |
<b>Returns:</b>
[SleeveTask](./bitburner.sleevetask.md)
Object containing information the current task that the sleeve is performing.
## Remarks
RAM cost: 4 GB