mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-22 23:53:48 +01:00
65 lines
2.4 KiB
Markdown
65 lines
2.4 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: (string | number | boolean)[]): 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. |
|
|
| 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 uniquely identified by both its name and its arguments.
|
|
|
|
## Example 1
|
|
|
|
|
|
```ts
|
|
// 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
|
|
|
|
|
|
```ts
|
|
// 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");
|
|
```
|
|
|