bitburner-src/markdown/bitburner.ns.isrunning.md
Olivier Gagnon 6b18bfb145 doc
2022-07-15 23:47:19 -04:00

2.4 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 Host of target server.
args (string | number | boolean)[] Arguments to specify/identify which scripts to search for.

Returns:

boolean

True if 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 uniquely identified by both its name and its arguments.

Example 1

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

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

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

Example 2

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

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

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