bitburner-src/markdown/bitburner.ns.tail.md
Olivier Gagnon f4ac7344c4 doc
2022-01-08 13:25:06 -05:00

67 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- 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; [tail](./bitburner.ns.tail.md)
## NS.tail() method
Open the tail window of a script.
<b>Signature:</b>
```typescript
tail(fn?: string, host?: string, ...args: any[]): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Optional. Filename of the script being tailed. If omitted, the current script is tailed. |
| host | string | 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 | any\[\] | Arguments for the script being tailed. |
<b>Returns:</b>
void
## Remarks
RAM cost: 0 GB
Opens a scripts logs. This is functionally the same as the tail Terminal command.
If the function is called with no arguments, it will open the current scripts logs.
Otherwise, the fn, 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 1
```ts
// NS1:
//Open logs from foo.script on the current server that was run with no args
tail("foo.script");
//Get logs from foo.script on the foodnstuff server that was run with no args
tail("foo.script", "foodnstuff");
//Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"]
tail("foo.script", "foodnstuff", 1, "test");
```
## Example 2
```ts
// NS2:
//Open logs from foo.script on the current server that was run with no args
ns.tail("foo.script");
//Get logs from foo.script on the foodnstuff server that was run with no args
ns.tail("foo.script", "foodnstuff");
//Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"]
ns.tail("foo.script", "foodnstuff", 1, "test");
```