bitburner-src/markdown/bitburner.ns.getscriptlogs.md

67 lines
2.2 KiB
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- 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.
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
2021-10-30 21:46:34 +02:00
getScriptLogs(fn?: string, host?: string, ...args: any[]): string[];
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2021-10-30 21:46:34 +02:00
| fn | string | Optional. Filename of script to get logs from. |
| host | string | Optional. Hostname of the server that the script is on. |
2021-10-30 18:34:14 +02:00
| args | any\[\] | Arguments to identify which scripts to get logs for. |
<b>Returns:</b>
string\[\]
Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array.
## Remarks
2021-10-30 21:46:34 +02:00
RAM cost: 0 GB
2021-10-30 18:34:14 +02:00
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.
2021-10-30 18:34:14 +02:00
## Example 1
2021-10-30 21:46:34 +02:00
```ts
2022-01-08 19:25:06 +01:00
// NS1:
2021-10-30 18:34:14 +02:00
//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");
2022-01-08 19:25:06 +01:00
//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"]
getScriptLogs("foo.script", "foodnstuff", 1, "test");
2021-10-30 18:34:14 +02:00
```
2022-01-08 19:25:06 +01:00
## Example 2
2021-10-30 18:34:14 +02:00
2021-10-30 21:46:34 +02:00
```ts
2022-01-08 19:25:06 +01:00
// 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");
2021-10-30 18:34:14 +02:00
//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"]
2022-01-08 19:25:06 +01:00
ns.getScriptLogs("foo.script", "foodnstuff", 1, "test");
2021-10-30 18:34:14 +02:00
```