bitburner-src/markdown/bitburner.ns.getscriptincome.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

1.6 KiB
Raw Blame History

Home > bitburner > NS > getScriptIncome

NS.getScriptIncome() method

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.

This function can also be called with no arguments. If called with no arguments, then this function will return an array of two values. The first value is the total income ( / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income ( / second) that youve earned from scripts since you last installed Augmentations.

Signature:

getScriptIncome(script: Script, host: Host, ...args: string[]): number | [number, number];

Parameters

Parameter Type Description
script Script Filename of script.
host Host Server on which script is running.
args string[] Arguments that the script is running with.

Returns:

number | [number, number]

Amount of income the specified script generates while online.

Remarks

0.1 GB