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

hackAnalyze definition fix to match markdown

Browse Source
This commit is contained in:
pan-kuleczka 2022-01-02 18:56:52 +01:00
parent 8428264f05
commit 62c19c9078
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -4079,31 +4079,28 @@ export interface NS extends Singularity {
hackAnalyzeThreads(host: string, hackAmount: number): number;
/**
* Get the percent of money stolen with a single thread.
* Get the part of money stolen with a single thread.
* @remarks
* RAM cost: 1 GB
*
* 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
* (Netscript functions typically return in decimal form, but not this one).
* This percentage is influenced by the player's hacking skill.
* Returns the part of the specified server’s money you will steal with a single thread hack.
*
* @example
* ```ts
* // NS1:
* //For example, assume the following returns 0.01:
* var hackAmount = hackAnalyze("foodnstuff");
* //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N*0.01 times its total money.
* //This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money.
* ```
* @example
* ```ts
* // NS2:
* //For example, assume the following returns 0.01:
* const hackAmount = ns.hackAnalyze("foodnstuff");
* //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N*0.01 times its total money.
* //This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money.
* ```
* @param host - Hostname of the target server.
* @returns The percentage of money you will steal from the target server with a single hack.
* @returns The part of money you will steal from the target server with a single thread hack.
*/
hackAnalyze(host: string): number;