felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 22:38:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

work to make documentation unified.

Browse Source
This commit is contained in:
Olivier Gagnon
2021-03-12 02:51:56 -05:00
parent a00c253dcb
commit 2ce6ff2041
176 changed files with 1325 additions and 916 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/netscript/singularityfunctions/applyToCompany.rst
View File

@@ -4,7 +4,6 @@ applyToCompany() Netscript Function
.. js:function:: applyToCompany(companyName, field)
:RAM cost: 3 GB
:param string companyName: Name of company to apply to. CASE-SENSITIVE.
:param string field:
Field to which you want to apply. Not case-sensitive
@@ -22,12 +21,10 @@ applyToCompany() Netscript Function
* part-time employee
* waiter
* part-time waiter
:returns: ``true`` if you got the job.
If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function.
This function will automatically try to apply to the specified company for a position in the specified
field. This function can also be used to apply for promotions by specifying the company and field you
are already employed at.
This function will return true if you successfully get a job/promotion, and false otherwise. Note that
if you are trying to use this function to apply for a promotion and you don't get one, it will return false.
are already employed at.

2
doc/source/netscript/singularityfunctions/checkFactionInvitations.rst
View File

@@ -4,7 +4,7 @@ checkFactionInvitations() Netscript Function
.. js:function:: checkFactionInvitations()
:RAM cost: 3 GB
:returns: Array with the name of all Factions with whom you have oustanding invitations.
If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function.
Returns an array with the name of all Factions you currently have oustanding invitations from.

5
doc/source/netscript/singularityfunctions/commitCrime.rst
View File

@@ -4,7 +4,6 @@ commitCrime() Netscript Function
.. js:function:: commitCrime(crime)
:RAM cost: 5 GB
:param string crime:
Name of crime to attempt. Not case-sensitive. This argument is fairly lenient in terms of what inputs it accepts.
Here is a list of valid inputs for all of the crimes:
@@ -28,9 +27,9 @@ commitCrime() Netscript Function
(such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.
This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the 'Rob Store' crime,
so running *commitCrime('rob store')* will return 60).
so running ``commitCrime('rob store')`` will return 60).
Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts.
Instead, I would use the isBusy() Singularity function to check whether you have finished attempting a crime.
Instead, I would use the :doc:`isBusy<isBusy>` Singularity function to check whether you have finished attempting a crime.
This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your
browser will follow that time limit.

4
doc/source/netscript/singularityfunctions/createProgram.rst
View File

@@ -4,8 +4,8 @@ createProgram() Netscript Function
.. js:function:: createProgram(programName)
:RAM cost: 5 GB
:param string programName: Name of program to create. Not case-sensitive
:returns: ``true`` if you successfully start working on the specified program.
If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function.
@@ -28,5 +28,3 @@ createProgram() Netscript Function
* DeepscanV2.exe: 400
* ServerProfiler.exe: 75
* AutoLink.exe: 25
This function returns true if you successfully start working on the specified program, and false otherwise.

5
doc/source/netscript/singularityfunctions/donateToFaction.rst
View File

@@ -4,11 +4,10 @@ donateToFaction() Netscript Function
.. js:function:: donateToFaction(factionName, donateAmt)
:RAM cost: 5 GB
:param string factionName: Name of faction to donate to. CASE-SENSITIVE
:param number donateAmt: Amount of money to donate
:returns: ``true`` if you successfully donate the money.
If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function.
Attempts to donate money to the specified faction in exchange for reputation.
Returns true if you successfully donate the money, and false otherwise.
Attempts to donate money to the specified faction in exchange for reputation.

5
doc/source/netscript/singularityfunctions/getAugmentationCost.rst
View File

@@ -4,12 +4,11 @@ getAugmentationCost() Netscript Function
.. js:function:: getAugmentationCost(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.
This function returns an array with two elements that gives the cost for the specified Augmentation.
The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.
If an invalid Augmentation name is passed in for the *augName* argument, this function will return the array [-1, -1].
If an invalid Augmentation name is passed in for the ``augName`` argument, this function will return the array [-1, -1].