bitburner-src/markdown/bitburner.gang.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

5.0 KiB

Home > bitburner > Gang

Gang interface

Gang API

Signature:

interface Gang 

Methods

Method Description
ascendMember(memberName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Ascend the specified Gang Member.
canRecruitMember() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns boolean indicating whether a member can currently be recruited
getBonusTime() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.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.
getChanceToWinClash(gangName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage
getEquipmentCost(equipName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.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.
getEquipmentNames() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.
getEquipmentStats(equipName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the specified equipment stats.
getEquipmentType(equipName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the specified equipment type.
getGangInformation() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get general information about the gang.
getMemberInformation(name) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get stat and equipment-related information about a Gang Member
getMemberNames() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the names of all Gang members
getOtherGangInformation() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get territory and power information about all gangs.
getTaskNames() If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the name of all valid tasks that Gang members can be assigned to.
getTaskStats(name) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.
purchaseEquipment(memberName, equipName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.
recruitMember(name) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.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
setMemberTask(memberName, taskName) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.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”).
setTerritoryWarfare(engage) If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Set whether or not the gang should engage in territory warfare