0.47.3 patch 2 fix documentation (#810)

This commit is contained in:
hydroflame 2021-03-07 04:37:56 -05:00 committed by GitHub
parent e9dfe3c389
commit 4145ddad39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
81 changed files with 132 additions and 94 deletions

File diff suppressed because one or more lines are too long

@ -3,6 +3,8 @@ ascendMember() Netscript Function
.. js:function:: ascendMember(name) .. js:function:: ascendMember(name)
:RAM cost: 4 GB
:param string name: Name of member to ascend :param string name: Name of member to ascend
Ascend the specified Gang Member. Ascend the specified Gang Member.
@ -20,5 +22,3 @@ ascendMember() Netscript Function
agi: Agility multiplier gained from ascending. Decimal form agi: Agility multiplier gained from ascending. Decimal form
cha: Charisma multiplier gained from ascending. Decimal form cha: Charisma multiplier gained from ascending. Decimal form
} }
:RAM cost: 4 GB

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

@ -3,6 +3,8 @@ getBonusTime() Netscript Function
.. js:function:: getBonusTime() .. js:function:: getBonusTime()
:RAM cost: 0 GB
Returns the amount of accumulated "bonus time" (seconds) for the Gang mechanic. Returns the amount of accumulated "bonus time" (seconds) for the Gang mechanic.
"Bonus time" is accumulated when the game is offline or if the game is "Bonus time" is accumulated when the game is offline or if the game is
@ -11,5 +13,3 @@ getBonusTime() Netscript Function
"Bonus time" makes the game progress faster, up to 10x the normal speed. "Bonus time" makes the game progress faster, up to 10x the normal speed.
:returns: Bonus time for the Gang mechanic in seconds :returns: Bonus time for the Gang mechanic in seconds
:RAM cost: 0 GB

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

@ -3,6 +3,8 @@ getEquipmentCost() Netscript Function
.. js:function:: getEquipmentCost(equipName) .. js:function:: getEquipmentCost(equipName)
:RAM cost: 2 GB
:param string equipName: Name of equipment :param string equipName: Name of equipment
Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. Get the amount of money it takes to purchase a piece of Equipment or an Augmentation.
@ -10,5 +12,3 @@ getEquipmentCost() Netscript Function
:returns: Cost to purchase the specified Equipment/Augmentation (number). Infinity :returns: Cost to purchase the specified Equipment/Augmentation (number). Infinity
for invalid arguments for invalid arguments
:RAM cost: 2 GB

@ -3,9 +3,9 @@ getEquipmentNames() Netscript Function
.. js:function:: getEquipmentNames() .. js:function:: getEquipmentNames()
:RAM cost: 1 GB
Get the name of all possible equipment/upgrades you can purchase for your Get the name of all possible equipment/upgrades you can purchase for your
Gang Members. This includes Augmentations. Gang Members. This includes Augmentations.
:returns: Array of strings of the names of all Equpiment/Augmentations :returns: Array of strings of the names of all Equpiment/Augmentations
:RAM cost: 1 GB

@ -3,6 +3,8 @@ getEquipmentType() Netscript Function
.. js:function:: getEquipmentType(equipName) .. js:function:: getEquipmentType(equipName)
:RAM cost: 2 GB
:param string equipName: Name of equipment :param string equipName: Name of equipment
Get the specified equipment type, which can be one of the following: Get the specified equipment type, which can be one of the following:
@ -14,5 +16,3 @@ getEquipmentType() Netscript Function
* Augmentation * Augmentation
:returns: A string stating the type of the equipment :returns: A string stating the type of the equipment
:RAM cost: 2 GB

@ -3,6 +3,8 @@ getGangInformation() Netscript Function
.. js:function:: getGangInformation() .. js:function:: getGangInformation()
:RAM cost: 2 GB
Get general information about the gang Get general information about the gang
:returns: An object with the gang information. :returns: An object with the gang information.
@ -21,5 +23,3 @@ getGangInformation() Netscript Function
wantedLevel: Gang's wanted level wantedLevel: Gang's wanted level
wantedLevelGainRate: Wanted level gained/lost per second (negative for losses) wantedLevelGainRate: Wanted level gained/lost per second (negative for losses)
} }
:RAM cost: 2 GB

@ -3,14 +3,14 @@ getMemberInformation() Netscript Function
.. js:function:: getMemberInformation(name) .. js:function:: getMemberInformation(name)
:RAM cost: 2 GB
:param string name: Name of member :param string name: Name of member
Get stat and equipment-related information about a Gang Member Get stat and equipment-related information about a Gang Member
:returns: An object with the gang member information. :returns: An object with the gang member information.
:RAM cost: 2 GB
The object has the following structure:: The object has the following structure::
{ {

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

@ -3,6 +3,8 @@ getOtherGangInformation() Netscript Function
.. js:function:: getOtherGangInformation() .. js:function:: getOtherGangInformation()
:RAM cost: 2 GB
Get territory and power information about all gangs Get territory and power information about all gangs
:returns: An object with information about all gangs :returns: An object with information about all gangs
@ -24,5 +26,3 @@ getOtherGangInformation() Netscript Function
}, },
... (for all six gangs) ... (for all six gangs)
} }
:RAM cost: 2 GB

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

@ -3,6 +3,8 @@ purchaseEquipment() Netscript Function
.. js:function:: purchaseEquipment(memberName, equipName) .. js:function:: purchaseEquipment(memberName, equipName)
:RAM cost: 4 GB
:param string memberName: Name of Gang member to purchase the equipment for :param string memberName: Name of Gang member to purchase the equipment for
:param string equipName: Name of Equipment/Augmentation to purchase :param string equipName: Name of Equipment/Augmentation to purchase
@ -10,5 +12,3 @@ purchaseEquipment() Netscript Function
Gang member. Gang member.
:returns: True if the equipment was successfully purchased. False otherwise :returns: True if the equipment was successfully purchased. False otherwise
:RAM cost: 4 GB

@ -3,6 +3,8 @@ recruitMember() Netscript Function
.. js:function:: recruitMember(name) .. js:function:: recruitMember(name)
:RAM cost: 2 GB
:param string name: Name of member to recruit :param string name: Name of member to recruit
Attempt to recruit a new gang member. Attempt to recruit a new gang member.
@ -13,5 +15,3 @@ recruitMember() Netscript Function
* There already exists a member with the specified name * There already exists a member with the specified name
:returns: True if the member was successfully recruited. False otherwise :returns: True if the member was successfully recruited. False otherwise
:RAM cost: 2 GB

@ -3,6 +3,8 @@ setMemberTask() Netscript Function
.. js:function:: setMemberTask(memberName, taskName) .. js:function:: setMemberTask(memberName, taskName)
:RAM cost: 2 GB
:param string memberName: Name of Gang member to assign :param string memberName: Name of Gang member to assign
:param string taskName: Task to assign :param string taskName: Task to assign
@ -10,5 +12,3 @@ setMemberTask() Netscript Function
If an invalid task is specified, the Gang member will be set to idle ("Unassigned") 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 :returns: True if the Gang Member was successfully assigned to the task. False otherwise
:RAM cost: 2 GB

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

@ -5,6 +5,8 @@ getCacheUpgradeCost() Netscript Function
.. js:function:: getCacheUpgradeCost(i, n) .. js:function:: getCacheUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade cache. Must be positive. Rounded to nearest integer :param number n: Number of times to upgrade cache. Must be positive. Rounded to nearest integer
@ -15,5 +17,3 @@ getCacheUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the 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. specified Hacknet Server is already at the max cache level, then Infinity is returned.
:RAM cost: 0 GB

@ -3,6 +3,8 @@ getCoreUpgradeCost() Netscript Function
.. js:function:: getCoreUpgradeCost(i, n) .. js:function:: getCoreUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade cores. Must be positive. Rounded to nearest integer :param number n: Number of times to upgrade cores. Must be positive. Rounded to nearest integer
@ -10,5 +12,3 @@ getCoreUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the 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. specified Hacknet Node is already at the max number of cores, then Infinity is returned.
:RAM cost: 0 GB

