bitburner-src/doc/source/netscript/netscriptsingularityfunctions.rst

.. _netscript_singularityfunctions:

Netscript Singularity Functions
===============================

.. warning:: This page contains spoilers for the game.

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 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. 

.. toctree::
    :caption:  Level 1 Functions
    
    universityCourse() <singularityfunctions/universityCourse>
    gymWorkout() <singularityfunctions/gymWorkout>
    travelToCity() <singularityfunctions/travelToCity>
    purchaseTor() <singularityfunctions/purchaseTor>
    purchaseProgram() <singularityfunctions/purchaseProgram>
    getCurrentServer() <singularityfunctions/getCurrentServer>
    connect() <singularityfunctions/connect>
    manualHack() <singularityfunctions/manualHack>
    installBackdoor() <singularityfunctions/installBackdoor>
    hospitalize() <singularityfunctions/hospitalize>
    isBusy() <singularityfunctions/isBusy>
    
.. toctree::
    :caption:  Level 2 Functions
    
    stopAction() <singularityfunctions/stopAction>
    upgradeHomeRam() <singularityfunctions/upgradeHomeRam>
    getUpgradeHomeRamCost() <singularityfunctions/getUpgradeHomeRamCost>
    workForCompany() <singularityfunctions/workForCompany>
    applyToCompany() <singularityfunctions/applyToCompany>
    getCompanyRep() <singularityfunctions/getCompanyRep>
    getCompanyFavor() <singularityfunctions/getCompanyFavor>
    getCompanyFavorGain() <singularityfunctions/getCompanyFavorGain>
    checkFactionInvitations() <singularityfunctions/checkFactionInvitations>
    joinFaction() <singularityfunctions/joinFaction>
    workForFaction() <singularityfunctions/workForFaction>
    getFactionRep() <singularityfunctions/getFactionRep>
    getFactionFavor() <singularityfunctions/getFactionFavor>
    getFactionFavorGain() <singularityfunctions/getFactionFavorGain>
    
.. toctree::
    :caption:  Level 3 Functions
    
    donateToFaction() <singularityfunctions/donateToFaction>
    createProgram() <singularityfunctions/createProgram>
    commitCrime() <singularityfunctions/commitCrime>
    getCrimeChance() <singularityfunctions/getCrimeChance>
    getCrimeStats() <singularityfunctions/getCrimeStats>
    getOwnedAugmentations() <singularityfunctions/getOwnedAugmentations>
    getOwnedSourceFiles() <singularityfunctions/getOwnedSourceFiles>
    getAugmentationsFromFaction() <singularityfunctions/getAugmentationsFromFaction>
    getAugmentationCost() <singularityfunctions/getAugmentationCost>
    getAugmentationPrereq() <singularityfunctions/getAugmentationPrereq>
    getAugmentationPrice() <singularityfunctions/getAugmentationPrice>
    getAugmentationRepReq() <singularityfunctions/getAugmentationRepReq>
    getAugmentationStats() <singularityfunctions/getAugmentationStats>
    purchaseAugmentation() <singularityfunctions/purchaseAugmentation>
    installAugmentations() <singularityfunctions/installAugmentations>
    softReset() <singularityfunctions/softReset>


.. toctree::
    :caption: Deprecated:

    getStats() <singularityfunctions/getStats>
    getCharacterInformation() <singularityfunctions/getCharacterInformation>
Fixed bugs with Sleeve mechanics. Updated documentation to use RTD theme 2019-01-20 23:57:38 +01:00			`.. _netscript_singularityfunctions:`

Minor bug fixes, adding spotify music player, and adding sphinx documentation 2018-01-09 21:48:06 +01:00			`Netscript Singularity Functions`
			`===============================`

Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00			`.. warning:: This page contains spoilers for the game.`
Minor bug fixes, adding spotify music player, and adding sphinx documentation 2018-01-09 21:48:06 +01:00
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00			`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.`
Minor bug fixes, adding spotify music player, and adding sphinx documentation 2018-01-09 21:48:06 +01:00
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00			`The Singularity Functions are not immediately available to the player and must be unlocked later in the game.`
Minor bug fixes, adding spotify music player, and adding sphinx documentation 2018-01-09 21:48:06 +01:00
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00			`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.`
Minor bug fixes, adding spotify music player, and adding sphinx documentation 2018-01-09 21:48:06 +01:00
v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`.. toctree::`
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00			`:caption: Level 1 Functions`

v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`universityCourse() <singularityfunctions/universityCourse>`
			`gymWorkout() <singularityfunctions/gymWorkout>`
			`travelToCity() <singularityfunctions/travelToCity>`
			`purchaseTor() <singularityfunctions/purchaseTor>`
			`purchaseProgram() <singularityfunctions/purchaseProgram>`
