mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-27 19:37:07 +02:00
API: Move tail-related APIs to another namespace (#1935)
* API: Move tail-related APIs to another namespace * Add missing RAM cost config * Remove setTailFontSize from NS namespace
This commit is contained in:
@@ -0,0 +1,50 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [openTail](./bitburner.userinterface.opentail.md)
|
||||
|
||||
## UserInterface.openTail() method
|
||||
|
||||
Open the tail window of a script.
|
||||
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
openTail(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. |
|
||||
| host | string | _(Optional)_ Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. |
|
||||
| args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments for the script being tailed. |
|
||||
|
||||
**Returns:**
|
||||
|
||||
void
|
||||
|
||||
## Remarks
|
||||
|
||||
RAM cost: 0 GB
|
||||
|
||||
Opens a script’s logs. This is functionally the same as the tail Terminal command.
|
||||
|
||||
If the function is called with no arguments, it will open the current script’s logs.
|
||||
|
||||
Otherwise, the PID or filename, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
```js
|
||||
//Open logs from foo.js on the current server that was run with no args
|
||||
ns.tail("foo.js");
|
||||
|
||||
//Get logs from foo.js on the foodnstuff server that was run with no args
|
||||
ns.tail("foo.js", "foodnstuff");
|
||||
|
||||
//Get logs from foo.js on the foodnstuff server that was run with the arguments [1, "test"]
|
||||
ns.tail("foo.js", "foodnstuff", 1, "test");
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user