bitburner-src/markdown/bitburner.ns.isrunning.md
David Walker aa7facd4ba
NETSCRIPT: Greatly speed up script launching, and remove the limitation unique args per script ()
* Remove the limitation unique args per script
* Internal changes to how runningScripts are stored on the server, to make common usage faster.
2023-04-27 18:21:06 -04:00

1.9 KiB

Home > bitburner > NS > isRunning

NS.isRunning() method

Check if a script is running.

Signature:

isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;

Parameters

Parameter Type Description
script FilenameOrPID Filename or PID of script to check. This is case-sensitive.
host string (Optional) Hostname of target server.
args (string | number | boolean)[] Arguments to specify/identify which scripts to search for.

Returns:

boolean

True if the specified script is running on the target server, and false otherwise.

Remarks

RAM cost: 0.1 GB

Returns a boolean indicating whether the specified script is running on the target server. If you use a PID instead of a filename, the hostname and args parameters are unnecessary. Remember that a script is semi-uniquely identified by both its name and its arguments. (You can run multiple copies of scripts with the same arguments, but for the purposes of functions like this that check based on filename, the filename plus arguments forms the key.)

Example

//The function call will return true if there is a script named foo.js with no arguments running on the foodnstuff server, and false otherwise:
ns.isRunning("foo.js", "foodnstuff");

//The function call will return true if there is a script named foo.js with no arguments running on the current server, and false otherwise:
ns.isRunning("foo.js", ns.getHostname());

//The function call will return true if there is a script named foo.js running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise:
ns.isRunning("foo.js", "joesguns", 1, 5, "test");