bitburner-src/markdown/bitburner.ns.getscriptlogs.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

67 lines
2.3 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; [getScriptLogs](./bitburner.ns.getscriptlogs.md)
## NS.getScriptLogs() method
Get all the logs of a script.
<b>Signature:</b>
```typescript
getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Optional. Filename of script to get logs from. |
| host | string | Optional. Hostname of the server that the script is on. |
| args | (string \| number \| boolean)\[\] | Arguments to identify which scripts to get logs for. |
<b>Returns:</b>
string\[\]
Returns a string array, where each line is an element in the array. The most recently logged line is at the end of the array.
## Remarks
RAM cost: 0 GB
Returns a scripts logs. The logs are returned as an array, where each line is an element in the array. The most recently logged line is at the end of the array. Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the games options. If the function is called with no arguments, it will return 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:
//Get logs from foo.script on the current server that was run with no args
getScriptLogs("foo.script");
//Open logs from foo.script on the foodnstuff server that was run with no args
getScriptLogs("foo.script", "foodnstuff");
//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"]
getScriptLogs("foo.script", "foodnstuff", 1, "test");
```
## Example 2
```ts
// NS2:
//Get logs from foo.script on the current server that was run with no args
ns.getScriptLogs("foo.script");
//Open logs from foo.script on the foodnstuff server that was run with no args
ns.getScriptLogs("foo.script", "foodnstuff");
//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"]
ns.getScriptLogs("foo.script", "foodnstuff", 1, "test");
```