DOC: Add ns documentation for possible sleeve tasks (#217)

* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
This commit is contained in:
Snarling
2022-11-20 12:07:22 -05:00
committed by GitHub
parent 88d51e9a7e
commit 65cd14e33b
369 changed files with 2767 additions and 2449 deletions
+3 -3
View File
@@ -16,17 +16,17 @@ getHackTime(host: string): number;
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Host of target server. |
| host | string | Hostname of target server. |
<b>Returns:</b>
number
Returns the amount of time in milliseconds it takes to execute the hack Netscript function.
Returns the amount of time in milliseconds it takes to execute the [hack](./bitburner.ns.hack.md) Netscript function.
## Remarks
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. The required time is increased by the security level of the target server and decreased by the player's hacking level.
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](./bitburner.ns.hack.md) Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level.