mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-18 15:28:43 +02:00
Changed Sleeve API functions to prevent conflicts with identically-named functions
This commit is contained in:
@@ -1,11 +0,0 @@
|
||||
commitCrime() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: commitCrime(sleeveNumber, name)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to start commiting crime.
|
||||
: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.
|
||||
@@ -3,7 +3,7 @@ getInformation() Netscript Function
|
||||
|
||||
.. js:function:: getInformation(sleeveNumber)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to retrieve information.
|
||||
: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
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
getStats() Netscript Function
|
||||
=======================================
|
||||
getSleeveStats() Netscript Function
|
||||
===================================
|
||||
|
||||
.. js:function:: getStatus(sleeveNumber)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to get stats of.
|
||||
: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
|
||||
|
||||
@@ -3,7 +3,7 @@ getTask() Netscript Function
|
||||
|
||||
.. js:function:: getTask(sleeveNumber)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to retrieve task from.
|
||||
: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
|
||||
|
||||
|
||||
11
doc/source/netscript/sleeveapi/setToCommitCrime.rst
Normal file
11
doc/source/netscript/sleeveapi/setToCommitCrime.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
setToCommitCrime() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: setToCommitCrime(sleeveNumber, name)
|
||||
|
||||
: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.
|
||||
9
doc/source/netscript/sleeveapi/setToCompanyWork.rst
Normal file
9
doc/source/netscript/sleeveapi/setToCompanyWork.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
setToCompanyWork() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: setToCompanyWork(sleeveNumber, companyName)
|
||||
|
||||
: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.
|
||||
10
doc/source/netscript/sleeveapi/setToFactionWork.rst
Normal file
10
doc/source/netscript/sleeveapi/setToFactionWork.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
setToFactionWork() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: setToFactionWork(sleeveNumber, factionName, factionWorkType)
|
||||
|
||||
: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.
|
||||
10
doc/source/netscript/sleeveapi/setToGymWorkout.rst
Normal file
10
doc/source/netscript/sleeveapi/setToGymWorkout.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
setToGymWorkout() Netscript Function
|
||||
====================================
|
||||
|
||||
.. js:function:: setToGymWorkout(sleeveNumber, gymName, stat)
|
||||
|
||||
: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.
|
||||
8
doc/source/netscript/sleeveapi/setToShockRecovery.rst
Normal file
8
doc/source/netscript/sleeveapi/setToShockRecovery.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
setToShockRecovery() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: setToShockRecovery(sleeveNumber)
|
||||
|
||||
: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.
|
||||
8
doc/source/netscript/sleeveapi/setToSynchronize.rst
Normal file
8
doc/source/netscript/sleeveapi/setToSynchronize.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
setToSynchronize() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: setToSynchronize(sleeveNumber)
|
||||
|
||||
: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.
|
||||
10
doc/source/netscript/sleeveapi/setToUniversityCourse.rst
Normal file
10
doc/source/netscript/sleeveapi/setToUniversityCourse.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
setToUniversityCourse() Netscript Function
|
||||
==========================================
|
||||
|
||||
.. js:function:: setToUniversityCourse(sleeveNumber, university, className)
|
||||
|
||||
: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.
|
||||
@@ -1,8 +0,0 @@
|
||||
shockRecovery() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: shockRecovery(sleeveNumber)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to start recovery.
|
||||
|
||||
Return a boolean indicating whether or not this action was set successfully.
|
||||
@@ -1,8 +0,0 @@
|
||||
synchronize() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: synchronize(sleeveNumber)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to start synchronizing.
|
||||
|
||||
Return a boolean indicating whether or not this action was set successfully.
|
||||
@@ -1,10 +0,0 @@
|
||||
takeUniversityCourse() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: takeUniversityCourse(sleeveNumber, university, className)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to start taking class.
|
||||
: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.
|
||||
@@ -3,7 +3,7 @@ travel() Netscript Function
|
||||
|
||||
.. js:function:: travel(sleeveNumber, cityName)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to travel.
|
||||
:param string cityName: name of the destination city.
|
||||
: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.
|
||||
Return a boolean indicating whether or not the sleeve reached destination.
|
||||
|
||||
@@ -1,9 +0,0 @@
|
||||
workForCompany() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: workForCompany(sleeveNumber, companyName)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to work for the company.
|
||||
:param string companyName: name of the company to work for.
|
||||
|
||||
Return a boolean indicating whether or not the sleeve started working or this company.
|
||||
@@ -1,10 +0,0 @@
|
||||
workForFaction() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: workForFaction(sleeveNumber, factionName, factionWorkType)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to work for the faction.
|
||||
: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.
|
||||
@@ -1,10 +0,0 @@
|
||||
workoutAtGym() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: workoutAtGym(sleeveNumber, gymName, stat)
|
||||
|
||||
:param int sleeveNumber: index of the sleeve to workout at the gym.
|
||||
: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.
|
||||
Reference in New Issue
Block a user