mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-18 21:53:50 +01:00
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptIncome](./bitburner.ns.getscriptincome.md)
|
||
|
||
## NS.getScriptIncome() method
|
||
|
||
Get the income of a script.
|
||
|
||
<b>Signature:</b>
|
||
|
||
```typescript
|
||
getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
| Parameter | Type | Description |
|
||
| --- | --- | --- |
|
||
| script | string | Filename of script. |
|
||
| host | string | Server on which script is running. |
|
||
| args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
|
||
|
||
<b>Returns:</b>
|
||
|
||
number
|
||
|
||
Amount of income the specified script generates while online.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 0.1 GB
|
||
|
||
Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call.
|
||
|