felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-18 23:38:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

0.47.3 patch 2 fix documentation (#810)

Browse Source
This commit is contained in:
hydroflame
2021-03-07 04:37:56 -05:00
committed by GitHub
parent e9dfe3c389
commit 4145ddad39
81 changed files with 132 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/netscript/sleeveapi/getInformation.rst
View File

@@ -2,12 +2,12 @@ getInformation() Netscript Function
=======================================
.. js:function:: getInformation(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve information. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a struct containing tons of information about this sleeve
:RAM cost: 4 GB
.. code-block:: javascript

4
doc/source/netscript/sleeveapi/getNumSleeves.rst
View File

@@ -3,6 +3,6 @@ getNumSleeves() Netscript Function
.. js:function:: getNumSleeves()
Return the number of duplicate sleeves the player has.
:RAM cost: 4 GB
Return the number of duplicate sleeves the player has.

4
doc/source/netscript/sleeveapi/getSleeveAugmentations.rst
View File

@@ -3,8 +3,8 @@ getSleeveAugmentations() Netscript Function
.. js:function:: getSleeveAugmentations(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve augmentations from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a list of augmentation names that this sleeve has installed.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/getSleevePurchasableAugs.rst
View File

@@ -2,12 +2,12 @@ getSleevePurchasableAugs() Netscript Function
=============================================
.. js:function:: getSleevePurchasableAugs(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve purchasable augmentations from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a list of augmentations that the player can buy for this sleeve.
:RAM cost: 4 GB
.. code-block:: javascript

4
doc/source/netscript/sleeveapi/getSleeveStats.rst
View File

@@ -3,11 +3,11 @@ getSleeveStats() Netscript Function
.. js:function:: getSleeveStats(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to get stats of. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a structure containing the stats of the sleeve
:RAM cost: 4 GB
.. code-block:: javascript

4
doc/source/netscript/sleeveapi/getTask.rst
View File

@@ -3,11 +3,11 @@ getTask() Netscript Function
.. js:function:: getTask(sleeveNumber)
:RAM cost: 4 GB
: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

4
doc/source/netscript/sleeveapi/purchaseSleeveAug.rst
View File

@@ -3,9 +3,9 @@ purchaseSleeveAug() Netscript Function
.. js:function:: purchaseSleeveAug(sleeveNumber, augName)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to buy an aug for. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string augName: Name of the aug to buy. Must be an exact match
Return true if the aug was purchased and installed on the sleeve.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToCommitCrime.rst
View File

@@ -3,11 +3,11 @@ setToCommitCrime() Netscript Function
.. js:function:: setToCommitCrime(sleeveNumber, name)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start commiting crime. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string name: Name of the crime. Must be an exact match.
Return a boolean indicating whether or not this action was set successfully.
Returns false if an invalid action is specified.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToCompanyWork.rst
View File

@@ -3,9 +3,9 @@ setToCompanyWork() Netscript Function
.. js:function:: setToCompanyWork(sleeveNumber, companyName)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to work for the company. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string companyName: Name of the company to work for.
Return a boolean indicating whether or not the sleeve started working or this company.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToFactionWork.rst
View File

@@ -3,10 +3,10 @@ setToFactionWork() Netscript Function
.. js:function:: setToFactionWork(sleeveNumber, factionName, factionWorkType)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to work for the faction. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string factionName: Name of the faction to work for.
:param string factionWorkType: Name of the action to perform for this faction.
Return a boolean indicating whether or not the sleeve started working or this faction.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToGymWorkout.rst
View File

@@ -3,10 +3,10 @@ setToGymWorkout() Netscript Function
.. js:function:: setToGymWorkout(sleeveNumber, gymName, stat)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to workout at the gym. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string gymName: Name of the gym.
:param string stat: Name of the stat to train.
Return a boolean indicating whether or not the sleeve started working out.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToShockRecovery.rst
View File

@@ -3,8 +3,8 @@ setToShockRecovery() Netscript Function
.. js:function:: setToShockRecovery(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start recovery. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a boolean indicating whether or not this action was set successfully.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToSynchronize.rst
View File

@@ -3,8 +3,8 @@ setToSynchronize() Netscript Function
.. js:function:: setToSynchronize(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start synchronizing. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a boolean indicating whether or not this action was set successfully.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/setToUniversityCourse.rst
View File

@@ -3,10 +3,10 @@ setToUniversityCourse() Netscript Function
.. js:function:: setToUniversityCourse(sleeveNumber, university, className)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start taking class. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string university: Name of the university to attend.
:param string className: Name of the class to follow.
Return a boolean indicating whether or not this action was set successfully.
:RAM cost: 4 GB

4
doc/source/netscript/sleeveapi/travel.rst
View File

@@ -3,9 +3,9 @@ travel() Netscript Function
.. js:function:: travel(sleeveNumber, cityName)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to travel. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string cityName: Name of the destination city.
Return a boolean indicating whether or not the sleeve reached destination.
:RAM cost: 4 GB