Files
bitburner-src/markdown/bitburner.ns.getscriptincome.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

1.4 KiB
Raw Blame History

Home > bitburner > NS > getScriptIncome

NS.getScriptIncome() method

Get the income of a script.

Signature:

getScriptIncome(script: string, host: string, ...args: ScriptArg[]): number;

Parameters

Parameter

Type

Description

script

string

Filename of script.

host

string

Hostname/IP of the server on which script is running.

args

ScriptArg[]

Arguments that the script is running with.

Returns:

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 scripts income you must specify those same arguments in the same order in this function call.