felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 06:18:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: ns.getScriptLog update to use "FilenameOrPID" and related ns.tail change (#753)

Browse Source
This commit is contained in:
missymae#2783
2023-08-28 12:49:37 -06:00
committed by GitHub
parent 101fb21c58
commit 4b627cde1e
3 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
markdown/bitburner.ns.getscriptlogs.md
View File

@@ -9,14 +9,14 @@ Get all the logs of a script.
**Signature:**
```typescript
getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
getScriptLogs(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): string[];
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | _(Optional)_ Optional. Filename of script to get logs from. |
| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of script to get logs from. |
| host | string | _(Optional)_ Optional. Hostname of the server that the script is on. |
| args | (string \| number \| boolean)\[\] | Arguments to identify which scripts to get logs for. |
@@ -32,7 +32,7 @@ RAM cost: 0 GB
Returns a script’s 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 game’s options. If the function is called with no arguments, it will return the current script’s 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.
Otherwise, the PID or filename, hostname/ip, and args… arguments can be used to get logs from another script. Remember that scripts are uniquely identified by both their names and arguments.
## Example

2
markdown/bitburner.ns.tail.md
View File

@@ -32,7 +32,7 @@ Opens a script’s logs. This is functionally the same as the tail Terminal comm
If the function is called with no arguments, it will open the current script’s 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.
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

8
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@@ -5101,7 +5101,7 @@ export interface NS {
* Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options.
* If the function is called with no arguments, it will return the current script’s logs.
*
* Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script.
* Otherwise, the PID or filename, hostname/ip, and args… arguments can be used to get logs from another script.
* Remember that scripts are uniquely identified by both their names and arguments.
*
* @example
@@ -5115,12 +5115,12 @@ export interface NS {
* //Open logs from foo.js on the foodnstuff server that was run with the arguments [1, "test"]
* ns.getScriptLogs("foo.js", "foodnstuff", 1, "test");
* ```
* @param fn - Optional. Filename of script to get logs from.
* @param fn - Optional. Filename or PID of script to get logs from.
* @param host - Optional. Hostname of the server that the script is on.
* @param args - Arguments to identify which scripts to get logs for.
* @returns 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.
*/
getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
getScriptLogs(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): string[];
/**
* Get an array of recently killed scripts across all servers.
@@ -5152,7 +5152,7 @@ export interface NS {
*
* If the function is called with no arguments, it will open the current script’s logs.
*
* Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script.
* 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