Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-19 04:35:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1031 from PurePandemonium/patch-1

Browse Source 
Update doc page for Singularity functions
This commit is contained in:
hydroflame 2021-08-10 20:56:40 -04:00 committed by GitHub
commit 643d2525c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/netscript/netscriptsingularityfunctions.rst
View File

@ -3,22 +3,17 @@
Netscript Singularity Functions Netscript Singularity Functions
=============================== ===============================
The Singularity Functions are a special set of Netscript functions. These functions allow you to control .. warning:: This page contains spoilers for the game.
many additional aspects of the game through scripts, such as working for factions/companies, purchasing/installing Augmentations,
and creating programs. The Singularity Functions are a special set of Netscript functions that allow the player to control additional aspects of the game such as working for factions/companies, purchasing/installing Augmentations, and creating programs.
The Singularity Functions are **not** immediately available to the player and must be unlocked later in the game. The Singularity Functions are **not** immediately available to the player and must be unlocked later in the game.
.. warning:: This page contains spoilers for the game The player has access to all of these functions while in BitNode-4. Completing BitNode-4 and gaining its source-file unlocks certain Singularity Functions for use in other BitNodes, with all functions accessible at level 3.
The Singularity Functions are unlocked in BitNode-4. If you are in BitNode-4, then you will automatically have access to all of these functions.
You can use the Singularity Functions in other BitNodes if and only if you have the Source-File for BitNode-4 (aka Source-File 4). Each level of
Source-File 4 will open up additional Singularity Functions that you can use in other BitNodes. If your Source-File 4 is upgraded all the way to
level 3, then you will be able to access all of the Singularity Functions.
.. toctree:: .. toctree::
:caption: Functions: :caption: Level 1 Functions
universityCourse() <singularityfunctions/universityCourse> universityCourse() <singularityfunctions/universityCourse>
gymWorkout() <singularityfunctions/gymWorkout> gymWorkout() <singularityfunctions/gymWorkout>
travelToCity() <singularityfunctions/travelToCity> travelToCity() <singularityfunctions/travelToCity>
@ -30,6 +25,10 @@ level 3, then you will be able to access all of the Singularity Functions.
installBackdoor() <singularityfunctions/installBackdoor> installBackdoor() <singularityfunctions/installBackdoor>
hospitalize() <singularityfunctions/hospitalize> hospitalize() <singularityfunctions/hospitalize>
isBusy() <singularityfunctions/isBusy> isBusy() <singularityfunctions/isBusy>
.. toctree::
:caption: Level 2 Functions
stopAction() <singularityfunctions/stopAction> stopAction() <singularityfunctions/stopAction>
upgradeHomeRam() <singularityfunctions/upgradeHomeRam> upgradeHomeRam() <singularityfunctions/upgradeHomeRam>
getUpgradeHomeRamCost() <singularityfunctions/getUpgradeHomeRamCost> getUpgradeHomeRamCost() <singularityfunctions/getUpgradeHomeRamCost>
@ -44,6 +43,10 @@ level 3, then you will be able to access all of the Singularity Functions.
getFactionRep() <singularityfunctions/getFactionRep> getFactionRep() <singularityfunctions/getFactionRep>
getFactionFavor() <singularityfunctions/getFactionFavor> getFactionFavor() <singularityfunctions/getFactionFavor>
getFactionFavorGain() <singularityfunctions/getFactionFavorGain> getFactionFavorGain() <singularityfunctions/getFactionFavorGain>
.. toctree::
:caption: Level 3 Functions
donateToFaction() <singularityfunctions/donateToFaction> donateToFaction() <singularityfunctions/donateToFaction>
createProgram() <singularityfunctions/createProgram> createProgram() <singularityfunctions/createProgram>
commitCrime() <singularityfunctions/commitCrime> commitCrime() <singularityfunctions/commitCrime>
@ -64,4 +67,4 @@ level 3, then you will be able to access all of the Singularity Functions.
:caption: Deprecated: :caption: Deprecated:
getStats() <singularityfunctions/getStats> getStats() <singularityfunctions/getStats>
getCharacterInformation() <singularityfunctions/getCharacterInformation> getCharacterInformation() <singularityfunctions/getCharacterInformation>