mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-25 17:13:47 +01:00
49 lines
2.2 KiB
Markdown
49 lines
2.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [isRunning](./bitburner.ns.isrunning.md)
|
|
|
|
## NS.isRunning() method
|
|
|
|
Check if a script is running.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
isRunning(script: FilenameOrPID, host?: string, ...args: ScriptArg[]): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. |
|
|
| host | string | _(Optional)_ Hostname of target server. Optional, defaults to the server the calling script is running on. |
|
|
| args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. |
|
|
|
|
**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. If hostname is omitted while filename is used as the first parameter, hostname defaults to the server the calling script is running on. 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
|
|
|
|
|
|
```js
|
|
//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");
|
|
```
|
|
|