fix documentation for Bladeburner API.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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