bitburner-src/markdown/bitburner.ns.getrunningscript.md
Olivier Gagnon f555c4567b update doc
2022-04-13 01:35:35 -04:00

35 lines
1.1 KiB
Markdown

<!-- 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; [getRunningScript](./bitburner.ns.getrunningscript.md)
## NS.getRunningScript() method
Get general info about a running script.
<b>Signature:</b>
```typescript
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript | null;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. |
| hostname | string | Optional. Name of host server the script is running on. |
| args | (string \| number)\[\] | Arguments to identify the script |
<b>Returns:</b>
[RunningScript](./bitburner.runningscript.md) \| null
The info about the running script if found, and null otherwise.
## Remarks
RAM cost: 0.3 GB
Running with no args returns current script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary.