* Updated ram cost of documentation

* v0.47.3

Co-authored-by: Samuel A. Lamb <samuei@users.noreply.github.com>
This commit is contained in:
hydroflame 2021-03-07 04:13:37 -05:00 committed by GitHub
parent f9162e4d30
commit e9dfe3c389
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
130 changed files with 18094 additions and 303 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

@ -588,7 +588,7 @@ The data can only be downloaded to a script (.script, .ns, .js) or a text file
(.txt). If the target file already exists, it will be overwritten by this command.
Note that will not be possible to download data from many websites because they
do not allow cross-origin origin sharing (CORS). This includes websites such
do not allow cross-origin resource sharing (CORS). This includes websites such
as gist and pastebin. One notable site it will work on is rawgithub. Example::
$ wget https://raw.githubusercontent.com/danielyxie/bitburner/master/README.md game_readme.txt

@ -18,3 +18,5 @@ getBitNodeMultipliers() Netscript Function
mults = getBitNodeMultipliers();
print(mults.ServerMaxMoney);
print(mults.HackExpGain);
:RAM cost: 4 GB

@ -4,7 +4,7 @@ brutessh() Netscript Function
.. js:function:: brutessh(hostname/ip)
:param string hostname/ip: IP or hostname of the target server
:RAM cost: 0 GB
:RAM cost: 0.05 GB
Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer.

@ -4,7 +4,7 @@ ftpcrack() Netscript Function
.. js:function:: ftpcrack(hostname/ip)
:param string hostname/ip: IP or hostname of the target server
:RAM cost: 0 GB
:RAM cost: 0.05 GB
Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer.

@ -4,7 +4,7 @@ httpworm() Netscript Function
.. js:function:: httpworm(hostname/ip)
:param string hostname/ip: IP or hostname of the target server
:RAM cost: 0 GB
:RAM cost: 0.05 GB
Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer.

@ -5,6 +5,7 @@ nFormat() Netscript Function
:param number n: Number to format
:param string format: Formatter
:RAM cost: 0 GB
Converts a number into a string with the specified formatter. This uses the
`numeraljs <http://numeraljs.com/>`_ library, so the formatters must be compatible

@ -4,7 +4,7 @@ nuke() Netscript Function
.. js:function:: nuke(hostname/ip)
:param string hostname/ip: IP or hostname of the target server
:RAM cost: 0 GB
:RAM cost: 0.05 GB
Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer.

@ -4,7 +4,7 @@ relaysmtp() Netscript Function
.. js:function:: relaysmtp(hostname/ip)
:param string hostname/ip: IP or hostname of the target server
:RAM cost: 0 GB
:RAM cost: 0.05 GB
Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer.

@ -4,7 +4,7 @@ sqlinject() Netscript Function
.. js:function:: sqlinject(hostname/ip)
:param string hostname/ip: IP or hostname of the target server
:RAM cost: 0 GB
:RAM cost: 0.05 GB
Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer.

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

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

@ -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.

@ -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.

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

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

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

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

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

@ -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::

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

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

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

@ -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

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

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

@ -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

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

@ -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`
:param string name: Name of action. Must be an exact match

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

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

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

@ -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`
:param string name: Name of action. Must be an exact match

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

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

@ -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

@ -18,3 +18,5 @@ attempt() Netscript Function
option is configured, then the function will instead return a string. If the
contract is successfully solved, the string will contain a description of the
contract's reward. Otherwise, it will be an empty string.
:RAM cost: 10 GB

@ -11,3 +11,5 @@ getContractType() Netscript Function
(e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)
:returns: A string with the contract's problem type
:RAM cost: 5 GB

@ -10,3 +10,5 @@ getDescription() Netscript Function
Get the full text description for the problem posed by the Coding Contract
:returns: A string with the contract's text description
:RAM cost: 5 GB

@ -11,3 +11,5 @@ getNumTriesRemaining() Netscript Function
self-destructs.
:returns: Number indicating how many attempts are remaining
:RAM cost: 2 GB

@ -20,3 +20,5 @@ ascendMember() Netscript Function
agi: Agility multiplier gained from ascending. Decimal form
cha: Charisma multiplier gained from ascending. Decimal form
}
:RAM cost: 4 GB

@ -4,3 +4,5 @@ canRecruitMember() Netscript Function
.. js:function:: canRecruitMember()
:returns: Boolean indicating whether a member can currently be recruited
:RAM cost: 1 GB

@ -11,3 +11,5 @@ getBonusTime() Netscript Function
"Bonus time" makes the game progress faster, up to 10x the normal speed.
:returns: Bonus time for the Gang mechanic in seconds
:RAM cost: 0 GB

@ -7,3 +7,5 @@ getChanceToWinClash() Netscript Function
Returns the chance you have to win a clash with the specified gang. The chance
is returned in decimal form, not percentage
:RAM cost: 4 GB

