NETSCRIPT: A minorly breaking change around script launch, and refact…

…oring. (#1213)

markdown/bitburner.ns.args.md

@@ -9,7 +9,7 @@ Arguments passed into the script.
 **Signature:**
 
 ```typescript
-readonly args: (string | number | boolean)[];
+readonly args: ScriptArg[];
 ```
 
 ## Remarks

markdown/bitburner.ns.exec.md

@@ -9,12 +9,7 @@ Start another script on any server.
 **Signature:**
 
 ```typescript
-exec(
-    script: string,
-    hostname: string,
-    threadOrOptions?: number | RunOptions,
-    ...args: (string | number | boolean)[]
-  ): number;
+exec(script: string, hostname: string, threadOrOptions?: number | RunOptions, ...args: ScriptArg[]): number;
 ```
 
 ## Parameters
@@ -24,7 +19,7 @@ exec(
 |  script | string | Filename of script to execute. This file must already exist on the target server. |
 |  hostname | string | Hostname of the <code>target server</code> on which to execute the script. |
 |  threadOrOptions | number \| [RunOptions](./bitburner.runoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. |
-|  args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value. |
 
 **Returns:**
 

markdown/bitburner.ns.getrunningscript.md

@@ -9,11 +9,7 @@ Get general info about a running script.
 **Signature:**
 
 ```typescript
-getRunningScript(
-    filename?: FilenameOrPID,
-    hostname?: string,
-    ...args: (string | number | boolean)[]
-  ): RunningScript | null;
+getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: ScriptArg[]): RunningScript | null;
 ```
 
 ## Parameters
@@ -22,7 +18,7 @@ getRunningScript(
 |  --- | --- | --- |
 |  filename | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script. |
 |  hostname | string | _(Optional)_ Hostname of target server. Optional, defaults to the server the calling script is running on. |
-|  args | (string \| number \| boolean)\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. |
 
 **Returns:**
 

markdown/bitburner.ns.getscriptexpgain.md

@@ -9,7 +9,7 @@ Get the exp gain of a script.
 **Signature:**
 
 ```typescript
-getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number;
+getScriptExpGain(script: string, host: string, ...args: ScriptArg[]): number;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ getScriptExpGain(script: string, host: string, ...args: (string | number | boole
 |  --- | --- | --- |
 |  script | string | Filename of script. |
 |  host | string | Server on which script is running. |
-|  args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments that the script is running with. |
 
 **Returns:**
 

markdown/bitburner.ns.getscriptincome.md

@@ -9,7 +9,7 @@ Get the income of a script.
 **Signature:**
 
 ```typescript
-getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
+getScriptIncome(script: string, host: string, ...args: ScriptArg[]): number;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ getScriptIncome(script: string, host: string, ...args: (string | number | boolea
 |  --- | --- | --- |
 |  script | string | Filename of script. |
 |  host | string | Server on which script is running. |
-|  args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments that the script is running with. |
 
 **Returns:**
 

markdown/bitburner.ns.getscriptlogs.md

@@ -9,7 +9,7 @@ Get all the logs of a script.
 **Signature:**
 
 ```typescript
-getScriptLogs(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): string[];
+getScriptLogs(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): string[];
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ getScriptLogs(fn?: FilenameOrPID, host?: string, ...args: (string | number | boo
 |  --- | --- | --- |
 |  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. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments to identify which scripts to get logs for. |
 
 **Returns:**
 

markdown/bitburner.ns.isrunning.md

@@ -9,7 +9,7 @@ Check if a script is running.
 **Signature:**
 
 ```typescript
-isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;
+isRunning(script: FilenameOrPID, host?: string, ...args: ScriptArg[]): boolean;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | bool
 |  --- | --- | --- |
 |  script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. |
 |  host | string | _(Optional)_ Hostname of target server. Optional, defaults to the server the calling script is running on. |
-|  args | (string \| number \| boolean)\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. |
 
 **Returns:**
 

markdown/bitburner.ns.md

@@ -31,7 +31,7 @@ export async function main(ns) {
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [args](./bitburner.ns.args.md) | <code>readonly</code> | (string \| number \| boolean)\[\] | Arguments passed into the script. |
+|  [args](./bitburner.ns.args.md) | <code>readonly</code> | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments passed into the script. |
 |  [bladeburner](./bitburner.ns.bladeburner.md) | <code>readonly</code> | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. Contains spoilers. |
 |  [codingcontract](./bitburner.ns.codingcontract.md) | <code>readonly</code> | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. |
 |  [corporation](./bitburner.ns.corporation.md) | <code>readonly</code> | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. Contains spoilers. |

markdown/bitburner.ns.run.md

@@ -9,7 +9,7 @@ Start another script on the current server.
 **Signature:**
 
 ```typescript
-run(script: string, threadOrOptions?: number | RunOptions, ...args: (string | number | boolean)[]): number;
+run(script: string, threadOrOptions?: number | RunOptions, ...args: ScriptArg[]): number;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ run(script: string, threadOrOptions?: number | RunOptions, ...args: (string | nu
 |  --- | --- | --- |
 |  script | string | Filename of script to run. |
 |  threadOrOptions | number \| [RunOptions](./bitburner.runoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. |
-|  args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument threadOrOptions must be filled in with a value. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument threadOrOptions must be filled in with a value. |
 
 **Returns:**
 

markdown/bitburner.ns.spawn.md

@@ -9,7 +9,7 @@ Terminate current script and start another in a defined number of milliseconds.
 **Signature:**
 
 ```typescript
-spawn(script: string, threadOrOptions?: number | SpawnOptions, ...args: (string | number | boolean)[]): void;
+spawn(script: string, threadOrOptions?: number | SpawnOptions, ...args: ScriptArg[]): void;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ spawn(script: string, threadOrOptions?: number | SpawnOptions, ...args: (string
 |  --- | --- | --- |
 |  script | string | Filename of script to execute. |
 |  threadOrOptions | number \| [SpawnOptions](./bitburner.spawnoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [SpawnOptions](./bitburner.spawnoptions.md) object. Threads defaults to 1 and spawnDelay defaults to 10,000 ms. |
-|  args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Additional arguments to pass into the new script that is being run. |
 
 **Returns:**
 

markdown/bitburner.ns.tail.md

@@ -9,7 +9,7 @@ Open the tail window of a script.
 **Signature:**
 
 ```typescript
-tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
+tail(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): void;
 ```
 
 ## Parameters
@@ -18,7 +18,7 @@ tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]):
 |  --- | --- | --- |
 |  fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. |
 |  host | string | _(Optional)_ 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 | (string \| number \| boolean)\[\] | Arguments for the script being tailed. |
+|  args | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments for the script being tailed. |
 
 **Returns:**
 

markdown/bitburner.processinfo.args.md

@@ -9,5 +9,5 @@ Script's arguments
 **Signature:**
 
 ```typescript
-args: (string | number | boolean)[];
+args: ScriptArg[];
 ```

markdown/bitburner.processinfo.md

@@ -16,7 +16,7 @@ interface ProcessInfo
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [args](./bitburner.processinfo.args.md) |  | (string \| number \| boolean)\[\] | Script's arguments |
+|  [args](./bitburner.processinfo.args.md) |  | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Script's arguments |
 |  [filename](./bitburner.processinfo.filename.md) |  | string | Script name. |
 |  [pid](./bitburner.processinfo.pid.md) |  | number | Process ID |
 |  [temporary](./bitburner.processinfo.temporary.md) |  | boolean | Whether this process is excluded from saves |

markdown/bitburner.runningscript.args.md

@@ -9,5 +9,5 @@ Arguments the script was called with
 **Signature:**
 
 ```typescript
-args: (string | number | boolean)[];
+args: ScriptArg[];
 ```

markdown/bitburner.runningscript.md

@@ -15,7 +15,7 @@ interface RunningScript
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [args](./bitburner.runningscript.args.md) |  | (string \| number \| boolean)\[\] | Arguments the script was called with |
+|  [args](./bitburner.runningscript.args.md) |  | [ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\] | Arguments the script was called with |
 |  [filename](./bitburner.runningscript.filename.md) |  | string | Filename of the script |
 |  [logs](./bitburner.runningscript.logs.md) |  | string\[\] | Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside <code>[brackets]</code> at the start of each line. |
 |  [offlineExpGained](./bitburner.runningscript.offlineexpgained.md) |  | number | Total amount of hacking experience earned from this script when offline |

src/Netscript/NetscriptHelpers.tsx

@@ -1,13 +1,12 @@
 import type { NetscriptContext } from "./APIWrapper";
+import type { RunningScript as IRunningScript, Person as IPerson, Server as IServer, ScriptArg } from "@nsdefs";
 
 import React from "react";
 import { killWorkerScript } from "./killWorkerScript";
 import { GetAllServers, GetServer } from "../Server/AllServers";
 import { Player } from "@player";
 import { ScriptDeath } from "./ScriptDeath";
 import { formatExp, formatMoney, formatRam, formatThreads } from "../ui/formatNumber";
-import { ScriptArg } from "./ScriptArg";
-import { RunningScript as IRunningScript, Person as IPerson, Server as IServer } from "@nsdefs";
 import { Server } from "../Server/Server";
 import {
   calculateHackingChance,

src/Netscript/ScriptIdentifier.ts

@@ -1,4 +1,4 @@
-import { ScriptArg } from "./ScriptArg";
+import type { ScriptArg } from "@nsdefs";
 
 //This was previously in INetscriptHelper.ts, may move to its own file or a generic types file.
 export type ScriptIdentifier =

src/Netscript/WorkerScript.ts

@@ -12,7 +12,7 @@ import type { NSFull } from "../NetscriptFunctions";
 import type { ScriptFilePath } from "../Paths/ScriptFilePath";
 import type { RunningScript } from "../Script/RunningScript";
 import type { Script } from "../Script/Script";
-import type { ScriptArg } from "./ScriptArg";
+import type { ScriptArg } from "@nsdefs";
 import type { ScriptDeath } from "./ScriptDeath";
 
 import { Environment } from "./Environment";

src/NetscriptFunctions/Flags.ts

@@ -1,6 +1,6 @@
+import type { ScriptArg } from "@nsdefs";
 import { toNative } from "./toNative";
 import libarg from "arg";
-import { ScriptArg } from "../Netscript/ScriptArg";
 import { NetscriptContext } from "../Netscript/APIWrapper";
 
 type FlagType = StringConstructor | NumberConstructor | BooleanConstructor | StringConstructor[];

src/NetscriptWorker.ts

@@ -57,10 +57,12 @@ async function startNetscript2Script(workerScript: WorkerScript): Promise<void>
   const loadedModule = await compile(script, scripts);
 
   if (!loadedModule) throw `${script.filename} cannot be run because the script module won't load`;
+  const mainFunc = loadedModule.main;
   // TODO unplanned: Better error for "unexpected reserved word" when using await in non-async function?
-  if (typeof loadedModule.main !== "function")
+  if (typeof mainFunc !== "function")
     throw `${script.filename} cannot be run because it does not have a main function.`;
-  await loadedModule.main(ns);
+  // Explicitly called from a variable so that we don't bind "this".
+  await mainFunc(ns);
 }
 
 async function startNetscript1Script(workerScript: WorkerScript): Promise<void> {

src/Script/LoadedModule.ts

@@ -1,12 +1,12 @@
-import { NSFull } from "../NetscriptFunctions";
-import { AutocompleteData } from "@nsdefs";
+import type { NSFull } from "../NetscriptFunctions";
+import type { AutocompleteData, ScriptArg } from "@nsdefs";
 
 // The object portion of this type is not runtime information, it's only to ensure type validation
 // And make it harder to overwrite a url with a random non-url string.
 export type ScriptURL = string & { __type: "ScriptURL" };
 
 export interface ScriptModule {
-  main?: (ns: NSFull) => unknown;
+  main?: (ns: NSFull, ...args: ScriptArg[]) => unknown;
   autocomplete?: (data: AutocompleteData, flags: string[]) => unknown;
 }