Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-18 04:05:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix documentation for Bladeburner API.

Browse Source
This commit is contained in:
Olivier Gagnon 2021-03-11 16:48:00 -05:00
parent 0483c809ff
commit e7dbc08e18
35 changed files with 37 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/netscript/bladeburnerapi/getActionAutolevel.rst
View File

@ -2,6 +2,7 @@ getActionAutolevel() Netscript Function
=======================================
.. js:function:: getActionAutolevel(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getActionCountRemaining.rst
View File

@ -2,6 +2,7 @@ getActionCountRemaining() Netscript Function
============================================
.. js:function:: getActionCountRemaining(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getActionCurrentLevel.rst
View File

@ -2,6 +2,7 @@ getActionCurrentLevel() Netscript Function
==========================================
.. js:function:: getActionCurrentLevel(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getActionEstimatedSuccessChance.rst
View File

@ -2,6 +2,7 @@ getActionEstimatedSuccessChance() Netscript Function
====================================================
.. js:function:: getActionEstimatedSuccessChance(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getActionMaxLevel.rst
View File

@ -2,6 +2,7 @@ getActionMaxLevel() Netscript Function
======================================
.. js:function:: getActionMaxLevel(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getActionRepGain.rst
View File

@ -2,6 +2,7 @@ getActionRepGain() Netscript Function
=====================================
.. js:function:: getActionRepGain(type, name[, level=current level])
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getActionTime.rst
View File

@ -2,6 +2,7 @@ getActionTime() Netscript Function
==================================
.. js:function:: getActionTime(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/getBlackOpNames.rst
View File

@ -2,6 +2,7 @@ getBlackOpNames() Netscript Function
====================================
.. js:function:: getBlackOpNames()
:RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner Black Ops

1
doc/source/netscript/bladeburnerapi/getBlackOpRank.rst
View File

@ -2,6 +2,7 @@ getBlackOpRank() Netscript Function
====================================
.. js:function:: getBlackOpRank(name)
:RAM cost: 2 GB
:param string name: name of the BlackOp. Must be an exact match.

1
doc/source/netscript/bladeburnerapi/getBonusTime.rst
View File

@ -2,6 +2,7 @@ getBonusTime() Netscript Function
=================================
.. js:function:: getBonusTime()
:RAM cost: 0 GB
Returns the amount of accumulated "bonus time" (seconds) for the Bladeburner mechanic.

1
doc/source/netscript/bladeburnerapi/getCity.rst
View File

@ -2,6 +2,7 @@ getCity() Netscript Function
============================
.. js:function:: getCity()
:RAM cost: 4 GB
Returns the city that the player is currently in (for Bladeburner).

1
doc/source/netscript/bladeburnerapi/getCityChaos.rst
View File

@ -2,6 +2,7 @@ getCityChaos() Netscript Function
=================================
.. js:function:: getCityChaos(cityName)
:RAM cost: 4 GB
:param string cityName: Name of city. Case-sensitive

1
doc/source/netscript/bladeburnerapi/getCityEstimatedCommunities.rst
View File

@ -2,6 +2,7 @@ getCityEstimatedCommunities() Netscript Function
================================================
.. js:function:: getCityEstimatedCommunities(cityName)
:RAM cost: 4 GB
:param string cityName: Name of city. Case-sensitive

1
doc/source/netscript/bladeburnerapi/getCityEstimatedPopulation.rst
View File

@ -2,6 +2,7 @@ getCityEstimatedPopulation() Netscript Function
===============================================
.. js:function:: getCityEstimatedPopulation(cityName)
:RAM cost: 4 GB
:param string cityName: Name of city. Case-sensitive

1
doc/source/netscript/bladeburnerapi/getContractNames.rst
View File

@ -2,6 +2,7 @@ getContractNames() Netscript Function
=====================================
.. js:function:: getContractNames()
:RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner contracts

1
doc/source/netscript/bladeburnerapi/getCurrentAction.rst
View File

@ -2,6 +2,7 @@ getCurrentAction() Netscript Function
=====================================
.. js:function:: getCurrentAction()
:RAM cost: 1 GB
Returns an object that represents the player's current Bladeburner action::

1
doc/source/netscript/bladeburnerapi/getGeneralActionNames.rst
View File

@ -2,6 +2,7 @@ getGeneralActionNames() Netscript Function
==========================================
.. js:function:: getGeneralActionNames()
:RAM cost: 0.4 GB
Returns an array of strings containing the names of all general Bladeburner actions

1
doc/source/netscript/bladeburnerapi/getOperationNames.rst
View File

@ -2,6 +2,7 @@ getOperationNames() Netscript Function
======================================
.. js:function:: getOperationNames()
:RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner operations

1
doc/source/netscript/bladeburnerapi/getRank.rst
View File

@ -2,6 +2,7 @@ getRank() Netscript Function
============================
.. js:function:: getRank()
:RAM cost: 4 GB
Returns the player's Bladeburner Rank

1
doc/source/netscript/bladeburnerapi/getSkillLevel.rst
View File

@ -2,6 +2,7 @@ getSkillLevel() Netscript Function
==================================
.. js:function:: getSkillLevel(skillName="")
:RAM cost: 4 GB
:param string skillName: Name of skill. Case-sensitive and must be an exact match

1
doc/source/netscript/bladeburnerapi/getSkillNames.rst
View File

@ -2,6 +2,7 @@ getSkillNames() Netscript Function
==================================
.. js:function:: getSkillNames()
:RAM cost: 0.4 GB
Returns an array of strings containing the names of all Bladeburner skills

1
doc/source/netscript/bladeburnerapi/getSkillPoints.rst
View File

@ -2,6 +2,7 @@ getSkillPoints() Netscript Function
===================================
.. js:function:: getSkillPoints()
:RAM cost: 4 GB
Returns the number of Bladeburner skill points you have

1
doc/source/netscript/bladeburnerapi/getSkillUpgradeCost.rst
View File

@ -2,6 +2,7 @@ getSkillUpgradeCost() Netscript Function
========================================
.. js:function:: getSkillUpgradeCost(skillName="")
:RAM cost: 4 GB
:param string skillName: Name of skill. Case-sensitive and must be an exact match

1
doc/source/netscript/bladeburnerapi/getStamina.rst
View File

@ -2,6 +2,7 @@ getStamina() Netscript Function
===============================
.. js:function:: getStamina()
:RAM cost: 4 GB
Returns an array with two elements:

1
doc/source/netscript/bladeburnerapi/getTeamSize.rst
View File

@ -2,6 +2,7 @@ getTeamSize() Netscript Function
================================
.. js:function:: getTeamSize(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/joinBladeburnerDivision.rst
View File

@ -2,6 +2,7 @@ joinBladeburnerDivision() Netscript Function
============================================
.. js:function:: joinBladeburnerDivision()
:RAM cost: 4 GB
Attempts to join the Bladeburner division.

1
doc/source/netscript/bladeburnerapi/joinBladeburnerFaction.rst
View File

@ -2,6 +2,7 @@ joinBladeburnerFaction() Netscript Function
===========================================
.. js:function:: joinBladeburnerFaction()
:RAM cost: 4 GB
Attempts to join the Bladeburner faction.

1
doc/source/netscript/bladeburnerapi/setActionAutolevel.rst
View File

@ -2,6 +2,7 @@ setActionAutolevel() Netscript Function
=======================================
.. js:function:: setActionAutolevel(type, name, autoLevel)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/setActionLevel.rst
View File

@ -2,6 +2,7 @@ setActionLevel() Netscript Function
===================================
.. js:function:: setActionLevel(type, name, level)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/setTeamSize.rst
View File

@ -2,6 +2,7 @@ setTeamSize() Netscript Function
================================
.. js:function:: setTeamSize(type, name, size)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/startAction.rst
View File

@ -2,6 +2,7 @@ startAction() Netscript Function
================================
.. js:function:: startAction(type, name)
:RAM cost: 4 GB
:param string type: Type of action. See :ref:`bladeburner_action_types`

1
doc/source/netscript/bladeburnerapi/stopBladeburnerAction.rst
View File

@ -2,6 +2,7 @@ stopBladeburnerAction() Netscript Function
==========================================
.. js:function:: stopBladeburnerAction()
:RAM cost: 2 GB
Stops the current Bladeburner action

1
doc/source/netscript/bladeburnerapi/switchCity.rst
View File

@ -2,6 +2,7 @@ switchCity() Netscript Function
===============================
.. js:function:: switchCity(cityName)
:RAM cost: 4 GB
:param string cityName: Name of city

1
doc/source/netscript/bladeburnerapi/upgradeSkill.rst
View File

@ -2,6 +2,7 @@ upgradeSkill() Netscript Function
=================================
.. js:function:: upgradeSkill(skillName)
:RAM cost: 4 GB
:param string skillName: Name of Skill to be upgraded. Case-sensitive and must be an exact match

6
src/Constants.ts
View File

@ -235,15 +235,15 @@ export let CONSTANTS: IMap<any> = {
* For advanced players: The game now embraces exploits and will reward
players for doing so.
Netscript
* 'gang.getEquipmentStats' returns the stats of the equipment.
* 'gang.getTaskStats' returns the stats of a task.
* 'getCrimeStats' returns the stats of a crime.
* Crashes should now print the ns stack trace.
* Log messages are now more consistent.
Misc.
* Minor formatting under Hacking>Active Scripts
* option menu colors now match the rest of the game, kinda.
`
}