@ -10,3 +10,5 @@ getEquipmentCost() Netscript Function
:returns: Cost to purchase the specified Equipment/Augmentation (number). Infinity
for invalid arguments
:RAM cost: 2 GB

@ -7,3 +7,5 @@ getEquipmentNames() Netscript Function
Gang Members. This includes Augmentations.
:returns: Array of strings of the names of all Equpiment/Augmentations
:RAM cost: 1 GB

@ -14,3 +14,5 @@ getEquipmentType() Netscript Function
* Augmentation
:returns: A string stating the type of the equipment
:RAM cost: 2 GB

@ -21,3 +21,5 @@ getGangInformation() Netscript Function
wantedLevel: Gang's wanted level
wantedLevelGainRate: Wanted level gained/lost per second (negative for losses)
}
:RAM cost: 2 GB

@ -9,6 +9,8 @@ getMemberInformation() Netscript Function
:returns: An object with the gang member information.
:RAM cost: 2 GB
The object has the following structure::
{

@ -6,3 +6,5 @@ getMemberNames() Netscript Function
Get the names of all Gang members
:returns: An array of the names of all Gang members as strings
:RAM cost: 1 GB

@ -24,3 +24,5 @@ getOtherGangInformation() Netscript Function
},
... (for all six gangs)
}
:RAM cost: 2 GB

@ -6,3 +6,5 @@ getTaskNames() Netscript Function
Get the name of all valid tasks that Gang members can be assigned to
:returns: Array of strings of all task names
:RAM cost: 1 GB

@ -10,3 +10,5 @@ purchaseEquipment() Netscript Function
Gang member.
:returns: True if the equipment was successfully purchased. False otherwise
:RAM cost: 4 GB

@ -13,3 +13,5 @@ recruitMember() Netscript Function
* There already exists a member with the specified name
:returns: True if the member was successfully recruited. False otherwise
:RAM cost: 2 GB

@ -10,3 +10,5 @@ setMemberTask() Netscript Function
If an invalid task is specified, the Gang member will be set to idle ("Unassigned")
:returns: True if the Gang Member was successfully assigned to the task. False otherwise
:RAM cost: 2 GB

@ -6,3 +6,5 @@ setTerritoryWarfare() Netscript Function
:param bool engage: Whether or not to engage in territory warfare
Set whether or not the gang should engage in territory warfare
:RAM cost: 2 GB

@ -15,3 +15,5 @@ getCacheUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Server is already at the max cache level, then Infinity is returned.
:RAM cost: 0 GB

@ -10,3 +10,5 @@ getCoreUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Node is already at the max number of cores, then Infinity is returned.
:RAM cost: 0 GB

@ -10,3 +10,5 @@ getLevelUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Node is already at max level, then Infinity is returned.
:RAM cost: 0 GB

@ -21,6 +21,8 @@ getNodeStats() Netscript Function
totalProduction: Total amount that the Node has produced
}
:RAM cost: 0 GB
.. note:: Note that for Hacknet Nodes, production refers to the amount of money the node generates.
For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount
of hashes the node generates.

@ -4,3 +4,5 @@ getPurchaseNodeCost() Netscript Function
.. js:function:: getPurchaseNodeCost()
Returns the cost of purchasing a new Hacknet Node
:RAM cost: 0 GB

@ -10,3 +10,5 @@ getRamUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the
specified Hacknet Node is already at max RAM, then Infinity is returned.
:RAM cost: 0 GB

@ -13,6 +13,8 @@ hashCost() Netscript Function
Returns the number of hashes required for the specified upgrade. The name of the
upgrade must be an exact match.
:RAM cost: 0 GB
Example:
.. code:: javascript

@ -9,3 +9,5 @@ numHashes() Netscript Function
of a Hacknet Node).
Returns the number of hashes you have
:RAM cost: 0 GB

@ -4,3 +4,5 @@ numNodes() Netscript Function
.. js:function:: numNodes()
Returns the number of Hacknet Nodes you own.
:RAM cost: 0 GB

@ -9,3 +9,5 @@ purchaseNode() Netscript Function
If the player cannot afford to purchase a new Hacknet Node then the function
will return -1.
:RAM cost: 0 GB

@ -24,3 +24,5 @@ spendHashes() Netscript Function
hacknet.spendHashes("Sell for Corporation Funds");
hacknet.spendHashes("Increase Maximum Money", "foodnstuff");
:RAM cost: 0 GB

@ -17,3 +17,5 @@ upgradeCache() Netscript Function
it purchases some positive amount and the Server reaches its max cache level.
Returns false otherwise.
:RAM cost: 0 GB

@ -12,3 +12,5 @@ upgradeCore() Netscript Function
it purchases some positive amount and the Node reaches its max number of cores.
Returns false otherwise.
:RAM cost: 0 GB

@ -12,3 +12,5 @@ upgradeLevel() Netscript Function
if it is upgraded by some positive amount and the Node reaches its max level.
Returns false otherwise.
:RAM cost: 0 GB

