mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-18 23:38:35 +02:00
v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation
This commit is contained in:
11
doc/source/netscript/bladeburnerapi/getActionAutolevel.rst
Normal file
11
doc/source/netscript/bladeburnerapi/getActionAutolevel.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
getActionAutolevel() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: getActionAutolevel(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Return a boolean indicating whether or not this action is currently set to autolevel.
|
||||
|
||||
Returns false if an invalid action is specified.
|
||||
@@ -0,0 +1,12 @@
|
||||
getActionCountRemaining() Netscript Function
|
||||
============================================
|
||||
|
||||
.. js:function:: getActionCountRemaining(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Returns the remaining count of the specified action.
|
||||
|
||||
Note that this is meant to be used for Contracts and Operations.
|
||||
This function will return 'Infinity' for actions such as Training and Field Analysis.
|
||||
@@ -0,0 +1,11 @@
|
||||
getActionCurrentLevel() Netscript Function
|
||||
==========================================
|
||||
|
||||
.. js:function:: getActionCurrentLevel(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Returns the current level of this action.
|
||||
|
||||
Returns -1 if an invalid action is specified.
|
||||
@@ -0,0 +1,11 @@
|
||||
getActionEstimatedSuccessChance() Netscript Function
|
||||
====================================================
|
||||
|
||||
.. js:function:: getActionEstimatedSuccessChance(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Returns the estimated success chance for the specified action. This chance
|
||||
is returned as a decimal value, NOT a percentage (e.g. if you have an estimated
|
||||
success chance of 80%, then this function will return 0.80, NOT 80).
|
||||
11
doc/source/netscript/bladeburnerapi/getActionMaxLevel.rst
Normal file
11
doc/source/netscript/bladeburnerapi/getActionMaxLevel.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
getActionMaxLevel() Netscript Function
|
||||
======================================
|
||||
|
||||
.. js:function:: getActionMaxLevel(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Returns the maximum level for this action.
|
||||
|
||||
Returns -1 if an invalid action is specified.
|
||||
12
doc/source/netscript/bladeburnerapi/getActionRepGain.rst
Normal file
12
doc/source/netscript/bladeburnerapi/getActionRepGain.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
getActionRepGain() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: getActionRepGain(type, name[, level=current level])
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
:param number level: Optional action level at which to calculate the gain
|
||||
|
||||
Returns the average Bladeburner reputation gain for successfully completing
|
||||
the specified action. Note that this value is an 'average' and the real
|
||||
reputation gain may vary slightly from this value.
|
||||
9
doc/source/netscript/bladeburnerapi/getActionTime.rst
Normal file
9
doc/source/netscript/bladeburnerapi/getActionTime.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
getActionTime() Netscript Function
|
||||
==================================
|
||||
|
||||
.. js:function:: getActionTime(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Returns the number of seconds it takes to complete the specified action
|
||||
6
doc/source/netscript/bladeburnerapi/getBlackOpNames.rst
Normal file
6
doc/source/netscript/bladeburnerapi/getBlackOpNames.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
getBlackOpNames() Netscript Function
|
||||
====================================
|
||||
|
||||
.. js:function:: getBlackOpNames()
|
||||
|
||||
Returns an array of strings containing the names of all Bladeburner Black Ops
|
||||
14
doc/source/netscript/bladeburnerapi/getBonusTime.rst
Normal file
14
doc/source/netscript/bladeburnerapi/getBonusTime.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
getBonusTime() Netscript Function
|
||||
=================================
|
||||
|
||||
.. js:function:: getBonusTime()
|
||||
|
||||
Returns the amount of accumulated "bonus time" (seconds) for the Bladeburner mechanic.
|
||||
|
||||
"Bonus time" is accumulated when the game is offline or if the game is
|
||||
inactive in the browser.
|
||||
|
||||
"Bonus time" makes the game progress faster, up to 5x the normal speed.
|
||||
For example, if an action takes 30 seconds to complete but you've accumulated
|
||||
over 30 seconds in bonus time, then the action will only take 6 seconds
|
||||
in real life to complete.
|
||||
6
doc/source/netscript/bladeburnerapi/getCity.rst
Normal file
6
doc/source/netscript/bladeburnerapi/getCity.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
getCity() Netscript Function
|
||||
============================
|
||||
|
||||
.. js:function:: getCity()
|
||||
|
||||
Returns the city that the player is currently in (for Bladeburner).
|
||||
8
doc/source/netscript/bladeburnerapi/getCityChaos.rst
Normal file
8
doc/source/netscript/bladeburnerapi/getCityChaos.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
getCityChaos() Netscript Function
|
||||
=================================
|
||||
|
||||
.. js:function:: getCityChaos(cityName)
|
||||
|
||||
:param string cityName: Name of city. Case-sensitive
|
||||
|
||||
Returns the chaos in the specified city, or -1 if an invalid city was specified
|
||||
@@ -0,0 +1,9 @@
|
||||
getCityEstimatedCommunities() Netscript Function
|
||||
================================================
|
||||
|
||||
.. js:function:: getCityEstimatedCommunities(cityName)
|
||||
|
||||
:param string cityName: Name of city. Case-sensitive
|
||||
|
||||
Returns the estimated number of Synthoid communities in the specified city,
|
||||
or -1 if an invalid city was specified.
|
||||
@@ -0,0 +1,9 @@
|
||||
getCityEstimatedPopulation() Netscript Function
|
||||
===============================================
|
||||
|
||||
.. js:function:: getCityEstimatedPopulation(cityName)
|
||||
|
||||
:param string cityName: Name of city. Case-sensitive
|
||||
|
||||
Returns the estimated number of Synthoids in the specified city, or -1
|
||||
if an invalid city was specified.
|
||||
6
doc/source/netscript/bladeburnerapi/getContractNames.rst
Normal file
6
doc/source/netscript/bladeburnerapi/getContractNames.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
getContractNames() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: getContractNames()
|
||||
|
||||
Returns an array of strings containing the names of all Bladeburner contracts
|
||||
14
doc/source/netscript/bladeburnerapi/getCurrentAction.rst
Normal file
14
doc/source/netscript/bladeburnerapi/getCurrentAction.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
getCurrentAction() Netscript Function
|
||||
=====================================
|
||||
|
||||
.. js:function:: getCurrentAction()
|
||||
|
||||
Returns an object that represents the player's current Bladeburner action::
|
||||
|
||||
{
|
||||
type: Type of Action
|
||||
name: Name of Action
|
||||
}
|
||||
|
||||
If the player is not performing an action, the function will return an object
|
||||
with the 'type' property set to "Idle".
|
||||
@@ -0,0 +1,6 @@
|
||||
getGeneralActionNames() Netscript Function
|
||||
==========================================
|
||||
|
||||
.. js:function:: getGeneralActionNames()
|
||||
|
||||
Returns an array of strings containing the names of all general Bladeburner actions
|
||||
@@ -0,0 +1,6 @@
|
||||
getOperationNames() Netscript Function
|
||||
======================================
|
||||
|
||||
.. js:function:: getOperationNames()
|
||||
|
||||
Returns an array of strings containing the names of all Bladeburner operations
|
||||
6
doc/source/netscript/bladeburnerapi/getRank.rst
Normal file
6
doc/source/netscript/bladeburnerapi/getRank.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
getRank() Netscript Function
|
||||
============================
|
||||
|
||||
.. js:function:: getRank()
|
||||
|
||||
Returns the player's Bladeburner Rank
|
||||
10
doc/source/netscript/bladeburnerapi/getSkillLevel.rst
Normal file
10
doc/source/netscript/bladeburnerapi/getSkillLevel.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
getSkillLevel() Netscript Function
|
||||
==================================
|
||||
|
||||
.. js:function:: getSkillLevel(skillName="")
|
||||
|
||||
:param string skillName: Name of skill. Case-sensitive and must be an exact match
|
||||
|
||||
This function returns your level in the specified skill.
|
||||
|
||||
The function returns -1 if an invalid skill name is passed in
|
||||
6
doc/source/netscript/bladeburnerapi/getSkillNames.rst
Normal file
6
doc/source/netscript/bladeburnerapi/getSkillNames.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
getSkillNames() Netscript Function
|
||||
==================================
|
||||
|
||||
.. js:function:: getSkillNames()
|
||||
|
||||
Returns an array of strings containing the names of all Bladeburner skills
|
||||
6
doc/source/netscript/bladeburnerapi/getSkillPoints.rst
Normal file
6
doc/source/netscript/bladeburnerapi/getSkillPoints.rst
Normal file
@@ -0,0 +1,6 @@
|
||||
getSkillPoints() Netscript Function
|
||||
===================================
|
||||
|
||||
.. js:function:: getSkillPoints()
|
||||
|
||||
Returns the number of Bladeburner skill points you have
|
||||
11
doc/source/netscript/bladeburnerapi/getSkillUpgradeCost.rst
Normal file
11
doc/source/netscript/bladeburnerapi/getSkillUpgradeCost.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
getSkillUpgradeCost() Netscript Function
|
||||
========================================
|
||||
|
||||
.. js:function:: getSkillUpgradeCost(skillName="")
|
||||
|
||||
:param string skillName: Name of skill. Case-sensitive and must be an exact match
|
||||
|
||||
This function returns the number of skill points needed to upgrade the
|
||||
specified skill.
|
||||
|
||||
The function returns -1 if an invalid skill name is passed in.
|
||||
15
doc/source/netscript/bladeburnerapi/getStamina.rst
Normal file
15
doc/source/netscript/bladeburnerapi/getStamina.rst
Normal file
@@ -0,0 +1,15 @@
|
||||
getStamina() Netscript Function
|
||||
===============================
|
||||
|
||||
.. js:function:: getStamina()
|
||||
|
||||
Returns an array with two elements:
|
||||
|
||||
[Current stamina, Max stamina]
|
||||
|
||||
Example usage::
|
||||
|
||||
function getStaminaPercentage() {
|
||||
let res = bladeburner.getStamina();
|
||||
return res[0] / res[1];
|
||||
}
|
||||
13
doc/source/netscript/bladeburnerapi/getTeamSize.rst
Normal file
13
doc/source/netscript/bladeburnerapi/getTeamSize.rst
Normal file
@@ -0,0 +1,13 @@
|
||||
getTeamSize() Netscript Function
|
||||
================================
|
||||
|
||||
.. js:function:: getTeamSize(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Returns the number of Bladeburner team members you have assigned to the
|
||||
specified action.
|
||||
|
||||
Setting a team is only applicable for Operations and BlackOps. This function
|
||||
will return 0 for other action types.
|
||||
@@ -0,0 +1,11 @@
|
||||
joinBladeburnerDivision() Netscript Function
|
||||
============================================
|
||||
|
||||
.. js:function:: joinBladeburnerDivision()
|
||||
|
||||
Attempts to join the Bladeburner division.
|
||||
|
||||
Returns true if you successfully join the Bladeburner division, or if you
|
||||
are already a member.
|
||||
|
||||
Returns false otherwise
|
||||
@@ -0,0 +1,11 @@
|
||||
joinBladeburnerFaction() Netscript Function
|
||||
===========================================
|
||||
|
||||
.. js:function:: joinBladeburnerFaction()
|
||||
|
||||
Attempts to join the Bladeburner faction.
|
||||
|
||||
Returns true if you successfully join the Bladeburner faction, or if
|
||||
you are already a member.
|
||||
|
||||
Returns false otherwise.
|
||||
10
doc/source/netscript/bladeburnerapi/setActionAutolevel.rst
Normal file
10
doc/source/netscript/bladeburnerapi/setActionAutolevel.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
setActionAutolevel() Netscript Function
|
||||
=======================================
|
||||
|
||||
.. js:function:: setActionAutolevel(type, name, autoLevel)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
:param boolean autoLevel: Whether or not to autolevel this action
|
||||
|
||||
Enable/disable autoleveling for the specified action.
|
||||
10
doc/source/netscript/bladeburnerapi/setActionLevel.rst
Normal file
10
doc/source/netscript/bladeburnerapi/setActionLevel.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
setActionLevel() Netscript Function
|
||||
===================================
|
||||
|
||||
.. js:function:: setActionLevel(type, name, level)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
:param level int: Level to set this action to
|
||||
|
||||
Set the level for the specified action.
|
||||
12
doc/source/netscript/bladeburnerapi/setTeamSize.rst
Normal file
12
doc/source/netscript/bladeburnerapi/setTeamSize.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
setTeamSize() Netscript Function
|
||||
================================
|
||||
|
||||
.. js:function:: setTeamSize(type, name, size)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
:param int size: Number of team members to set. Will be converted using Math.round()
|
||||
|
||||
Set the team size for the specified Bladeburner action.
|
||||
|
||||
Returns the team size that was set, or -1 if the function failed.
|
||||
10
doc/source/netscript/bladeburnerapi/startAction.rst
Normal file
10
doc/source/netscript/bladeburnerapi/startAction.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
startAction() Netscript Function
|
||||
================================
|
||||
|
||||
.. js:function:: startAction(type, name)
|
||||
|
||||
:param string type: Type of action. See :ref:`bladeburner_action_types`
|
||||
:param string name: Name of action. Must be an exact match
|
||||
|
||||
Attempts to start the specified Bladeburner action. Returns true if the action
|
||||
was started successfully, and false otherwise.
|
||||
@@ -0,0 +1,6 @@
|
||||
stopBladeburnerAction() Netscript Function
|
||||
==========================================
|
||||
|
||||
.. js:function:: stopBladeburnerAction()
|
||||
|
||||
Stops the current Bladeburner action
|
||||
10
doc/source/netscript/bladeburnerapi/switchCity.rst
Normal file
10
doc/source/netscript/bladeburnerapi/switchCity.rst
Normal file
@@ -0,0 +1,10 @@
|
||||
switchCity() Netscript Function
|
||||
===============================
|
||||
|
||||
.. js:function:: switchCity(cityName)
|
||||
|
||||
:param string cityName: Name of city
|
||||
|
||||
Attempts to switch to the specified city (for Bladeburner only).
|
||||
|
||||
Returns true if successful, and false otherwise
|
||||
9
doc/source/netscript/bladeburnerapi/upgradeSkill.rst
Normal file
9
doc/source/netscript/bladeburnerapi/upgradeSkill.rst
Normal file
@@ -0,0 +1,9 @@
|
||||
upgradeSkill() Netscript Function
|
||||
=================================
|
||||
|
||||
.. js:function:: upgradeSkill(skillName)
|
||||
|
||||
:param string skillName: Name of Skill to be upgraded. Case-sensitive and must be an exact match
|
||||
|
||||
Attempts to upgrade the specified Bladeburner skill. Returns true if the
|
||||
skill is successfully upgraded, and false otherwise
|
||||
Reference in New Issue
Block a user