bitburner-src/markdown/bitburner.ns.isrunning.md

65 lines
2.3 KiB
Markdown
Raw Normal View History

2021-10-30 12:34:14 -04:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [isRunning](./bitburner.ns.isrunning.md)
## NS.isRunning() method
Check if a script is running.
2021-10-30 12:34:14 -04:00
<b>Signature:</b>
```typescript
2022-01-15 18:39:37 -05:00
isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean;
2021-10-30 12:34:14 -04:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2022-01-15 18:39:37 -05:00
| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. |
2021-11-03 00:27:21 -04:00
| host | string | Host of target server. |
2021-10-30 12:34:14 -04:00
| args | string\[\] | Arguments to specify/identify which scripts to search for. |
<b>Returns:</b>
boolean
True if specified script is running on the target server, and false otherwise.
## Remarks
2021-10-30 15:46:34 -04:00
RAM cost: 0.1 GB
2021-10-30 12:34:14 -04:00
2022-01-15 18:39:37 -05:00
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.
2021-10-30 12:34:14 -04:00
## Example 1
2021-10-30 15:46:34 -04:00
```ts
2022-01-08 13:25:06 -05:00
// NS1:
2021-10-30 12:34:14 -04:00
//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());
2022-01-08 13:25:06 -05:00
//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");
2021-10-30 12:34:14 -04:00
```
2022-01-08 13:25:06 -05:00
## Example 2
2021-10-30 12:34:14 -04:00
2021-10-30 15:46:34 -04:00
```ts
2022-01-08 13:25:06 -05:00
// 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());
2021-10-30 12:34:14 -04:00
//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:
2022-01-08 13:25:06 -05:00
ns.isRunning("foo.script", "joesguns", 1, 5, "test");
2021-10-30 12:34:14 -04:00
```