@ -14,3 +14,5 @@ upgradeRam() Netscript Function
it is upgraded some positive number of times and the Node reaches it max RAM.
Returns false otherwise.
:RAM cost: 0 GB

@ -2,6 +2,7 @@ applyToCompany() Netscript Function
===================================
.. js:function:: applyToCompany(companyName, field)
:RAM cost: 3 GB
:param string companyName: Name of company to apply to. CASE-SENSITIVE.
:param string field:

@ -2,6 +2,7 @@ checkFactionInvitations() Netscript Function
============================================
.. js:function:: checkFactionInvitations()
:RAM cost: 3 GB
If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function.

@ -2,6 +2,7 @@ commitCrime() Netscript Function
================================
.. js:function:: commitCrime(crime)
:RAM cost: 5 GB
:param string crime:
Name of crime to attempt. Not case-sensitive. This argument is fairly lenient in terms of what inputs it accepts.

@ -2,6 +2,7 @@ createProgram() Netscript Function
==================================
.. js:function:: createProgram(programName)
:RAM cost: 5 GB
:param string programName: Name of program to create. Not case-sensitive

@ -2,6 +2,7 @@ donateToFaction() Netscript Function
====================================
.. js:function:: donateToFaction(factionName, donateAmt)
:RAM cost: 5 GB
:param string factionName: Name of faction to donate to. CASE-SENSITIVE
:param number donateAmt: Amount of money to donate

@ -2,6 +2,7 @@ getAugmentationCost() Netscript Function
========================================
.. js:function:: getAugmentationCost(augName)
:RAM cost: 5 GB
:param string augName: Name of Augmentation. CASE-SENSITIVE

@ -2,6 +2,7 @@ getAugmentationsFromFaction() Netscript Function
================================================
.. js:function:: getAugmentationsFromFaction(facName)
:RAM cost: 5 GB
:param string facName: Name of faction. CASE-SENSITIVE

@ -2,6 +2,7 @@ getCharacterInformation() Netscript Function
============================================
.. js:function:: getCharacterInformation()
:RAM cost: 0.5 GB
If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to run this function.

@ -2,6 +2,7 @@ getCompanyFavor() Netscript Function
====================================
.. js:function:: getCompanyFavor(companyName)
:RAM cost: 1 GB
:param string companyName: Name of the company. CASE-SENSITIVE

@ -2,6 +2,7 @@ getCompanyFavorGain() Netscript Function
========================================
.. js:function:: getCompanyFavorGain(companyName)
:RAM cost: 0.75 GB
:param string companyName: Name of the company. CASE-SENSITIVE

@ -2,6 +2,7 @@ getCompanyRep() Netscript Function
==================================
.. js:function:: getCompanyRep(companyName)
:RAM cost: 1 GB
:param string companyName: Name of the company. CASE-SENSITIVE

@ -2,6 +2,7 @@ getCrimeChance() Netscript Function
===================================
.. js:function:: getCrimeChance(crime)
:RAM cost: 5 GB
:param string crime:
Name of crime. Not case-sensitive. This argument is fairlyn lenient in terms of what inputs it accepts.

@ -2,6 +2,7 @@ getFactionFavor() Netscript Function
====================================
.. js:function:: getFactionFavor(factionName)
:RAM cost: 1 GB
:param string factionName: Name of faction. CASE-SENSITIVE

@ -2,6 +2,7 @@ getFactionFavorGain() Netscript Function
========================================
.. js:function:: getFactionFavorGain(factionName)
:RAM cost: 0.75 GB
:param string factionName: Name of faction. CASE-SENSITIVE

@ -2,6 +2,7 @@ getFactionRep() Netscript Function
==================================
.. js:function:: getFactionRep(factionName)
:RAM cost: 1 GB
:param string factionName: Name of faction. CASE-SENSITIVE

@ -2,6 +2,7 @@ getOwnedSourceFiles() Netscript Function
========================================
.. js:function:: getOwnedSourceFiles()
:RAM cost: 5 GB
If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function.

@ -21,3 +21,5 @@ getStats() Netscript Function
res = getStats();
print('My charisma level is: ' + res.charisma);
:RAM cost: 0.5 GB

@ -2,6 +2,7 @@ getUpgradeHomeRamCost() Netscript Function
==========================================
.. js:function:: getUpgradeHomeRamCost()
:RAM cost: 1.5 GB
If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function.

@ -2,6 +2,7 @@ gymWorkout() Netscript Function
===============================
.. js:function:: gymWorkout(gymName, stat)
:RAM cost: 2 GB
:param string gymName:
Name of gym. Not case-sensitive. You must be in the correct city for whatever gym you specify.

@ -2,6 +2,7 @@ installAugmentations() Netscript Function
=========================================
.. js:function:: installAugmentations(cbScript)
:RAM cost: 5 GB
:param string cbScript:
Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset).

Some files were not shown because too many files have changed in this diff Show More