0.47.3 patch 2 fix documentation (#810)

2026-04-19 07:48:37 +02:00 · 2021-03-07 04:37:56 -05:00
parent e9dfe3c389
commit 4145ddad39
81 changed files with 132 additions and 94 deletions
@@ -3,6 +3,8 @@ ascendMember() Netscript Function

 .. js:function:: ascendMember(name)

+    :RAM cost: 4 GB
+
    :param string name: Name of member to ascend

    Ascend the specified Gang Member.
@@ -20,5 +22,3 @@ ascendMember() Netscript Function
            agi:        Agility 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()

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

 .. js:function:: getBonusTime()

+    :RAM cost: 0 GB
+
    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
@@ -11,5 +13,3 @@ 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
@@ -3,9 +3,9 @@ getChanceToWinClash() Netscript Function

 .. js:function:: getChanceToWinClash(gangName)

+    :RAM cost: 4 GB
+
    :param string gangName: Target gang

    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
@@ -3,6 +3,8 @@ getEquipmentCost() Netscript Function

 .. js:function:: getEquipmentCost(equipName)

+    :RAM cost: 2 GB
+
    :param string equipName: Name of equipment

    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
             for invalid arguments
-
-    :RAM cost: 2 GB
@@ -3,9 +3,9 @@ getEquipmentNames() Netscript Function

 .. js:function:: getEquipmentNames()

+    :RAM cost: 1 GB
+
    Get the name of all possible equipment/upgrades you can purchase for your
    Gang Members. This includes 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)

+    :RAM cost: 2 GB
+
    :param string equipName: Name of equipment

    Get the specified equipment type, which can be one of the following:
@@ -14,5 +16,3 @@ getEquipmentType() Netscript Function
    * Augmentation

    :returns: A string stating the type of the equipment
-
-    :RAM cost: 2 GB
@@ -3,6 +3,8 @@ getGangInformation() Netscript Function

 .. js:function:: getGangInformation()

+    :RAM cost: 2 GB
+
    Get general information about the gang

    :returns: An object with the gang information.
@@ -21,5 +23,3 @@ getGangInformation() Netscript Function
            wantedLevel:            Gang's wanted level
            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)

+    :RAM cost: 2 GB
+
    :param string name: Name of member

    Get stat and equipment-related information about a Gang Member

    :returns: An object with the gang member information.

-    :RAM cost: 2 GB
-
    The object has the following structure::

        {
@@ -3,8 +3,8 @@ getMemberNames() Netscript Function

 .. js:function:: getMemberNames()

+    :RAM cost: 1 GB
+
    Get the names of all Gang members

    :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()

+    :RAM cost: 2 GB
+
    Get territory and power information about all gangs

    :returns: An object with information about all gangs
@@ -24,5 +26,3 @@ getOtherGangInformation() Netscript Function
            },
            ... (for all six gangs)
        }
-
-    :RAM cost: 2 GB
@@ -3,8 +3,8 @@ getTaskNames() Netscript Function

 .. js:function:: getTaskNames()

+    :RAM cost: 1 GB
+
    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
@@ -3,6 +3,8 @@ purchaseEquipment() Netscript Function

 .. js:function:: purchaseEquipment(memberName, equipName)

+    :RAM cost: 4 GB
+
    :param string memberName: Name of Gang member to purchase the equipment for
    :param string equipName: Name of Equipment/Augmentation to purchase

@@ -10,5 +12,3 @@ purchaseEquipment() Netscript Function
    Gang member.

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

+    :RAM cost: 2 GB
+
    :param string name: Name of member to recruit

    Attempt to recruit a new gang member.
@@ -13,5 +15,3 @@ 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
@@ -3,6 +3,8 @@ setMemberTask() Netscript Function

 .. js:function:: setMemberTask(memberName, taskName)

+    :RAM cost: 2 GB
+
    :param string memberName: Name of Gang member 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")

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

+    :RAM cost: 2 GB
+
    :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