API: Add ns.renderTail (bitburner-official#1815)

Author: catloversg

markdown/bitburner.ns.md

@@ -148,6 +148,7 @@ export async function main(ns) {
 |  [readPort(portNumber)](./bitburner.ns.readport.md) | Read data from a port. |
 |  [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. |
 |  [renamePurchasedServer(hostname, newName)](./bitburner.ns.renamepurchasedserver.md) | Rename a purchased server. |
+|  [renderTail(pid)](./bitburner.ns.rendertail.md) | Render a tail window. |
 |  [resizeTail(width, height, pid)](./bitburner.ns.resizetail.md) | Resize a tail window. |
 |  [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. |
 |  [run(script, threadOrOptions, args)](./bitburner.ns.run.md) | Start another script on the current server. |

markdown/bitburner.ns.rendertail.md

@@ -0,0 +1,30 @@
+<!-- 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; [renderTail](./bitburner.ns.rendertail.md)
+
+## NS.renderTail() method
+
+Render a tail window.
+
+**Signature:**
+
+```typescript
+renderTail(pid?: number): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  pid | number | _(Optional)_ Optional. PID of the script having its tail rendered. If omitted, the current script is used. |
+
+**Returns:**
+
+void
+
+## Remarks
+
+RAM cost: 0 GB
+
+Tail windows are rendered at an interval defined in game settings. This function renders the tail window of the specified script immediately.
+

src/Netscript/RamCostGenerator.ts

@@ -599,6 +599,7 @@ export const RamCosts: RamCostTree<NSFull> = {
   tail: 0,
   toast: 0,
   moveTail: 0,
+  renderTail: 0,
   resizeTail: 0,
   closeTail: 0,
   setTitle: 0,

src/NetscriptFunctions.ts

@@ -566,6 +566,17 @@ export const ns: InternalAPI<NSFull> = {
 
       LogBoxEvents.emit(runningScriptObj);
     },
+  renderTail:
+    (ctx) =>
+    (_pid = ctx.workerScript.scriptRef.pid) => {
+      const pid = helpers.number(ctx, "pid", _pid);
+      const runningScriptObj = helpers.getRunningScript(ctx, pid);
+      if (runningScriptObj == null) {
+        helpers.log(ctx, () => helpers.getCannotFindRunningScriptErrorMessage(pid));
+        return;
+      }
+      runningScriptObj.tailProps?.rerender();
+    },
   moveTail:
     (ctx) =>
     (_x, _y, _pid = ctx.workerScript.scriptRef.pid) => {

src/ScriptEditor/NetscriptDefinitions.d.ts

@@ -6406,6 +6406,19 @@ export interface NS {
    */
   tail(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): void;
 
+  /**
+   * Render a tail window.
+   *
+   * @remarks
+   * RAM cost: 0 GB
+   *
+   * Tail windows are rendered at an interval defined in game settings. This function renders the tail window of the
+   * specified script immediately.
+   *
+   * @param pid - Optional. PID of the script having its tail rendered. If omitted, the current script is used.
+   */
+  renderTail(pid?: number): void;
+
   /**
    * Move a tail window.
    * @remarks