v0.51.0 (#826) * Hash upgrades and Bladeburner skills can now be clicked to copy to clipboard * Aug purchase confirmation popup displays money in 0.000a format * Character now displays hacknet server info properly * Character,Info now displays hacknet server info correctly. * Formulas (#825) Formulas API v0.1 * Make all money the same color, same for reputation, format all numbers consistently. * rename a lot of the formulas function to no longer contain calculate * added hacking related formulas * removed unused variable * v0.51.0 2021-03-31 06:45:21 +02:00			`getCurrentServer() <singularityfunctions/getCurrentServer>`
executeCommand has been removed in favor of connect and manualHack, which is what people have been asking for. 2021-03-24 02:30:15 +01:00			`connect() <singularityfunctions/connect>`
			`manualHack() <singularityfunctions/manualHack>`
Add installBackdoor 2021-05-07 08:09:30 +02:00			`installBackdoor() <singularityfunctions/installBackdoor>`
v0.51.1 (#835) * infiltration use buttons instead of a links * minor accessibility patch * Hospitalization will not cost more than 10% of the players money. * Adde hospitalization netscript function * Removed the suggestion that the combat path will lead to Daedalus, it still will. But new players should not be told that this is a viable path to completing a BitNode. * getMemberInformation now returns everything about the member. * New netscript function to get the players hacknet server hash capacity * yesno dialog box will not keep older messages anymore * v0.51.1 2021-04-06 09:50:09 +02:00			`hospitalize() <singularityfunctions/hospitalize>`
v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`isBusy() <singularityfunctions/isBusy>`
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00
			`.. toctree::`
			`:caption: Level 2 Functions`

v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`stopAction() <singularityfunctions/stopAction>`
			`upgradeHomeRam() <singularityfunctions/upgradeHomeRam>`
			`getUpgradeHomeRamCost() <singularityfunctions/getUpgradeHomeRamCost>`
			`workForCompany() <singularityfunctions/workForCompany>`
			`applyToCompany() <singularityfunctions/applyToCompany>`
			`getCompanyRep() <singularityfunctions/getCompanyRep>`
			`getCompanyFavor() <singularityfunctions/getCompanyFavor>`
			`getCompanyFavorGain() <singularityfunctions/getCompanyFavorGain>`
			`checkFactionInvitations() <singularityfunctions/checkFactionInvitations>`
			`joinFaction() <singularityfunctions/joinFaction>`
			`workForFaction() <singularityfunctions/workForFaction>`
			`getFactionRep() <singularityfunctions/getFactionRep>`
			`getFactionFavor() <singularityfunctions/getFactionFavor>`
			`getFactionFavorGain() <singularityfunctions/getFactionFavorGain>`
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00
			`.. toctree::`
			`:caption: Level 3 Functions`

v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`donateToFaction() <singularityfunctions/donateToFaction>`
			`createProgram() <singularityfunctions/createProgram>`
			`commitCrime() <singularityfunctions/commitCrime>`
			`getCrimeChance() <singularityfunctions/getCrimeChance>`
work to make documentation unified. 2021-03-12 08:51:56 +01:00			`getCrimeStats() <singularityfunctions/getCrimeStats>`
v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`getOwnedAugmentations() <singularityfunctions/getOwnedAugmentations>`
			`getOwnedSourceFiles() <singularityfunctions/getOwnedSourceFiles>`
			`getAugmentationsFromFaction() <singularityfunctions/getAugmentationsFromFaction>`
			`getAugmentationCost() <singularityfunctions/getAugmentationCost>`
Adds getAugmentationPrice() and getAugmentationReqRep() Netscript Singularity functions. Deprecates getAugmentationCost() Netscript singularity function. 2021-09-08 05:33:34 +02:00			`getAugmentationPrereq() <singularityfunctions/getAugmentationPrereq>`
			`getAugmentationPrice() <singularityfunctions/getAugmentationPrice>`
			`getAugmentationRepReq() <singularityfunctions/getAugmentationRepReq>`
work to make documentation unified. 2021-03-12 08:51:56 +01:00			`getAugmentationStats() <singularityfunctions/getAugmentationStats>`
v0.44.1 Minor Update - Added Augs to Duplicate Sleeves and updated documentation 2019-03-03 04:08:54 +01:00			`purchaseAugmentation() <singularityfunctions/purchaseAugmentation>`
			`installAugmentations() <singularityfunctions/installAugmentations>`
work to make documentation unified. 2021-03-12 08:51:56 +01:00			`softReset() <singularityfunctions/softReset>`
v0.51.0 (#826) * Hash upgrades and Bladeburner skills can now be clicked to copy to clipboard * Aug purchase confirmation popup displays money in 0.000a format * Character now displays hacknet server info properly * Character,Info now displays hacknet server info correctly. * Formulas (#825) Formulas API v0.1 * Make all money the same color, same for reputation, format all numbers consistently. * rename a lot of the formulas function to no longer contain calculate * added hacking related formulas * removed unused variable * v0.51.0 2021-03-31 06:45:21 +02:00

			`.. toctree::`
			`:caption: Deprecated:`

			`getStats() <singularityfunctions/getStats>`
Update doc page for Singularity functions Clean up the intro a bit and separate the list by level. 2021-07-08 23:09:45 +02:00			`getCharacterInformation() <singularityfunctions/getCharacterInformation>`