Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-26 17:43:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2111 from mikomyazaki/2027-documentation-updates

Browse Source 
Documentation updates
This commit is contained in:
hydroflame 2021-12-22 14:30:14 -05:00 committed by GitHub
commit dbf8c788e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -3867,7 +3867,7 @@ export interface NS extends Singularity {
* *
* Function that is used to try and hack servers to steal money and gain hacking experience. * Function that is used to try and hack servers to steal money and gain hacking experience.
* The runtime for this command depends on your hacking level and the target server’s * The runtime for this command depends on your hacking level and the target server’s
* security level. In order to hack a server you must first gain root access to that server * security level when this function is called. In order to hack a server you must first gain root access to that server
* and also have the required hacking level. * and also have the required hacking level.
* *
* A script can hack a server from anywhere. It does not need to be running on the same * A script can hack a server from anywhere. It does not need to be running on the same
@ -3922,7 +3922,7 @@ export interface NS extends Singularity {
* *
* Use your hacking skills to attack a server’s security, lowering the server’s security level. * Use your hacking skills to attack a server’s security, lowering the server’s security level.
* The runtime for this command depends on your hacking level and the target server’s security * The runtime for this command depends on your hacking level and the target server’s security
* level. This function lowers the security level of the target server by 0.05. * level when this function is called. This function lowers the security level of the target server by 0.05.
* *
* Like hack and grow, `weaken` can be called on any server, regardless of * Like hack and grow, `weaken` can be called on any server, regardless of
* where the script is running. This command requires root access to the target server, but * where the script is running. This command requires root access to the target server, but
@ -3984,6 +3984,7 @@ export interface NS extends Singularity {
* Returns the percentage of the specified server’s money you will steal with a single hack. * Returns the percentage of the specified server’s money you will steal with a single hack.
* This value is returned in percentage form, not decimal * This value is returned in percentage form, not decimal
* (Netscript functions typically return in decimal form, but not this one). * (Netscript functions typically return in decimal form, but not this one).
* This percentage is influenced by the player's hacking skill.
* *
* @example * @example
* ```ts * ```ts
@ -5157,9 +5158,10 @@ export interface NS extends Singularity {
* Get the execution time of a hack() call. * Get the execution time of a hack() call.
* @remarks * @remarks
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *When `hack` completes an amount of money is stolen depending on the player's skills.
* Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. * The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.
@ -5175,6 +5177,7 @@ export interface NS extends Singularity {
* *
* Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. * The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.
@ -5190,6 +5193,7 @@ export interface NS extends Singularity {
* *
* Returns the amount of time in milliseconds it takes to execute the weaken() Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the weaken() Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. * The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.