Merge pull request #3813 from stalefishies/doc-fix

DOCUMENTATION: FIX #2602 Remove incorrect info from getHackTime and friends
This commit is contained in:
hydroflame 2022-07-06 14:33:40 -04:00 committed by GitHub
commit b067e05738
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -6209,13 +6209,13 @@ export interface NS {
* 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. * 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 required time is increased by the security level of the target server and decreased by the player's hacking level. * 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.
* @returns Returns the amount of time in milliseconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the hack Netscript function.
*/ */
getHackTime(host: string): number; getHackTime(host: string): number;
@ -6225,11 +6225,10 @@ export interface NS {
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *
* 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 required time is increased by the security level of the target server and decreased by the player's hacking level. * 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.
* @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function.
*/ */
getGrowTime(host: string): number; getGrowTime(host: string): number;
@ -6239,11 +6238,10 @@ export interface NS {
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *
* 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 required time is increased by the security level of the target server and decreased by the player's hacking level. * 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.
* @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function.
*/ */
getWeakenTime(host: string): number; getWeakenTime(host: string): number;