DOCUMENTATION: Remove wrong information in ns.weaken (#1574)

* DOCUMENTATION: Remove wrong information in ns.weaken

* Update based on the feedback
This commit is contained in:
catloversg 2024-08-15 12:07:42 +07:00 committed by GitHub
parent e3dc867e08
commit 1d9e026b6e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 10 additions and 4 deletions

@ -33,7 +33,7 @@ Function that is used to try and hack servers to steal money and gain hacking ex
A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game. A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game.
A successful `hack()` on a server will raise that servers security level by 0.002. A successful `hack()` on a server will raise that servers security level by 0.002 per thread. You can use [hackAnalyzeSecurity](./bitburner.ns.hackanalyzesecurity.md) to calculate the security increase for a number of threads.
## Example ## Example

@ -29,7 +29,9 @@ A promise that resolves to the value by which security was reduced.
RAM cost: 0.15 GB RAM cost: 0.15 GB
Use your hacking skills to attack a servers security, lowering the servers security level. The runtime for this function depends on your hacking level and the target servers security level when this function is called. This function lowers the security level of the target server by 0.05. Use your hacking skills to attack a servers security, lowering the servers security level. The runtime for this function depends on your hacking level and the target servers security level when this function is called.
This function usually lowers the security level of the target server by 0.05 per thread, and only in unusual situations does it do less. Use [weakenAnalyze](./bitburner.ns.weakenanalyze.md) to determine the exact value.
Like [hack](./bitburner.ns.hack.md) and [grow](./bitburner.ns.grow.md)<!-- -->, `weaken` can be called on any server, regardless of where the script is running. This function requires root access to the target server, but there is no required hacking level to run the function. Like [hack](./bitburner.ns.hack.md) and [grow](./bitburner.ns.grow.md)<!-- -->, `weaken` can be called on any server, regardless of where the script is running. This function requires root access to the target server, but there is no required hacking level to run the function.

@ -5547,7 +5547,8 @@ export interface NS {
* server to hack that server. For example, you can create a script that hacks the `foodnstuff` * server to hack that server. For example, you can create a script that hacks the `foodnstuff`
* server and run that script on any server in the game. * server and run that script on any server in the game.
* *
* A successful `hack()` on a server will raise that servers security level by 0.002. * A successful `hack()` on a server will raise that servers security level by 0.002 per thread. You can use
* {@link NS.hackAnalyzeSecurity | hackAnalyzeSecurity} to calculate the security increase for a number of threads.
* *
* @example * @example
* ```js * ```js
@ -5612,7 +5613,10 @@ export interface NS {
* *
* Use your hacking skills to attack a servers security, lowering the servers security level. * Use your hacking skills to attack a servers security, lowering the servers security level.
* The runtime for this function depends on your hacking level and the target servers security * The runtime for this function depends on your hacking level and the target servers security
* level when this function is called. This function lowers the security level of the target server by 0.05. * level when this function is called.
*
* This function usually lowers the security level of the target server by 0.05 per thread, and only in unusual
* situations does it do less. Use {@link NS.weakenAnalyze | weakenAnalyze} to determine the exact value.
* *
* Like {@link NS.hack | hack} and {@link NS.grow| grow}, `weaken` can be called on any server, regardless of * Like {@link NS.hack | hack} and {@link NS.grow| grow}, `weaken` can be called on any server, regardless of
* where the script is running. This function requires root access to the target server, but * where the script is running. This function requires root access to the target server, but