doc for sleeve api

This commit is contained in:
Olivier Gagnon
2019-03-12 19:05:38 -04:00
committed by danielyxie
parent f8f4299ed5
commit b132efbded
16 changed files with 290 additions and 0 deletions
@@ -0,0 +1,21 @@
getStats() Netscript Function
=======================================
.. js:function:: getStatus(sleeveNumber)
:param int sleeveNumber: index of the sleeve to get stats of.
Return a structure containing the stats of the sleeve
.. code-block:: javascript
{
shock: current shock of the sleeve [0-1],
sync: current sync of the sleeve [0-1],
hacking_skill: current hacking skill of the sleeve,
strength: current strength of the sleeve,
defense: current defense of the sleeve,
dexterity: current dexterity of the sleeve,
agility: current agility of the sleeve,
charisma: current charisma of the sleeve,
}