@ -3,6 +3,8 @@ getLevelUpgradeCost() Netscript Function
.. js:function:: getLevelUpgradeCost(i, n) .. js:function:: getLevelUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of levels to upgrade. Must be positive. Rounded to nearest integer :param number n: Number of levels to upgrade. Must be positive. Rounded to nearest integer
@ -10,5 +12,3 @@ getLevelUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the 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. specified Hacknet Node is already at max level, then Infinity is returned.
:RAM cost: 0 GB

@ -5,6 +5,8 @@ getNodeStats() Netscript Function
.. js:function:: getNodeStats(i) .. js:function:: getNodeStats(i)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
Returns an object containing a variety of stats about the specified Hacknet Node:: Returns an object containing a variety of stats about the specified Hacknet Node::
@ -20,8 +22,6 @@ getNodeStats() Netscript Function
timeOnline: Number of seconds since Node has been purchased, timeOnline: Number of seconds since Node has been purchased,
totalProduction: Total amount that the Node has produced 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. .. 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 For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount

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

@ -3,6 +3,8 @@ getRamUpgradeCost() Netscript Function
.. js:function:: getRamUpgradeCost(i, n) .. js:function:: getRamUpgradeCost(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade RAM. Must be positive. Rounded to nearest integer :param number n: Number of times to upgrade RAM. Must be positive. Rounded to nearest integer
@ -10,5 +12,3 @@ getRamUpgradeCost() Netscript Function
If an invalid value for *n* is provided, then this function returns 0. If the 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. specified Hacknet Node is already at max RAM, then Infinity is returned.
:RAM cost: 0 GB

@ -5,6 +5,8 @@ hashCost() Netscript Function
.. js:function:: hashCost(upgName) .. js:function:: hashCost(upgName)
:RAM cost: 0 GB
:param string upgName: Name of upgrade to get the cost of. Must be an exact match :param string upgName: Name of upgrade to get the cost of. Must be an exact match
.. note:: This function is only applicable for Hacknet Servers (the upgraded version .. note:: This function is only applicable for Hacknet Servers (the upgraded version
@ -12,8 +14,6 @@ hashCost() Netscript Function
Returns the number of hashes required for the specified upgrade. The name of the Returns the number of hashes required for the specified upgrade. The name of the
upgrade must be an exact match. upgrade must be an exact match.
:RAM cost: 0 GB
Example: Example:

@ -5,9 +5,9 @@ numHashes() Netscript Function
.. js:function:: numHashes() .. js:function:: numHashes()
:RAM cost: 0 GB
.. note:: This function is only applicable for Hacknet Servers (the upgraded version .. note:: This function is only applicable for Hacknet Servers (the upgraded version
of a Hacknet Node). of a Hacknet Node).
Returns the number of hashes you have Returns the number of hashes you have
:RAM cost: 0 GB

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

@ -3,11 +3,11 @@ purchaseNode() Netscript Function
.. js:function:: purchaseNode() .. js:function:: purchaseNode()
:RAM cost: 0 GB
Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node.
This index is equivalent to the number at the end of the Hacknet Node's name This index is equivalent to the number at the end of the Hacknet Node's name
(e.g The Hacknet Node named 'hacknet-node-4' will have an index of 4). (e.g The Hacknet Node named 'hacknet-node-4' will have an index of 4).
If the player cannot afford to purchase a new Hacknet Node then the function If the player cannot afford to purchase a new Hacknet Node then the function
will return -1. will return -1.
:RAM cost: 0 GB

@ -5,6 +5,8 @@ spendHashes() Netscript Function
.. js:function:: spendHashes(upgName, upgTarget) .. js:function:: spendHashes(upgName, upgTarget)
:RAM cost: 0 GB
:param string upgName: Name of upgrade to spend hashes on. Must be an exact match :param string upgName: Name of upgrade to spend hashes on. Must be an exact match
:param string upgTarget: Object to which upgrade applies. Required for certain upgrades :param string upgTarget: Object to which upgrade applies. Required for certain upgrades
@ -24,5 +26,3 @@ spendHashes() Netscript Function
hacknet.spendHashes("Sell for Corporation Funds"); hacknet.spendHashes("Sell for Corporation Funds");
hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); hacknet.spendHashes("Increase Maximum Money", "foodnstuff");
:RAM cost: 0 GB

@ -5,6 +5,8 @@ upgradeCache() Netscript Function
.. js:function:: upgradeCache(i, n) .. js:function:: upgradeCache(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of cache levels to purchase. Must be positive. Rounded to nearest integer :param number n: Number of cache levels to purchase. Must be positive. Rounded to nearest integer
@ -17,5 +19,3 @@ upgradeCache() Netscript Function
it purchases some positive amount and the Server reaches its max cache level. it purchases some positive amount and the Server reaches its max cache level.
Returns false otherwise. Returns false otherwise.
:RAM cost: 0 GB

@ -3,6 +3,8 @@ upgradeCore() Netscript Function
.. js:function:: upgradeCore(i, n) .. js:function:: upgradeCore(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of cores to purchase. Must be positive. Rounded to nearest integer :param number n: Number of cores to purchase. Must be positive. Rounded to nearest integer
@ -12,5 +14,3 @@ upgradeCore() Netscript Function
it purchases some positive amount and the Node reaches its max number of cores. it purchases some positive amount and the Node reaches its max number of cores.
Returns false otherwise. Returns false otherwise.
:RAM cost: 0 GB

@ -3,6 +3,8 @@ upgradeLevel() Netscript Function
.. js:function:: upgradeLevel(i, n) .. js:function:: upgradeLevel(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of levels to purchase. Must be positive. Rounded to nearest integer :param number n: Number of levels to purchase. Must be positive. Rounded to nearest integer
@ -12,5 +14,3 @@ upgradeLevel() Netscript Function
if it is upgraded by some positive amount and the Node reaches its max level. if it is upgraded by some positive amount and the Node reaches its max level.
Returns false otherwise. Returns false otherwise.
:RAM cost: 0 GB

@ -3,6 +3,8 @@ upgradeRam() Netscript Function
.. js:function:: upgradeRam(i, n) .. js:function:: upgradeRam(i, n)
:RAM cost: 0 GB
:param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>` :param number i: Index/Identifier of Hacknet Node. :ref:`See here for details <netscript_hacknetnodeapi_referencingahacknetnode>`
:param number n: Number of times to upgrade RAM. Must be positive. Rounded to nearest integer :param number n: Number of times to upgrade RAM. Must be positive. Rounded to nearest integer
@ -14,5 +16,3 @@ upgradeRam() Netscript Function
it is upgraded some positive number of times and the Node reaches it max RAM. it is upgraded some positive number of times and the Node reaches it max RAM.
Returns false otherwise. Returns false otherwise.
:RAM cost: 0 GB

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

@ -2,6 +2,7 @@ checkFactionInvitations() Netscript Function
============================================ ============================================
.. js:function:: checkFactionInvitations() .. js:function:: checkFactionInvitations()
:RAM cost: 3 GB :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. 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) .. js:function:: commitCrime(crime)
:RAM cost: 5 GB :RAM cost: 5 GB
:param string crime: :param string crime:

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

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

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

@ -3,6 +3,8 @@ getAugmentationPrereq() Netscript Function
.. js:function:: getAugmentationPrereq(augName) .. js:function:: getAugmentationPrereq(augName)
:RAM cost: 5 GB
:param string augName: Name of Augmentation. CASE-SENSITIVE :param string augName: Name of Augmentation. CASE-SENSITIVE
If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function. If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function.

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

@ -2,6 +2,7 @@ getCharacterInformation() Netscript Function
============================================ ============================================
.. js:function:: getCharacterInformation() .. js:function:: getCharacterInformation()
:RAM cost: 0.5 GB :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. 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) .. js:function:: getCompanyFavor(companyName)
:RAM cost: 1 GB :RAM cost: 1 GB
:param string companyName: Name of the company. CASE-SENSITIVE :param string companyName: Name of the company. CASE-SENSITIVE

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

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

@ -2,6 +2,7 @@ getCrimeChance() Netscript Function
=================================== ===================================
.. js:function:: getCrimeChance(crime) .. js:function:: getCrimeChance(crime)
:RAM cost: 5 GB :RAM cost: 5 GB
:param string crime: :param string crime:

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

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

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

@ -3,6 +3,8 @@ getOwnedAugmentations() Netscript Function
.. js:function:: getOwnedAugmentations(purchased=false) .. js:function:: getOwnedAugmentations(purchased=false)
:RAM cost: 5 GB
:param boolean purchase: :param boolean purchase:
Specifies whether the returned array should include Augmentations you have purchased but not yet installed. Specifies whether the returned array should include Augmentations you have purchased but not yet installed.
By default, this argument is false which means that the return value will NOT have the purchased Augmentations. By default, this argument is false which means that the return value will NOT have the purchased Augmentations.

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

@ -3,6 +3,8 @@ getStats() Netscript Function
.. js:function:: getStats() .. js:function:: getStats()
: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. If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to run this function.
Returns an object with the Player's stats. The object has the following properties:: Returns an object with the Player's stats. The object has the following properties::

@ -2,6 +2,7 @@ getUpgradeHomeRamCost() Netscript Function
========================================== ==========================================
.. js:function:: getUpgradeHomeRamCost() .. js:function:: getUpgradeHomeRamCost()
:RAM cost: 1.5 GB :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. 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) .. js:function:: gymWorkout(gymName, stat)
:RAM cost: 2 GB :RAM cost: 2 GB
:param string gymName: :param string gymName:

@ -2,6 +2,7 @@ installAugmentations() Netscript Function
========================================= =========================================
.. js:function:: installAugmentations(cbScript) .. js:function:: installAugmentations(cbScript)
:RAM cost: 5 GB :RAM cost: 5 GB
:param string cbScript: :param string cbScript:

@ -2,6 +2,7 @@ isBusy() Netscript Function
=========================== ===========================
.. js:function:: isBusy() .. js:function:: isBusy()
:RAM cost: 0.5 GB :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. 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 @@ joinFaction() Netscript Function
================================ ================================
.. js:function:: joinFaction(name) .. js:function:: joinFaction(name)
:RAM cost: 3 GB :RAM cost: 3 GB
:param string name: Name of faction to join. CASE-SENSITIVE :param string name: Name of faction to join. CASE-SENSITIVE

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

@ -3,6 +3,8 @@ purchaseProgram() Netscript Function
.. js:function:: purchaseProgram(programName) .. js:function:: purchaseProgram(programName)
:RAM cost: 2 GB
:param string programName: Name of program to purchase. Must include '.exe' extension. Not case-sensitive. :param string programName: Name of program to purchase. Must include '.exe' extension. Not case-sensitive.
If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function. If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function.

@ -3,6 +3,8 @@ purchaseTor() Netscript Function
.. js:function:: purchaseTor() .. js:function:: purchaseTor()
:RAM cost: 2 GB
If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function. If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function.
This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this

@ -2,6 +2,7 @@ stopAction() Netscript Function
=============================== ===============================
.. js:function:: stopAction() .. js:function:: stopAction()
:RAM cost: 1 GB :RAM cost: 1 GB
If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to run this function. 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 @@ travelToCity() Netscript Function
================================= =================================
.. js:function:: travelToCity(cityName) .. js:function:: travelToCity(cityName)
:RAM cost: 2 GB :RAM cost: 2 GB
:param string cityName: :param string cityName:

@ -2,6 +2,7 @@ universityCourse() Netscript Function
===================================== =====================================
.. js:function:: universityCourse(universityName, courseName) .. js:function:: universityCourse(universityName, courseName)
:RAM cost: 2 GB :RAM cost: 2 GB
:param string universityName: :param string universityName:

@ -2,6 +2,7 @@ upgradeHomeRam() Netscript Function
=================================== ===================================
.. js:function:: upgradeHomeRam() .. js:function:: upgradeHomeRam()
:RAM cost: 3 GB :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. 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 @@ workForCompany() Netscript Function
=================================== ===================================
.. js:function:: workForCompany(companyName=lastCompany) .. js:function:: workForCompany(companyName=lastCompany)
:RAM cost: 3 GB :RAM cost: 3 GB
:param string companyName: Name of company to work for. Must be an exact match. :param string companyName: Name of company to work for. Must be an exact match.

@ -2,6 +2,7 @@ workForFaction() Netscript Function
=================================== ===================================
.. js:function:: workForFaction(factionName, workType) .. js:function:: workForFaction(factionName, workType)
:RAM cost: 3 GB :RAM cost: 3 GB
:param string factionName: Name of faction to work for. CASE-SENSITIVE :param string factionName: Name of faction to work for. CASE-SENSITIVE

@ -2,12 +2,12 @@ getInformation() Netscript Function
======================================= =======================================
.. js:function:: getInformation(sleeveNumber) .. js:function:: getInformation(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve information. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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 Return a struct containing tons of information about this sleeve
:RAM cost: 4 GB
.. code-block:: javascript .. code-block:: javascript

@ -3,6 +3,6 @@ getNumSleeves() Netscript Function
.. js:function:: getNumSleeves() .. js:function:: getNumSleeves()
Return the number of duplicate sleeves the player has.
:RAM cost: 4 GB :RAM cost: 4 GB
Return the number of duplicate sleeves the player has.

@ -3,8 +3,8 @@ getSleeveAugmentations() Netscript Function
.. js:function:: getSleeveAugmentations(sleeveNumber) .. js:function:: getSleeveAugmentations(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve augmentations from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :param int sleeveNumber: Index of the sleeve to retrieve augmentations from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a list of augmentation names that this sleeve has installed. Return a list of augmentation names that this sleeve has installed.
:RAM cost: 4 GB

@ -2,12 +2,12 @@ getSleevePurchasableAugs() Netscript Function
============================================= =============================================
.. js:function:: getSleevePurchasableAugs(sleeveNumber) .. js:function:: getSleevePurchasableAugs(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve purchasable augmentations from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :param int sleeveNumber: Index of the sleeve to retrieve purchasable augmentations from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
Return a list of augmentations that the player can buy for this sleeve. Return a list of augmentations that the player can buy for this sleeve.
:RAM cost: 4 GB
.. code-block:: javascript .. code-block:: javascript

@ -3,11 +3,11 @@ getSleeveStats() Netscript Function
.. js:function:: getSleeveStats(sleeveNumber) .. js:function:: getSleeveStats(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to get stats of. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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 Return a structure containing the stats of the sleeve
:RAM cost: 4 GB
.. code-block:: javascript .. code-block:: javascript

@ -3,11 +3,11 @@ getTask() Netscript Function
.. js:function:: getTask(sleeveNumber) .. js:function:: getTask(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to retrieve task from. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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 Return the current task that the sleeve is performing. type is set to "Idle" if the sleeve isn't doing anything
:RAM cost: 4 GB
.. code-block:: javascript .. code-block:: javascript

@ -3,9 +3,9 @@ purchaseSleeveAug() Netscript Function
.. js:function:: purchaseSleeveAug(sleeveNumber, augName) .. js:function:: purchaseSleeveAug(sleeveNumber, augName)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to buy an aug for. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :param int sleeveNumber: Index of the sleeve to buy an aug for. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string augName: Name of the aug to buy. Must be an exact match :param string augName: Name of the aug to buy. Must be an exact match
Return true if the aug was purchased and installed on the sleeve. Return true if the aug was purchased and installed on the sleeve.
:RAM cost: 4 GB

@ -3,11 +3,11 @@ setToCommitCrime() Netscript Function
.. js:function:: setToCommitCrime(sleeveNumber, name) .. js:function:: setToCommitCrime(sleeveNumber, name)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start commiting crime. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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. :param string name: Name of the crime. Must be an exact match.
Return a boolean indicating whether or not this action was set successfully. Return a boolean indicating whether or not this action was set successfully.
Returns false if an invalid action is specified. Returns false if an invalid action is specified.
:RAM cost: 4 GB

@ -3,9 +3,9 @@ setToCompanyWork() Netscript Function
.. js:function:: setToCompanyWork(sleeveNumber, companyName) .. js:function:: setToCompanyWork(sleeveNumber, companyName)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to work for the company. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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. :param string companyName: Name of the company to work for.
Return a boolean indicating whether or not the sleeve started working or this company. Return a boolean indicating whether or not the sleeve started working or this company.
:RAM cost: 4 GB

@ -3,10 +3,10 @@ setToFactionWork() Netscript Function
.. js:function:: setToFactionWork(sleeveNumber, factionName, factionWorkType) .. js:function:: setToFactionWork(sleeveNumber, factionName, factionWorkType)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to work for the faction. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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 factionName: Name of the faction to work for.
:param string factionWorkType: Name of the action to perform for this faction. :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. Return a boolean indicating whether or not the sleeve started working or this faction.
:RAM cost: 4 GB

@ -3,10 +3,10 @@ setToGymWorkout() Netscript Function
.. js:function:: setToGymWorkout(sleeveNumber, gymName, stat) .. js:function:: setToGymWorkout(sleeveNumber, gymName, stat)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to workout at the gym. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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 gymName: Name of the gym.
:param string stat: Name of the stat to train. :param string stat: Name of the stat to train.
Return a boolean indicating whether or not the sleeve started working out. Return a boolean indicating whether or not the sleeve started working out.
:RAM cost: 4 GB

@ -3,8 +3,8 @@ setToShockRecovery() Netscript Function
.. js:function:: setToShockRecovery(sleeveNumber) .. js:function:: setToShockRecovery(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start recovery. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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. Return a boolean indicating whether or not this action was set successfully.
:RAM cost: 4 GB

@ -3,8 +3,8 @@ setToSynchronize() Netscript Function
.. js:function:: setToSynchronize(sleeveNumber) .. js:function:: setToSynchronize(sleeveNumber)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start synchronizing. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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. Return a boolean indicating whether or not this action was set successfully.
:RAM cost: 4 GB

@ -3,10 +3,10 @@ setToUniversityCourse() Netscript Function
.. js:function:: setToUniversityCourse(sleeveNumber, university, className) .. js:function:: setToUniversityCourse(sleeveNumber, university, className)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to start taking class. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :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 university: Name of the university to attend.
:param string className: Name of the class to follow. :param string className: Name of the class to follow.
Return a boolean indicating whether or not this action was set successfully. Return a boolean indicating whether or not this action was set successfully.
:RAM cost: 4 GB

@ -3,9 +3,9 @@ travel() Netscript Function
.. js:function:: travel(sleeveNumber, cityName) .. js:function:: travel(sleeveNumber, cityName)
:RAM cost: 4 GB
:param int sleeveNumber: Index of the sleeve to travel. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>` :param int sleeveNumber: Index of the sleeve to travel. See :ref:`here <netscript_sleeveapi_referencingaduplicatesleeve>`
:param string cityName: Name of the destination city. :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.
:RAM cost: 4 GB

@ -6,7 +6,7 @@
import { IMap } from "./types"; import { IMap } from "./types";
export let CONSTANTS: IMap<any> = { export let CONSTANTS: IMap<any> = {
Version: "0.47.2", Version: "0.47.3",
/** Max level for any skill, assuming no multipliers. Determined by max numerical value in javascript for experience /** Max level for any skill, assuming no multipliers. Determined by max numerical value in javascript for experience
* and the skill level formula in Player.js. Note that all this means it that when experience hits MAX_INT, then * and the skill level formula in Player.js. Note that all this means it that when experience hits MAX_INT, then