v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation

doc/source/netscript/gangapi/ascendMember.rst

@@ -0,0 +1,22 @@
+ascendMember() Netscript Function
+=================================
+
+.. js:function:: ascendMember(name)
+
+    :param string name: Name of member to ascend
+
+    Ascend the specified Gang Member.
+
+    :returns: An object with info about the ascension results.
+
+    The object has the following structure::
+
+        {
+            respect:    Amount of respect lost from ascending
+            hack:       Hacking multiplier gained from ascending. Decimal form
+            str:        Strength multiplier gained from ascending. Decimal form
+            def:        Defense multiplier gained from ascending. Decimal form
+            dex:        Dexterity multiplier gained from ascending. Decimal form
+            agi:        Agility multiplier gained from ascending. Decimal form
+            cha:        Charisma multiplier gained from ascending. Decimal form
+        }

doc/source/netscript/gangapi/canRecruitMember.rst

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

doc/source/netscript/gangapi/getBonusTime.rst

@@ -0,0 +1,13 @@
+getBonusTime() Netscript Function
+=================================
+
+.. js:function:: getBonusTime()
+
+    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
+    inactive in the browser.
+
+    "Bonus time" makes the game progress faster, up to 10x the normal speed.
+
+    :returns: Bonus time for the Gang mechanic in seconds

doc/source/netscript/gangapi/getChanceToWinClash.rst

@@ -0,0 +1,9 @@
+getChanceToWinClash() Netscript Function
+========================================
+
+.. js:function:: getChanceToWinClash(gangName)
+
+    :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

doc/source/netscript/gangapi/getEquipmentCost.rst

@@ -0,0 +1,12 @@
+getEquipmentCost() Netscript Function
+=====================================
+
+.. js:function:: getEquipmentCost(equipName)
+
+    :param string equipName: Name of equipment
+
+    Get the amount of money it takes to purchase a piece of Equipment or an Augmentation.
+    If an invalid Equipment/Augmentation is specified, this function will return Infinity.
+
+    :returns: Cost to purchase the specified Equipment/Augmentation (number). Infinity
+             for invalid arguments

doc/source/netscript/gangapi/getEquipmentNames.rst

@@ -0,0 +1,9 @@
+getEquipmentNames() Netscript Function
+======================================
+
+.. js:function:: getEquipmentNames()
+
+    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

doc/source/netscript/gangapi/getEquipmentType.rst

@@ -0,0 +1,16 @@
+getEquipmentType() Netscript Function
+=====================================
+
+.. js:function:: getEquipmentType(equipName)
+
+    :param string equipName: Name of equipment
+
+    Get the specified equipment type, which can be one of the following:
+
+    * Weapon
+    * Armor
+    * Vehicle
+    * Rootkit
+    * Augmentation
+
+    :returns: A string stating the type of the equipment

doc/source/netscript/gangapi/getGangInformation.rst

@@ -0,0 +1,23 @@
+getGangInformation() Netscript Function
+========================================
+
+.. js:function:: getGangInformation()
+
+    Get general information about the gang
+
+    :returns: An object with the gang information.
+
+    The object has the following structure::
+
+        {
+            faction:                Name of faction that the gang belongs to ("Slum Snakes", etc.)
+            isHacking:              Boolean indicating whether or not its a hacking gang
+            moneyGainRate:          Money earned per second
+            power:                  Gang's power for territory warfare
+            respect:                Gang's respect
+            respectGainRate:        Respect earned per second
+            territory:              Amount of territory held. Returned in decimal form, not percentage
+            territoryClashChance:   Clash chance. Returned in decimal form, not percentage
+            wantedLevel:            Gang's wanted level
+            wantedLevelGainRate:    Wanted level gained/lost per second (negative for losses)
+        }

doc/source/netscript/gangapi/getMemberInformation.rst

