bitburner-src/markdown/bitburner.ns.scriptrunning.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

1.8 KiB

Home > bitburner > NS > scriptRunning

NS.scriptRunning() method

Check if any script with a filename is running.

Signature:

scriptRunning(script: string, host: string): boolean;

Parameters

Parameter Type Description
script string Filename of script to check. This is case-sensitive.
host string Hostname of target server.

Returns:

boolean

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

Remarks

RAM cost: 1 GB

Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.

This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments.

Example 1

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

//The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise:
scriptRunning("foo.script", getHostname());

*

Example 2

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

//The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise:
ns.scriptRunning("foo.script", ns.getHostname());