mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-20 16:22:56 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
97 lines
1.4 KiB
Markdown
97 lines
1.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptExpGain](./bitburner.ns.getscriptexpgain.md)
|
|
|
|
## NS.getScriptExpGain() method
|
|
|
|
Get the exp gain of a script.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
getScriptExpGain(script: string, host: string, ...args: ScriptArg[]): number;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
script
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Filename of script.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
host
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Hostname/IP of the server on which script is running.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
args
|
|
|
|
|
|
</td><td>
|
|
|
|
[ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
Arguments that the script is running with.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
number
|
|
|
|
Amount of hacking experience the specified script generates while online.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 0.1 GB
|
|
|
|
Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments.
|
|
|
|
This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments.
|
|
|