@@ -0,0 +1,36 @@
+getMemberInformation() Netscript Function
+=========================================
+
+.. js:function:: getMemberInformation(name)
+
+    :param string name: Name of member
+
+    Get stat and equipment-related information about a Gang Member
+
+    :returns: An object with the gang member information.
+
+    The object has the following structure::
+
+        {
+            agility:                Agility stat
+            agilityEquipMult:       Agility multiplier from equipment. Decimal form
+            agilityAscensionMult:   Agility multiplier from ascension. Decimal form
+            augmentations:          Array of names of all owned Augmentations
+            charisma:               Charisma stat
+            charismaEquipMult:      Charisma multiplier from equipment. Decimal form
+            charismaAscensionMult:  Charisma multiplier from ascension. Decimal form
+            defense:                Defense stat
+            defenseEquipMult:       Defense multiplier from equipment. Decimal form
+            defenseAscensionMult:   Defense multiplier from ascension. Decimal form
+            dexterity:              Dexterity stat
+            dexterityEquipMult:     Dexterity multiplier from equipment. Decimal form
+            dexterityAscensionMult: Dexterity multiplier from ascension. Decimal form
+            equipment:              Array of names of all owned Non-Augmentation Equipment
+            hacking:                Hacking stat
+            hackingEquipMult:       Hacking multiplier from equipment. Decimal form
+            hackingAscensionMult:   Hacking multiplier from ascension. Decimal form
+            strength:               Strength stat
+            strengthEquipMult:      Strength multiplier from equipment. Decimal form
+            strengthAscensionMult:  Strength multiplier from ascension. Decimal form
+            task:                   Name of currently assigned task
+        }

doc/source/netscript/gangapi/getMemberNames.rst

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

doc/source/netscript/gangapi/getOtherGangInformation.rst

@@ -0,0 +1,26 @@
+getOtherGangInformation() Netscript Function
+============================================
+
+.. js:function:: getOtherGangInformation()
+
+    Get territory and power information about all gangs
+
+    :returns: An object with information about all gangs
+
+    The object has the following structure::
+
+        {
+            "Slum Snakes" : {
+                power: Slum Snakes' power
+                territory: Slum Snakes' territory, in decimal form
+            },
+            "Tetrads" : {
+                power: ...
+                territory: ...
+            },
+            "The Syndicate" : {
+                power: ...
+                territory: ...
+            },
+            ... (for all six gangs)
+        }

doc/source/netscript/gangapi/getTaskNames.rst

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

doc/source/netscript/gangapi/purchaseEquipment.rst

@@ -0,0 +1,12 @@
+purchaseEquipment() Netscript Function
+======================================
+
+.. js:function:: purchaseEquipment(memberName, equipName)
+
+    :param string memberName: Name of Gang member to purchase the equipment for
+    :param string equipName: Name of Equipment/Augmentation to purchase
+
+    Attempt to purchase the specified Equipment/Augmentation for the specified
+    Gang member.
+
+    :returns: True if the equipment was successfully purchased. False otherwise

doc/source/netscript/gangapi/recruitMember.rst

@@ -0,0 +1,14 @@
+recruitMember() Netscript Function
+==================================
+
+.. js:function:: recruitMember(name)
+
+    :param string name: Name of member to recruit
+
+    Attempt to recruit a new gang member.
+
+    Possible reasons for failure:
+    * Cannot currently recruit a new member
+    * There already exists a member with the specified name
+
+    :returns: True if the member was successfully recruited. False otherwise

doc/source/netscript/gangapi/setMemberTask.rst

@@ -0,0 +1,12 @@
+setMemberTask() Netscript Function
+==================================
+
+.. js:function:: setMemberTask(memberName, taskName)
+
+    :param string memberName: Name of Gang member to assign
+    :param string taskName: Task to assign
+
+    Attempts to assign the specified Gang Member to the specified task.
+    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

doc/source/netscript/gangapi/setTerritoryWarfare.rst

@@ -0,0 +1,8 @@
+setTerritoryWarfare() Netscript Function
+========================================
+
+.. js:function:: setTerritoryWarfare(engage)
+
+    :param bool engage: Whether or not to engage in territory warfare
+
+    Set whether or not the gang should engage in territory warfare