0.47.3 patch 2 fix documentation (#810)

2026-04-18 23:38:35 +02:00 · 2021-03-07 04:37:56 -05:00
parent e9dfe3c389
commit 4145ddad39
81 changed files with 132 additions and 94 deletions
--- a/doc/source/netscript/singularityfunctions/applyToCompany.rst
+++ b/doc/source/netscript/singularityfunctions/applyToCompany.rst
@@ -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.
--- a/doc/source/netscript/singularityfunctions/checkFactionInvitations.rst
+++ b/doc/source/netscript/singularityfunctions/checkFactionInvitations.rst
@@ -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.
--- a/doc/source/netscript/singularityfunctions/commitCrime.rst
+++ b/doc/source/netscript/singularityfunctions/commitCrime.rst
@@ -2,6 +2,7 @@ commitCrime() Netscript Function
 ================================

 .. js:function:: commitCrime(crime)
+
    :RAM cost: 5 GB

    :param string crime:
--- a/doc/source/netscript/singularityfunctions/createProgram.rst
+++ b/doc/source/netscript/singularityfunctions/createProgram.rst
@@ -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
--- a/doc/source/netscript/singularityfunctions/donateToFaction.rst
+++ b/doc/source/netscript/singularityfunctions/donateToFaction.rst
@@ -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
--- a/doc/source/netscript/singularityfunctions/getAugmentationCost.rst
+++ b/doc/source/netscript/singularityfunctions/getAugmentationCost.rst
@@ -2,6 +2,7 @@ getAugmentationCost() Netscript Function
 ========================================

 .. js:function:: getAugmentationCost(augName)
+
    :RAM cost: 5 GB

    :param string augName: Name of Augmentation. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getAugmentationPrereq.rst
+++ b/doc/source/netscript/singularityfunctions/getAugmentationPrereq.rst
@@ -3,6 +3,8 @@ getAugmentationPrereq() Netscript Function

 .. js:function:: getAugmentationPrereq(augName)

+    :RAM cost: 5 GB
+    
    :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.
--- a/doc/source/netscript/singularityfunctions/getAugmentationsFromFaction.rst
+++ b/doc/source/netscript/singularityfunctions/getAugmentationsFromFaction.rst
@@ -2,6 +2,7 @@ getAugmentationsFromFaction() Netscript Function
 ================================================

 .. js:function:: getAugmentationsFromFaction(facName)
+
    :RAM cost: 5 GB

    :param string facName: Name of faction. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getCharacterInformation.rst
+++ b/doc/source/netscript/singularityfunctions/getCharacterInformation.rst
@@ -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.
--- a/doc/source/netscript/singularityfunctions/getCompanyFavor.rst
+++ b/doc/source/netscript/singularityfunctions/getCompanyFavor.rst
@@ -2,6 +2,7 @@ getCompanyFavor() Netscript Function
 ====================================

 .. js:function:: getCompanyFavor(companyName)
+
    :RAM cost: 1 GB

    :param string companyName: Name of the company. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getCompanyFavorGain.rst
+++ b/doc/source/netscript/singularityfunctions/getCompanyFavorGain.rst
@@ -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
--- a/doc/source/netscript/singularityfunctions/getCompanyRep.rst
+++ b/doc/source/netscript/singularityfunctions/getCompanyRep.rst
@@ -2,6 +2,7 @@ getCompanyRep() Netscript Function
 ==================================

 .. js:function:: getCompanyRep(companyName)
+
    :RAM cost: 1 GB

    :param string companyName: Name of the company. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getCrimeChance.rst
+++ b/doc/source/netscript/singularityfunctions/getCrimeChance.rst
@@ -2,6 +2,7 @@ getCrimeChance() Netscript Function
 ===================================

 .. js:function:: getCrimeChance(crime)
+
    :RAM cost: 5 GB

    :param string crime:
--- a/doc/source/netscript/singularityfunctions/getFactionFavor.rst
+++ b/doc/source/netscript/singularityfunctions/getFactionFavor.rst
@@ -2,6 +2,7 @@ getFactionFavor() Netscript Function
 ====================================

 .. js:function:: getFactionFavor(factionName)
+
    :RAM cost: 1 GB

    :param string factionName: Name of faction. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getFactionFavorGain.rst
+++ b/doc/source/netscript/singularityfunctions/getFactionFavorGain.rst
@@ -2,6 +2,7 @@ getFactionFavorGain() Netscript Function
 ========================================

 .. js:function:: getFactionFavorGain(factionName)
+
    :RAM cost: 0.75 GB

    :param string factionName: Name of faction. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getFactionRep.rst
+++ b/doc/source/netscript/singularityfunctions/getFactionRep.rst
@@ -2,6 +2,7 @@ getFactionRep() Netscript Function
 ==================================

 .. js:function:: getFactionRep(factionName)
+
    :RAM cost: 1 GB

    :param string factionName: Name of faction. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/getOwnedAugmentations.rst
+++ b/doc/source/netscript/singularityfunctions/getOwnedAugmentations.rst
@@ -3,6 +3,8 @@ getOwnedAugmentations() Netscript Function

 .. js:function:: getOwnedAugmentations(purchased=false)

+    :RAM cost: 5 GB
+
    :param boolean purchase:
        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.
--- a/doc/source/netscript/singularityfunctions/getOwnedSourceFiles.rst
+++ b/doc/source/netscript/singularityfunctions/getOwnedSourceFiles.rst
@@ -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.
--- a/doc/source/netscript/singularityfunctions/getStats.rst
+++ b/doc/source/netscript/singularityfunctions/getStats.rst
@@ -3,6 +3,8 @@ getStats() Netscript Function

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

    Returns an object with the Player's stats. The object has the following properties::
--- a/doc/source/netscript/singularityfunctions/getUpgradeHomeRamCost.rst
+++ b/doc/source/netscript/singularityfunctions/getUpgradeHomeRamCost.rst
@@ -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.
--- a/doc/source/netscript/singularityfunctions/gymWorkout.rst
+++ b/doc/source/netscript/singularityfunctions/gymWorkout.rst
@@ -2,6 +2,7 @@ gymWorkout() Netscript Function
 ===============================

 .. js:function:: gymWorkout(gymName, stat)
+
    :RAM cost: 2 GB

    :param string gymName:
--- a/doc/source/netscript/singularityfunctions/installAugmentations.rst
+++ b/doc/source/netscript/singularityfunctions/installAugmentations.rst
@@ -2,6 +2,7 @@ installAugmentations() Netscript Function
 =========================================

 .. js:function:: installAugmentations(cbScript)
+
    :RAM cost: 5 GB

    :param string cbScript:
--- a/doc/source/netscript/singularityfunctions/isBusy.rst
+++ b/doc/source/netscript/singularityfunctions/isBusy.rst
@@ -2,6 +2,7 @@ isBusy() Netscript Function
 ===========================

 .. js:function:: isBusy()
+
    :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.
--- a/doc/source/netscript/singularityfunctions/joinFaction.rst
+++ b/doc/source/netscript/singularityfunctions/joinFaction.rst
@@ -2,6 +2,7 @@ joinFaction() Netscript Function
 ================================

 .. js:function:: joinFaction(name)
+
    :RAM cost: 3 GB

    :param string name: Name of faction to join. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/purchaseAugmentation.rst
+++ b/doc/source/netscript/singularityfunctions/purchaseAugmentation.rst
@@ -2,6 +2,7 @@ purchaseAugmentation() Netscript Function
 =========================================

 .. js:function:: purchaseAugmentation(factionName, augName)
+
    :RAM cost: 5 GB

    :param string factionName: Name of faction to purchase Augmentation from. CASE-SENSITIVE
--- a/doc/source/netscript/singularityfunctions/purchaseProgram.rst
+++ b/doc/source/netscript/singularityfunctions/purchaseProgram.rst
@@ -3,6 +3,8 @@ purchaseProgram() Netscript Function

 .. js:function:: purchaseProgram(programName)

+    :RAM cost: 2 GB
+    
    :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.
--- a/doc/source/netscript/singularityfunctions/purchaseTor.rst
+++ b/doc/source/netscript/singularityfunctions/purchaseTor.rst
@@ -3,6 +3,8 @@ purchaseTor() Netscript Function

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

    This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this
--- a/doc/source/netscript/singularityfunctions/stopAction.rst
+++ b/doc/source/netscript/singularityfunctions/stopAction.rst
@@ -2,6 +2,7 @@ stopAction() Netscript Function
 ===============================

 .. js:function:: stopAction()
+
    :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.
--- a/doc/source/netscript/singularityfunctions/travelToCity.rst
+++ b/doc/source/netscript/singularityfunctions/travelToCity.rst
@@ -2,6 +2,7 @@ travelToCity() Netscript Function
 =================================

 .. js:function:: travelToCity(cityName)
+
    :RAM cost: 2 GB

    :param string cityName:
--- a/doc/source/netscript/singularityfunctions/universityCourse.rst
+++ b/doc/source/netscript/singularityfunctions/universityCourse.rst
@@ -2,6 +2,7 @@ universityCourse() Netscript Function
 =====================================

 .. js:function:: universityCourse(universityName, courseName)
+
    :RAM cost: 2 GB

    :param string universityName:
--- a/doc/source/netscript/singularityfunctions/upgradeHomeRam.rst
+++ b/doc/source/netscript/singularityfunctions/upgradeHomeRam.rst
@@ -2,6 +2,7 @@ upgradeHomeRam() Netscript Function
 ===================================

 .. js:function:: upgradeHomeRam()
+
    :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.
--- a/doc/source/netscript/singularityfunctions/workForCompany.rst
+++ b/doc/source/netscript/singularityfunctions/workForCompany.rst
@@ -2,6 +2,7 @@ workForCompany() Netscript Function
 ===================================

 .. js:function:: workForCompany(companyName=lastCompany)
+
    :RAM cost: 3 GB

    :param string companyName: Name of company to work for. Must be an exact match.
--- a/doc/source/netscript/singularityfunctions/workForFaction.rst
+++ b/doc/source/netscript/singularityfunctions/workForFaction.rst
@@ -2,6 +2,7 @@ workForFaction() Netscript Function
 ===================================

 .. js:function:: workForFaction(factionName, workType)
+
    :RAM cost: 3 GB

    :param string factionName: Name of faction to work for. CASE-SENSITIVE