bitburner-src/doc/source/netscript/sleeveapi/getTask.rst
hydroflame e9dfe3c389
v0.47.3 (#808)
* Updated ram cost of documentation

* v0.47.3

Co-authored-by: Samuel A. Lamb <samuei@users.noreply.github.com>
2021-03-07 04:13:37 -05:00

21 lines
765 B
ReStructuredText

getTask() Netscript Function
=======================================
.. js:function:: getTask(sleeveNumber)
:param int sleeveNumber: Index of the sleeve to retrieve task from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return the current task that the sleeve is performing. type is set to "Idle" if the sleeve isn't doing anything
:RAM cost: 4 GB
.. code-block:: javascript
{
task: string, // task type
crime: string, // crime currently attempting, if any
location: string, // location of the task, if any
gymStatType: string, // stat being trained at the gym, if any
factionWorkType: string, // faction work type being performed, if any
}