merge dev

src/NetscriptFunctions/Gang.ts

@@ -1,5 +1,5 @@
-import { FactionNames } from '../Faction/data/FactionNames';
-import { GangConstants } from '../Gang/data/Constants';
+import { FactionNames } from "../Faction/data/FactionNames";
+import { GangConstants } from "../Gang/data/Constants";
 import { INetscriptHelper } from "./INetscriptHelper";
 import { IPlayer } from "../PersonObjects/IPlayer";
 import { getRamCost } from "../Netscript/RamCostGenerator";
@@ -48,7 +48,8 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
   };
 
   return {
-    createGang: function (faction: string): boolean {
+    createGang: function (_faction: unknown): boolean {
+      const faction = helper.string("createGang", "faction", _faction);
       helper.updateDynamicRam("createGang", getRamCost(player, "gang", "createGang"));
       // this list is copied from Faction/ui/Root.tsx
 
@@ -101,12 +102,13 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
 
       return cpy;
     },
-    getMemberInformation: function (name: any): GangMemberInfo {
+    getMemberInformation: function (_memberName: unknown): GangMemberInfo {
+      const memberName = helper.string("getMemberInformation", "memberName", _memberName);
       helper.updateDynamicRam("getMemberInformation", getRamCost(player, "gang", "getMemberInformation"));
       checkGangApiAccess("getMemberInformation");
       const gang = player.gang;
       if (gang === null) throw new Error("Should not be called without Gang");
-      const member = getGangMember("getMemberInformation", name);
+      const member = getGangMember("getMemberInformation", memberName);
       return {
         name: member.name,
         task: member.task,
@@ -161,16 +163,17 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
       if (gang === null) throw new Error("Should not be called without Gang");
       return gang.canRecruitMember();
     },
-    recruitMember: function (name: any): boolean {
+    recruitMember: function (_memberName: unknown): boolean {
+      const memberName = helper.string("recruitMember", "memberName", _memberName);
       helper.updateDynamicRam("recruitMember", getRamCost(player, "gang", "recruitMember"));
       checkGangApiAccess("recruitMember");
       const gang = player.gang;
       if (gang === null) throw new Error("Should not be called without Gang");
-      const recruited = gang.recruitMember(name);
+      const recruited = gang.recruitMember(memberName);
       if (recruited) {
-        workerScript.log("gang.recruitMember", () => `Successfully recruited Gang Member '${name}'`);
+        workerScript.log("gang.recruitMember", () => `Successfully recruited Gang Member '${memberName}'`);
       } else {
-        workerScript.log("gang.recruitMember", () => `Failed to recruit Gang Member '${name}'`);
+        workerScript.log("gang.recruitMember", () => `Failed to recruit Gang Member '${memberName}'`);
       }
 
       return recruited;
@@ -184,7 +187,9 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
       tasks.unshift("Unassigned");
       return tasks;
     },
-    setMemberTask: function (memberName: any, taskName: any): boolean {
+    setMemberTask: function (_memberName: unknown, _taskName: unknown): boolean {
+      const memberName = helper.string("setMemberTask", "memberName", _memberName);
+      const taskName = helper.string("setMemberTask", "taskName", _taskName);
       helper.updateDynamicRam("setMemberTask", getRamCost(player, "gang", "setMemberTask"));
       checkGangApiAccess("setMemberTask");
       const member = getGangMember("setMemberTask", memberName);
@@ -193,9 +198,10 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
       if (!gang.getAllTaskNames().includes(taskName)) {
         workerScript.log(
           "gang.setMemberTask",
-          () => `Failed to assign Gang Member '${memberName}' to Invalid task '${taskName}'. '${memberName}' is now Unassigned`,
+          () =>
+            `Failed to assign Gang Member '${memberName}' to Invalid task '${taskName}'. '${memberName}' is now Unassigned`,
         );
-        return member.assignToTask('Unassigned');
+        return member.assignToTask("Unassigned");
       }
       const success = member.assignToTask(taskName);
       if (success) {
@@ -212,7 +218,8 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
 
       return success;
     },
-    getTaskStats: function (taskName: any): GangTaskStats {
+    getTaskStats: function (_taskName: unknown): GangTaskStats {
+      const taskName = helper.string("getTaskStats", "taskName", _taskName);
       helper.updateDynamicRam("getTaskStats", getRamCost(player, "gang", "getTaskStats"));
       checkGangApiAccess("getTaskStats");
       const task = getGangTask("getTaskStats", taskName);
@@ -225,7 +232,8 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
       checkGangApiAccess("getEquipmentNames");
       return Object.keys(GangMemberUpgrades);
     },
-    getEquipmentCost: function (equipName: any): number {
+    getEquipmentCost: function (_equipName: any): number {
+      const equipName = helper.string("getEquipmentCost", "equipName", _equipName);
       helper.updateDynamicRam("getEquipmentCost", getRamCost(player, "gang", "getEquipmentCost"));
       checkGangApiAccess("getEquipmentCost");
       const gang = player.gang;
@@ -234,14 +242,16 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
       if (upg === null) return Infinity;
       return gang.getUpgradeCost(upg);
     },
-    getEquipmentType: function (equipName: any): string {
+    getEquipmentType: function (_equipName: unknown): string {
+      const equipName = helper.string("getEquipmentType", "equipName", _equipName);
       helper.updateDynamicRam("getEquipmentType", getRamCost(player, "gang", "getEquipmentType"));
       checkGangApiAccess("getEquipmentType");
       const upg = GangMemberUpgrades[equipName];
       if (upg == null) return "";
       return upg.getType();
     },
-    getEquipmentStats: function (equipName: any): EquipmentStats {
+    getEquipmentStats: function (_equipName: unknown): EquipmentStats {
+      const equipName = helper.string("getEquipmentStats", "equipName", _equipName);
       helper.updateDynamicRam("getEquipmentStats", getRamCost(player, "gang", "getEquipmentStats"));
       checkGangApiAccess("getEquipmentStats");
       const equipment = GangMemberUpgrades[equipName];
@@ -251,7 +261,9 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
       const typecheck: EquipmentStats = equipment.mults;
       return Object.assign({}, typecheck) as any;
     },
-    purchaseEquipment: function (memberName: any, equipName: any): boolean {
+    purchaseEquipment: function (_memberName: unknown, _equipName: unknown): boolean {
+      const memberName = helper.string("purchaseEquipment", "memberName", _memberName);
+      const equipName = helper.string("purchaseEquipment", "equipName", _equipName);
       helper.updateDynamicRam("purchaseEquipment", getRamCost(player, "gang", "purchaseEquipment"));
       checkGangApiAccess("purchaseEquipment");
       const gang = player.gang;
@@ -271,28 +283,31 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
 
       return res;
     },
-    ascendMember: function (name: any): GangMemberAscension | undefined {
+    ascendMember: function (_memberName: unknown): GangMemberAscension | undefined {
+      const memberName = helper.string("ascendMember", "memberName", _memberName);
       helper.updateDynamicRam("ascendMember", getRamCost(player, "gang", "ascendMember"));
       checkGangApiAccess("ascendMember");
       const gang = player.gang;
       if (gang === null) throw new Error("Should not be called without Gang");
-      const member = getGangMember("ascendMember", name);
+      const member = getGangMember("ascendMember", memberName);
       if (!member.canAscend()) return;
       return gang.ascendMember(member, workerScript);
     },
-    getAscensionResult: function (name: any): GangMemberAscension | undefined {
+    getAscensionResult: function (_memberName: unknown): GangMemberAscension | undefined {
+      const memberName = helper.string("getAscensionResult", "memberName", _memberName);
       helper.updateDynamicRam("getAscensionResult", getRamCost(player, "gang", "getAscensionResult"));
       checkGangApiAccess("getAscensionResult");
       const gang = player.gang;
       if (gang === null) throw new Error("Should not be called without Gang");
-      const member = getGangMember("getAscensionResult", name);
+      const member = getGangMember("getAscensionResult", memberName);
       if (!member.canAscend()) return;
       return {
         respect: member.earnedRespect,
         ...member.getAscensionResults(),
       };
     },
-    setTerritoryWarfare: function (engage: any): void {
+    setTerritoryWarfare: function (_engage: unknown): void {
+      const engage = helper.boolean(_engage);
       helper.updateDynamicRam("setTerritoryWarfare", getRamCost(player, "gang", "setTerritoryWarfare"));
       checkGangApiAccess("setTerritoryWarfare");
       const gang = player.gang;
@@ -305,7 +320,8 @@ export function NetscriptGang(player: IPlayer, workerScript: WorkerScript, helpe
         workerScript.log("gang.setTerritoryWarfare", () => "Disengaging in Gang Territory Warfare");
       }
     },
-    getChanceToWinClash: function (otherGang: any): number {
+    getChanceToWinClash: function (_otherGang: unknown): number {
+      const otherGang = helper.string("getChanceToWinClash", "otherGang", _otherGang);
       helper.updateDynamicRam("getChanceToWinClash", getRamCost(player, "gang", "getChanceToWinClash"));
       checkGangApiAccess("getChanceToWinClash");
       const gang = player.gang;

src/NetscriptFunctions/Grafting.ts

@@ -0,0 +1,88 @@
+import { CityName } from "../Locations/data/CityNames";
+import { Augmentations } from "../Augmentation/Augmentations";
+import { getRamCost } from "../Netscript/RamCostGenerator";
+import { WorkerScript } from "../Netscript/WorkerScript";
+import { GraftableAugmentation } from "../PersonObjects/Grafting/GraftableAugmentation";
+import { getAvailableAugs } from "../PersonObjects/Grafting/ui/GraftingRoot";
+import { IPlayer } from "../PersonObjects/IPlayer";
+import { Grafting as IGrafting } from "../ScriptEditor/NetscriptDefinitions";
+import { Router } from "../ui/GameRoot";
+import { INetscriptHelper } from "./INetscriptHelper";
+
+export function NetscriptGrafting(player: IPlayer, workerScript: WorkerScript, helper: INetscriptHelper): IGrafting {
+  const checkGraftingAPIAccess = (func: string): void => {
+    if (!player.canAccessGrafting()) {
+      throw helper.makeRuntimeErrorMsg(
+        `grafting.${func}`,
+        "You do not currently have access to the Grafting API. This is either because you are not in BitNode 10 or because you do not have Source-File 10",
+      );
+    }
+  };
+
+  return {
+    getAugmentationGraftPrice: (_augName: unknown): number => {
+      const augName = helper.string("getAugmentationGraftPrice", "augName", _augName);
+      helper.updateDynamicRam("getAugmentationGraftPrice", getRamCost(player, "grafting", "getAugmentationGraftPrice"));
+      checkGraftingAPIAccess("getAugmentationGraftPrice");
+      if (!Augmentations.hasOwnProperty(augName)) {
+        throw helper.makeRuntimeErrorMsg("grafting.getAugmentationGraftPrice", `Invalid aug: ${augName}`);
+      }
+      const craftableAug = new GraftableAugmentation(Augmentations[augName]);
+      return craftableAug.cost;
+    },
+
+    getAugmentationGraftTime: (_augName: string): number => {
+      const augName = helper.string("getAugmentationGraftTime", "augName", _augName);
+      helper.updateDynamicRam("getAugmentationGraftTime", getRamCost(player, "grafting", "getAugmentationGraftTime"));
+      checkGraftingAPIAccess("getAugmentationGraftTime");
+      if (!Augmentations.hasOwnProperty(augName)) {
+        throw helper.makeRuntimeErrorMsg("grafting.getAugmentationGraftTime", `Invalid aug: ${augName}`);
+      }
+      const craftableAug = new GraftableAugmentation(Augmentations[augName]);
+      return craftableAug.time;
+    },
+
+    graftAugmentation: (_augName: string, _focus: unknown = true): boolean => {
+      const augName = helper.string("graftAugmentation", "augName", _augName);
+      const focus = helper.boolean(_focus);
+      helper.updateDynamicRam("graftAugmentation", getRamCost(player, "grafting", "graftAugmentation"));
+      checkGraftingAPIAccess("graftAugmentation");
+      if (player.city !== CityName.NewTokyo) {
+        throw helper.makeRuntimeErrorMsg(
+          "grafting.graftAugmentation",
+          "You must be in New Tokyo to begin crafting an Augmentation.",
+        );
+      }
+      if (!getAvailableAugs(player).includes(augName)) {
+        workerScript.log("grafting.graftAugmentation", () => `Invalid aug: ${augName}`);
+        return false;
+      }
+
+      const wasFocusing = player.focus;
+      if (player.isWorking) {
+        const txt = player.singularityStopWork();
+        workerScript.log("graftAugmentation", () => txt);
+      }
+
+      const craftableAug = new GraftableAugmentation(Augmentations[augName]);
+      if (player.money < craftableAug.cost) {
+        workerScript.log("grafting.graftAugmentation", () => `You don't have enough money to craft ${augName}`);
+        return false;
+      }
+
+      player.loseMoney(craftableAug.cost, "augmentations");
+      player.startGraftAugmentationWork(augName, craftableAug.time);
+
+      if (focus) {
+        player.startFocusing();
+        Router.toWork();
+      } else if (wasFocusing) {
+        player.stopFocusing();
+        Router.toTerminal();
+      }
+
+      workerScript.log("grafting.graftAugmentation", () => `Began crafting Augmentation ${augName}.`);
+      return true;
+    },
+  };
+}

src/NetscriptFunctions/Singularity.ts

@@ -14,7 +14,13 @@ import { isString } from "../utils/helpers/isString";
 import { getRamCost } from "../Netscript/RamCostGenerator";
 import { RunningScript } from "../Script/RunningScript";
 
-import { Singularity as ISingularity } from "../ScriptEditor/NetscriptDefinitions";
+import {
+  AugmentationStats,
+  CharacterInfo,
+  CrimeStats,
+  PlayerSkills,
+  Singularity as ISingularity,
+} from "../ScriptEditor/NetscriptDefinitions";
 
 import { findCrime } from "../Crime/CrimeHelpers";
 import { CompanyPosition } from "../Company/CompanyPosition";
@@ -49,7 +55,7 @@ export function NetscriptSingularity(
   workerScript: WorkerScript,
   helper: INetscriptHelper,
 ): ISingularity {
-  const getAugmentation = function (func: any, name: any): Augmentation {
+  const getAugmentation = function (func: string, name: string): Augmentation {
     if (!augmentationExists(name)) {
       throw helper.makeRuntimeErrorMsg(func, `Invalid augmentation: '${name}'`);
     }
@@ -57,7 +63,7 @@ export function NetscriptSingularity(
     return Augmentations[name];
   };
 
-  const getFaction = function (func: any, name: any): Faction {
+  const getFaction = function (func: string, name: string): Faction {
     if (!factionExists(name)) {
       throw helper.makeRuntimeErrorMsg(func, `Invalid faction name: '${name}`);
     }
@@ -65,7 +71,7 @@ export function NetscriptSingularity(
     return Factions[name];
   };
 
-  const getCompany = function (func: any, name: any): Company {
+  const getCompany = function (func: string, name: string): Company {
     const company = Companies[name];
     if (company == null || !(company instanceof Company)) {
       throw helper.makeRuntimeErrorMsg(func, `Invalid company name: '${name}'`);
@@ -73,26 +79,26 @@ export function NetscriptSingularity(
     return company;
   };
 
-  const runAfterReset = function (cbScript = null): void {
+  const runAfterReset = function (cbScript: string | null = null): void {
     //Run a script after reset
-    if (cbScript && isString(cbScript)) {
-      const home = player.getHomeComputer();
-      for (const script of home.scripts) {
-        if (script.filename === cbScript) {
-          const ramUsage = script.ramUsage;
-          const ramAvailable = home.maxRam - home.ramUsed;
-          if (ramUsage > ramAvailable) {
-            return; // Not enough RAM
-          }
-          const runningScriptObj = new RunningScript(script, []); // No args
-          runningScriptObj.threads = 1; // Only 1 thread
-          startWorkerScript(player, runningScriptObj, home);
+    if (!cbScript) return;
+    const home = player.getHomeComputer();
+    for (const script of home.scripts) {
+      if (script.filename === cbScript) {
+        const ramUsage = script.ramUsage;
+        const ramAvailable = home.maxRam - home.ramUsed;
+        if (ramUsage > ramAvailable) {
+          return; // Not enough RAM
         }
+        const runningScriptObj = new RunningScript(script, []); // No args
+        runningScriptObj.threads = 1; // Only 1 thread
+        startWorkerScript(player, runningScriptObj, home);
       }
     }
   };
   return {
-    getOwnedAugmentations: function (purchased: any = false): any {
+    getOwnedAugmentations: function (_purchased: unknown = false): string[] {
+      const purchased = helper.boolean(_purchased);
       helper.updateDynamicRam("getOwnedAugmentations", getRamCost(player, "getOwnedAugmentations"));
       helper.checkSingularityAccess("getOwnedAugmentations");
       const res = [];
@@ -106,82 +112,99 @@ export function NetscriptSingularity(
       }
       return res;
     },
-    getAugmentationsFromFaction: function (facname: any): any {
+    getAugmentationsFromFaction: function (_facName: unknown): string[] {
+      const facName = helper.string("getAugmentationsFromFaction", "facName", _facName);
       helper.updateDynamicRam("getAugmentationsFromFaction", getRamCost(player, "getAugmentationsFromFaction"));
       helper.checkSingularityAccess("getAugmentationsFromFaction");
-      const faction = getFaction("getAugmentationsFromFaction", facname);
+      const faction = getFaction("getAugmentationsFromFaction", facName);
 
       // If player has a gang with this faction, return all augmentations.
-      if (player.hasGangWith(facname)) {
-        const res = [];
-        for (const augName of Object.keys(Augmentations)) {
-          if (augName === AugmentationNames.NeuroFluxGovernor) continue;
-          if (augName === AugmentationNames.TheRedPill && player.bitNodeN !== 2) continue;
-          const aug = Augmentations[augName];
-          if (!aug.isSpecial) {
-            res.push(augName);
-          }
+      if (player.hasGangWith(facName)) {
+        let augs = Object.values(Augmentations);
+
+        // Remove special augs.
+        augs = augs.filter((a) => !a.isSpecial);
+
+        if (player.bitNodeN !== 2) {
+          // Remove faction-unique augs outside BN2. (But keep the one for this faction.)
+          augs = augs.filter((a) => a.factions.length > 1 || Factions[facName].augmentations.includes(a.name));
+
+          // Remove blacklisted augs.
+          const blacklist = [AugmentationNames.NeuroFluxGovernor, AugmentationNames.TheRedPill];
+          augs = augs.filter((a) => !blacklist.includes(a.name));
         }
 
-        return res;
+        return augs.map((a) => a.name);
       }
 
       return faction.augmentations.slice();
     },
-    getAugmentationCost: function (name: any): any {
+    getAugmentationCost: function (_augName: unknown): [number, number] {
+      const augName = helper.string("getAugmentationCost", "augName", _augName);
       helper.updateDynamicRam("getAugmentationCost", getRamCost(player, "getAugmentationCost"));
       helper.checkSingularityAccess("getAugmentationCost");
-      const aug = getAugmentation("getAugmentationCost", name);
+      const aug = getAugmentation("getAugmentationCost", augName);
       return [aug.baseRepRequirement, aug.baseCost];
     },
-    getAugmentationPrereq: function (name: any): any {
+    getAugmentationPrereq: function (_augName: unknown): string[] {
+      const augName = helper.string("getAugmentationPrereq", "augName", _augName);
       helper.updateDynamicRam("getAugmentationPrereq", getRamCost(player, "getAugmentationPrereq"));
       helper.checkSingularityAccess("getAugmentationPrereq");
-      const aug = getAugmentation("getAugmentationPrereq", name);
+      const aug = getAugmentation("getAugmentationPrereq", augName);
       return aug.prereqs.slice();
     },
-    getAugmentationPrice: function (name: any): any {
+    getAugmentationPrice: function (_augName: unknown): number {
+      const augName = helper.string("getAugmentationPrice", "augName", _augName);
       helper.updateDynamicRam("getAugmentationPrice", getRamCost(player, "getAugmentationPrice"));
       helper.checkSingularityAccess("getAugmentationPrice");
-      const aug = getAugmentation("getAugmentationPrice", name);
+      const aug = getAugmentation("getAugmentationPrice", augName);
       return aug.baseCost;
     },
-    getAugmentationRepReq: function (name: any): any {
+    getAugmentationRepReq: function (_augName: unknown): number {
+      const augName = helper.string("getAugmentationRepReq", "augName", _augName);
       helper.updateDynamicRam("getAugmentationRepReq", getRamCost(player, "getAugmentationRepReq"));
       helper.checkSingularityAccess("getAugmentationRepReq");
-      const aug = getAugmentation("getAugmentationRepReq", name);
+      const aug = getAugmentation("getAugmentationRepReq", augName);
       return aug.baseRepRequirement;
     },
-    getAugmentationStats: function (name: any): any {
+    getAugmentationStats: function (_augName: unknown): AugmentationStats {
+      const augName = helper.string("getAugmentationStats", "augName", _augName);
       helper.updateDynamicRam("getAugmentationStats", getRamCost(player, "getAugmentationStats"));
       helper.checkSingularityAccess("getAugmentationStats");
-      const aug = getAugmentation("getAugmentationStats", name);
+      const aug = getAugmentation("getAugmentationStats", augName);
       return Object.assign({}, aug.mults);
     },
-    purchaseAugmentation: function (faction: any, name: any): any {
+    purchaseAugmentation: function (_facName: unknown, _augName: unknown): boolean {
+      const facName = helper.string("purchaseAugmentation", "facName", _facName);
+      const augName = helper.string("purchaseAugmentation", "augName", _augName);
       helper.updateDynamicRam("purchaseAugmentation", getRamCost(player, "purchaseAugmentation"));
       helper.checkSingularityAccess("purchaseAugmentation");
-      const fac = getFaction("purchaseAugmentation", faction);
-      const aug = getAugmentation("purchaseAugmentation", name);
+      const fac = getFaction("purchaseAugmentation", facName);
+      const aug = getAugmentation("purchaseAugmentation", augName);
 
       let augs = [];
-      if (player.hasGangWith(faction)) {
+      if (player.hasGangWith(facName)) {
         for (const augName of Object.keys(Augmentations)) {
-          if (augName === AugmentationNames.NeuroFluxGovernor) continue;
-          if (augName === AugmentationNames.TheRedPill && player.bitNodeN !== 2) continue;
-          const tempAug = Augmentations[augName];
-          if (!tempAug.isSpecial) {
-            augs.push(augName);
-          }
+          const aug = Augmentations[augName];
+          if (
+            augName === AugmentationNames.NeuroFluxGovernor ||
+            (augName === AugmentationNames.TheRedPill && player.bitNodeN !== 2) ||
+            // Special augs (i.e. Bladeburner augs)
+            aug.isSpecial ||
+            // Exclusive augs (i.e. QLink)
+            (aug.factions.length <= 1 && !fac.augmentations.includes(augName) && player.bitNodeN !== 2)
+          )
+            continue;
+          augs.push(augName);
         }
       } else {
         augs = fac.augmentations;
       }
 
-      if (!augs.includes(name)) {
+      if (!augs.includes(augName)) {
         workerScript.log(
           "purchaseAugmentation",
-          () => `Faction '${faction}' does not have the '${name}' augmentation.`,
+          () => `Faction '${facName}' does not have the '${augName}' augmentation.`,
         );
         return false;
       }
@@ -190,13 +213,13 @@ export function NetscriptSingularity(
       if (!isNeuroflux) {
         for (let j = 0; j < player.queuedAugmentations.length; ++j) {
           if (player.queuedAugmentations[j].name === aug.name) {
-            workerScript.log("purchaseAugmentation", () => `You already have the '${name}' augmentation.`);
+            workerScript.log("purchaseAugmentation", () => `You already have the '${augName}' augmentation.`);
             return false;
           }
         }
         for (let j = 0; j < player.augmentations.length; ++j) {
           if (player.augmentations[j].name === aug.name) {
-            workerScript.log("purchaseAugmentation", () => `You already have the '${name}' augmentation.`);
+            workerScript.log("purchaseAugmentation", () => `You already have the '${augName}' augmentation.`);
             return false;
           }
         }
@@ -216,7 +239,8 @@ export function NetscriptSingularity(
         return false;
       }
     },
-    softReset: function (cbScript: any): any {
+    softReset: function (_cbScript: unknown): void {
+      const cbScript = helper.string("softReset", "cbScript", _cbScript);
       helper.updateDynamicRam("softReset", getRamCost(player, "softReset"));
       helper.checkSingularityAccess("softReset");
 
@@ -230,7 +254,8 @@ export function NetscriptSingularity(
       workerScript.running = false;
       killWorkerScript(workerScript);
     },
-    installAugmentations: function (cbScript: any): any {
+    installAugmentations: function (_cbScript: unknown): boolean {
+      const cbScript = helper.string("installAugmentations", "cbScript", _cbScript);
       helper.updateDynamicRam("installAugmentations", getRamCost(player, "installAugmentations"));
       helper.checkSingularityAccess("installAugmentations");
 
@@ -250,9 +275,11 @@ export function NetscriptSingularity(
 
       workerScript.running = false; // Prevent workerScript from "finishing execution naturally"
       killWorkerScript(workerScript);
+      return true;
     },
 
-    goToLocation: function (locationName: any): boolean {
+    goToLocation: function (_locationName: unknown): boolean {
+      const locationName = helper.string("goToLocation", "locationName", _locationName);
       helper.updateDynamicRam("goToLocation", getRamCost(player, "goToLocation"));
       helper.checkSingularityAccess("goToLocation");
       const location = Object.values(Locations).find((l) => l.name === locationName);
@@ -268,7 +295,10 @@ export function NetscriptSingularity(
       player.gainIntelligenceExp(CONSTANTS.IntelligenceSingFnBaseExpGain / 50000);
       return true;
     },
-    universityCourse: function (universityName: any, className: any, focus = true): any {
+    universityCourse: function (_universityName: unknown, _className: unknown, _focus: unknown = true): boolean {
+      const universityName = helper.string("universityCourse", "universityName", _universityName);
+      const className = helper.string("universityCourse", "className", _className);
+      const focus = helper.boolean(_focus);
       helper.updateDynamicRam("universityCourse", getRamCost(player, "universityCourse"));
       helper.checkSingularityAccess("universityCourse");
       const wasFocusing = player.focus;
@@ -356,7 +386,10 @@ export function NetscriptSingularity(
       return true;
     },
 
-    gymWorkout: function (gymName: any, stat: any, focus = true): any {
+    gymWorkout: function (_gymName: unknown, _stat: unknown, _focus: unknown = true): boolean {
+      const gymName = helper.string("gymWorkout", "gymName", _gymName);
+      const stat = helper.string("gymWorkout", "stat", _stat);
+      const focus = helper.boolean(_focus);
       helper.updateDynamicRam("gymWorkout", getRamCost(player, "gymWorkout"));
       helper.checkSingularityAccess("gymWorkout");
       const wasFocusing = player.focus;
@@ -468,11 +501,12 @@ export function NetscriptSingularity(
       return true;
     },
 
-    travelToCity: function (cityname: any): any {
+    travelToCity: function (_cityName: unknown): boolean {
+      const cityName = helper.string("travelToCity", "cityName", _cityName);
       helper.updateDynamicRam("travelToCity", getRamCost(player, "travelToCity"));
       helper.checkSingularityAccess("travelToCity");
 
-      switch (cityname) {
+      switch (cityName) {
         case CityName.Aevum:
         case CityName.Chongqing:
         case CityName.Sector12:
@@ -484,22 +518,22 @@ export function NetscriptSingularity(
             return false;
           }
           player.loseMoney(CONSTANTS.TravelCost, "other");
-          player.city = cityname;
-          workerScript.log("travelToCity", () => `Traveled to ${cityname}`);
+          player.city = cityName;
+          workerScript.log("travelToCity", () => `Traveled to ${cityName}`);
           player.gainIntelligenceExp(CONSTANTS.IntelligenceSingFnBaseExpGain / 50000);
           return true;
         default:
-          throw helper.makeRuntimeErrorMsg("travelToCity", `Invalid city name: '${cityname}'.`);
+          throw helper.makeRuntimeErrorMsg("travelToCity", `Invalid city name: '${cityName}'.`);
       }
     },
 
-    purchaseTor: function (): any {
+    purchaseTor: function (): boolean {
       helper.updateDynamicRam("purchaseTor", getRamCost(player, "purchaseTor"));
       helper.checkSingularityAccess("purchaseTor");
 
       if (player.hasTorRouter()) {
         workerScript.log("purchaseTor", () => "You already have a TOR router!");
-        return false;
+        return true;
       }
 
       if (player.money < CONSTANTS.TorRouterCost) {
@@ -525,7 +559,8 @@ export function NetscriptSingularity(
       workerScript.log("purchaseTor", () => "You have purchased a Tor router!");
       return true;
     },
-    purchaseProgram: function (programName: any): any {
+    purchaseProgram: function (_programName: unknown): boolean {
+      const programName = helper.string("purchaseProgram", "programName", _programName).toLowerCase();
       helper.updateDynamicRam("purchaseProgram", getRamCost(player, "purchaseProgram"));
       helper.checkSingularityAccess("purchaseProgram");
 
@@ -534,8 +569,6 @@ export function NetscriptSingularity(
         return false;
       }
 
-      programName = programName.toLowerCase();
-
       const item = Object.values(DarkWebItems).find((i) => i.program.toLowerCase() === programName);
       if (item == null) {
         workerScript.log("purchaseProgram", () => `Invalid program name: '${programName}.`);
@@ -564,12 +597,13 @@ export function NetscriptSingularity(
       player.gainIntelligenceExp(CONSTANTS.IntelligenceSingFnBaseExpGain / 5000);
       return true;
     },
-    getCurrentServer: function (): any {
+    getCurrentServer: function (): string {
       helper.updateDynamicRam("getCurrentServer", getRamCost(player, "getCurrentServer"));
       helper.checkSingularityAccess("getCurrentServer");
       return player.getCurrentServer().hostname;
     },
-    connect: function (hostname: any): any {
+    connect: function (_hostname: unknown): boolean {
+      const hostname = helper.string("purchaseProgram", "hostname", _hostname);
       helper.updateDynamicRam("connect", getRamCost(player, "connect"));
       helper.checkSingularityAccess("connect");
       if (!hostname) {
@@ -604,13 +638,13 @@ export function NetscriptSingularity(
 
       return false;
     },
-    manualHack: function (): any {
+    manualHack: function (): Promise<number> {
       helper.updateDynamicRam("manualHack", getRamCost(player, "manualHack"));
       helper.checkSingularityAccess("manualHack");
       const server = player.getCurrentServer();
       return helper.hack(server.hostname, true);
     },
-    installBackdoor: function (): any {
+    installBackdoor: function (): Promise<void> {
       helper.updateDynamicRam("installBackdoor", getRamCost(player, "installBackdoor"));
       helper.checkSingularityAccess("installBackdoor");
       const baseserver = player.getCurrentServer();
@@ -648,8 +682,8 @@ export function NetscriptSingularity(
       helper.checkSingularityAccess("isFocused");
       return player.focus;
     },
-    setFocus: function (afocus: any): boolean {
-      const focus = helper.boolean(afocus);
+    setFocus: function (_focus: unknown): boolean {
+      const focus = helper.boolean(_focus);
       helper.updateDynamicRam("setFocus", getRamCost(player, "setFocus"));
       helper.checkSingularityAccess("setFocus");
       if (!player.isWorking) {
@@ -677,7 +711,7 @@ export function NetscriptSingularity(
       }
       return false;
     },
-    getStats: function (): any {
+    getStats: function (): PlayerSkills {
       helper.updateDynamicRam("getStats", getRamCost(player, "getStats"));
       helper.checkSingularityAccess("getStats");
       workerScript.log("getStats", () => `getStats is deprecated, please use getplayer`);
@@ -692,7 +726,7 @@ export function NetscriptSingularity(
         intelligence: player.intelligence,
       };
     },
-    getCharacterInformation: function (): any {
+    getCharacterInformation: function (): CharacterInfo {
       helper.updateDynamicRam("getCharacterInformation", getRamCost(player, "getCharacterInformation"));
       helper.checkSingularityAccess("getCharacterInformation");
       workerScript.log("getCharacterInformation", () => `getCharacterInformation is deprecated, please use getplayer`);
@@ -708,6 +742,8 @@ export function NetscriptSingularity(
         mult: {
           agility: player.agility_mult,
           agilityExp: player.agility_exp_mult,
+          charisma: player.charisma,
+          charismaExp: player.charisma_exp,
           companyRep: player.company_rep_mult,
           crimeMoney: player.crime_money_mult,
           crimeSuccess: player.crime_success_mult,
@@ -740,21 +776,21 @@ export function NetscriptSingularity(
         charismaExp: player.charisma_exp,
       };
     },
-    hospitalize: function (): any {
+    hospitalize: function (): void {
       helper.updateDynamicRam("hospitalize", getRamCost(player, "hospitalize"));
       helper.checkSingularityAccess("hospitalize");
       if (player.isWorking || Router.page() === Page.Infiltration || Router.page() === Page.BitVerse) {
         workerScript.log("hospitalize", () => "Cannot go to the hospital because the player is busy.");
         return;
       }
-      return player.hospitalize();
+      player.hospitalize();
     },
-    isBusy: function (): any {
+    isBusy: function (): boolean {
       helper.updateDynamicRam("isBusy", getRamCost(player, "isBusy"));
       helper.checkSingularityAccess("isBusy");
       return player.isWorking || Router.page() === Page.Infiltration || Router.page() === Page.BitVerse;
     },
-    stopAction: function (): any {
+    stopAction: function (): boolean {
       helper.updateDynamicRam("stopAction", getRamCost(player, "stopAction"));
       helper.checkSingularityAccess("stopAction");
       if (player.isWorking) {
@@ -768,7 +804,7 @@ export function NetscriptSingularity(
       }
       return false;
     },
-    upgradeHomeCores: function (): any {
+    upgradeHomeCores: function (): boolean {
       helper.updateDynamicRam("upgradeHomeCores", getRamCost(player, "upgradeHomeCores"));
       helper.checkSingularityAccess("upgradeHomeCores");
 
@@ -798,13 +834,13 @@ export function NetscriptSingularity(
       );
       return true;
     },
-    getUpgradeHomeCoresCost: function (): any {
+    getUpgradeHomeCoresCost: function (): number {
       helper.updateDynamicRam("getUpgradeHomeCoresCost", getRamCost(player, "getUpgradeHomeCoresCost"));
       helper.checkSingularityAccess("getUpgradeHomeCoresCost");
 
       return player.getUpgradeHomeCoresCost();
     },
-    upgradeHomeRam: function (): any {
+    upgradeHomeRam: function (): boolean {
       helper.updateDynamicRam("upgradeHomeRam", getRamCost(player, "upgradeHomeRam"));
       helper.checkSingularityAccess("upgradeHomeRam");
 
@@ -837,13 +873,15 @@ export function NetscriptSingularity(
       );
       return true;
     },
-    getUpgradeHomeRamCost: function (): any {
+    getUpgradeHomeRamCost: function (): number {
       helper.updateDynamicRam("getUpgradeHomeRamCost", getRamCost(player, "getUpgradeHomeRamCost"));
       helper.checkSingularityAccess("getUpgradeHomeRamCost");
 
       return player.getUpgradeHomeRamCost();
     },
-    workForCompany: function (companyName: any, focus = true): any {
+    workForCompany: function (_companyName: unknown, _focus: unknown = true): boolean {
+      let companyName = helper.string("workForCompany", "companyName", _companyName);
+      const focus = helper.boolean(_focus);
       helper.updateDynamicRam("workForCompany", getRamCost(player, "workForCompany"));
       helper.checkSingularityAccess("workForCompany");
 
@@ -897,12 +935,14 @@ export function NetscriptSingularity(
       );
       return true;
     },
-    applyToCompany: function (companyName: any, field: any): any {
+    applyToCompany: function (_companyName: unknown, _field: unknown): boolean {
+      const companyName = helper.string("applyToCompany", "companyName", _companyName);
+      const field = helper.string("applyToCompany", "field", _field);
       helper.updateDynamicRam("applyToCompany", getRamCost(player, "applyToCompany"));
       helper.checkSingularityAccess("applyToCompany");
       getCompany("applyToCompany", companyName);
 
-      player.location = companyName;
+      player.location = companyName as LocationName;
       let res;
       switch (field.toLowerCase()) {
         case "software":
@@ -967,66 +1007,73 @@ export function NetscriptSingularity(
       }
       return res;
     },
-    getCompanyRep: function (companyName: any): any {
+    getCompanyRep: function (_companyName: unknown): number {
+      const companyName = helper.string("getCompanyRep", "companyName", _companyName);
       helper.updateDynamicRam("getCompanyRep", getRamCost(player, "getCompanyRep"));
       helper.checkSingularityAccess("getCompanyRep");
       const company = getCompany("getCompanyRep", companyName);
       return company.playerReputation;
     },
-    getCompanyFavor: function (companyName: any): any {
+    getCompanyFavor: function (_companyName: unknown): number {
+      const companyName = helper.string("getCompanyFavor", "companyName", _companyName);
       helper.updateDynamicRam("getCompanyFavor", getRamCost(player, "getCompanyFavor"));
       helper.checkSingularityAccess("getCompanyFavor");
       const company = getCompany("getCompanyFavor", companyName);
       return company.favor;
     },
-    getCompanyFavorGain: function (companyName: any): any {
+    getCompanyFavorGain: function (_companyName: unknown): number {
+      const companyName = helper.string("getCompanyFavorGain", "companyName", _companyName);
       helper.updateDynamicRam("getCompanyFavorGain", getRamCost(player, "getCompanyFavorGain"));
       helper.checkSingularityAccess("getCompanyFavorGain");
       const company = getCompany("getCompanyFavorGain", companyName);
       return company.getFavorGain();
     },
-    checkFactionInvitations: function (): any {
+    checkFactionInvitations: function (): string[] {
       helper.updateDynamicRam("checkFactionInvitations", getRamCost(player, "checkFactionInvitations"));
       helper.checkSingularityAccess("checkFactionInvitations");
       // Make a copy of player.factionInvitations
       return player.factionInvitations.slice();
     },
-    joinFaction: function (name: any): any {
+    joinFaction: function (_facName: unknown): boolean {
+      const facName = helper.string("joinFaction", "facName", _facName);
       helper.updateDynamicRam("joinFaction", getRamCost(player, "joinFaction"));
       helper.checkSingularityAccess("joinFaction");
-      getFaction("joinFaction", name);
+      getFaction("joinFaction", facName);
 
-      if (!player.factionInvitations.includes(name)) {
-        workerScript.log("joinFaction", () => `You have not been invited by faction '${name}'`);
+      if (!player.factionInvitations.includes(facName)) {
+        workerScript.log("joinFaction", () => `You have not been invited by faction '${facName}'`);
         return false;
       }
-      const fac = Factions[name];
+      const fac = Factions[facName];
       joinFaction(fac);
 
       // Update Faction Invitation list to account for joined + banned factions
       for (let i = 0; i < player.factionInvitations.length; ++i) {
-        if (player.factionInvitations[i] == name || Factions[player.factionInvitations[i]].isBanned) {
+        if (player.factionInvitations[i] == facName || Factions[player.factionInvitations[i]].isBanned) {
           player.factionInvitations.splice(i, 1);
           i--;
         }
       }
       player.gainIntelligenceExp(CONSTANTS.IntelligenceSingFnBaseExpGain * 5);
-      workerScript.log("joinFaction", () => `Joined the '${name}' faction.`);
+      workerScript.log("joinFaction", () => `Joined the '${facName}' faction.`);
       return true;
     },
-    workForFaction: function (name: any, type: any, focus = true): any {
+    workForFaction: function (_facName: unknown, _type: unknown, _focus: unknown = true): boolean {
+      const facName = helper.string("workForFaction", "facName", _facName);
+      const type = helper.string("workForFaction", "type", _type);
+      const focus = helper.boolean(_focus);
       helper.updateDynamicRam("workForFaction", getRamCost(player, "workForFaction"));
       helper.checkSingularityAccess("workForFaction");
-      getFaction("workForFaction", name);
+      getFaction("workForFaction", facName);
 
       // if the player is in a gang and the target faction is any of the gang faction, fail
-      if (player.inGang() && AllGangs[name] !== undefined) {
-        workerScript.log("workForFaction", () => `Faction '${name}' does not offer work at the moment.`);
+      if (player.inGang() && AllGangs[facName] !== undefined) {
+        workerScript.log("workForFaction", () => `Faction '${facName}' does not offer work at the moment.`);
         return false;
       }
 
-      if (!player.factions.includes(name)) {
-        workerScript.log("workForFaction", () => `You are not a member of '${name}'`);
+      if (!player.factions.includes(facName)) {
+        workerScript.log("workForFaction", () => `You are not a member of '${facName}'`);
         return false;
       }
 
@@ -1036,7 +1083,7 @@ export function NetscriptSingularity(
         workerScript.log("workForFaction", () => txt);
       }
 
-      const fac = Factions[name];
+      const fac = Factions[facName];
       // Arrays listing factions that allow each time of work
 
       switch (type.toLowerCase()) {
@@ -1096,34 +1143,42 @@ export function NetscriptSingularity(
       }
       return true;
     },
-    getFactionRep: function (name: any): any {
+    getFactionRep: function (_facName: unknown): number {
+      const facName = helper.string("getFactionRep", "facName", _facName);
       helper.updateDynamicRam("getFactionRep", getRamCost(player, "getFactionRep"));
       helper.checkSingularityAccess("getFactionRep");
-      const faction = getFaction("getFactionRep", name);
+      const faction = getFaction("getFactionRep", facName);
       return faction.playerReputation;
     },
-    getFactionFavor: function (name: any): any {
+    getFactionFavor: function (_facName: unknown): number {
+      const facName = helper.string("getFactionRep", "facName", _facName);
       helper.updateDynamicRam("getFactionFavor", getRamCost(player, "getFactionFavor"));
       helper.checkSingularityAccess("getFactionFavor");
-      const faction = getFaction("getFactionFavor", name);
+      const faction = getFaction("getFactionFavor", facName);
       return faction.favor;
     },
-    getFactionFavorGain: function (name: any): any {
+    getFactionFavorGain: function (_facName: unknown): number {
+      const facName = helper.string("getFactionFavorGain", "facName", _facName);
       helper.updateDynamicRam("getFactionFavorGain", getRamCost(player, "getFactionFavorGain"));
       helper.checkSingularityAccess("getFactionFavorGain");
-      const faction = getFaction("getFactionFavorGain", name);
+      const faction = getFaction("getFactionFavorGain", facName);
       return faction.getFavorGain();
     },
-    donateToFaction: function (name: any, amt: any): any {
+    donateToFaction: function (_facName: unknown, _amt: unknown): boolean {
+      const facName = helper.string("donateToFaction", "facName", _facName);
+      const amt = helper.number("donateToFaction", "amt", _amt);
       helper.updateDynamicRam("donateToFaction", getRamCost(player, "donateToFaction"));
       helper.checkSingularityAccess("donateToFaction");
-      const faction = getFaction("donateToFaction", name);
+      const faction = getFaction("donateToFaction", facName);
       if (!player.factions.includes(faction.name)) {
-        workerScript.log("donateToFaction", () => `You can't donate to '${name}' because you aren't a member`);
+        workerScript.log("donateToFaction", () => `You can't donate to '${facName}' because you aren't a member`);
         return false;
       }
       if (player.inGang() && faction.name === player.getGangFaction().name) {
-        workerScript.log("donateToFaction", () => `You can't donate to '${name}' because youre managing a gang for it`);
+        workerScript.log(
+          "donateToFaction",
+          () => `You can't donate to '${facName}' because youre managing a gang for it`,
+        );
         return false;
       }
       if (typeof amt !== "number" || amt <= 0 || isNaN(amt)) {
@@ -1133,7 +1188,7 @@ export function NetscriptSingularity(
       if (player.money < amt) {
         workerScript.log(
           "donateToFaction",
-          () => `You do not have enough money to donate ${numeralWrapper.formatMoney(amt)} to '${name}'`,
+          () => `You do not have enough money to donate ${numeralWrapper.formatMoney(amt)} to '${facName}'`,
         );
         return false;
       }
@@ -1152,13 +1207,15 @@ export function NetscriptSingularity(
       workerScript.log(
         "donateToFaction",
         () =>
-          `${numeralWrapper.formatMoney(amt)} donated to '${name}' for ${numeralWrapper.formatReputation(
+          `${numeralWrapper.formatMoney(amt)} donated to '${facName}' for ${numeralWrapper.formatReputation(
             repGain,
           )} reputation`,
       );
       return true;
     },
-    createProgram: function (name: any, focus = true): any {
+    createProgram: function (_programName: unknown, _focus: unknown = true): boolean {
+      const programName = helper.string("createProgram", "programName", _programName).toLowerCase();
+      const focus = helper.boolean(_focus);
       helper.updateDynamicRam("createProgram", getRamCost(player, "createProgram"));
       helper.checkSingularityAccess("createProgram");
 
@@ -1168,12 +1225,10 @@ export function NetscriptSingularity(
         workerScript.log("createProgram", () => txt);
       }
 
-      name = name.toLowerCase();
-
-      const p = Object.values(Programs).find((p) => p.name.toLowerCase() === name);
+      const p = Object.values(Programs).find((p) => p.name.toLowerCase() === programName);
 
       if (p == null) {
-        workerScript.log("createProgram", () => `The specified program does not exist: '${name}`);
+        workerScript.log("createProgram", () => `The specified program does not exist: '${programName}`);
         return false;
       }
 
@@ -1204,10 +1259,11 @@ export function NetscriptSingularity(
         player.stopFocusing();
         Router.toTerminal();
       }
-      workerScript.log("createProgram", () => `Began creating program: '${name}'`);
+      workerScript.log("createProgram", () => `Began creating program: '${programName}'`);
       return true;
     },
-    commitCrime: function (crimeRoughName: any): any {
+    commitCrime: function (_crimeRoughName: unknown): number {
+      const crimeRoughName = helper.string("commitCrime", "crimeRoughName", _crimeRoughName);
       helper.updateDynamicRam("commitCrime", getRamCost(player, "commitCrime"));
       helper.checkSingularityAccess("commitCrime");
 
@@ -1227,7 +1283,8 @@ export function NetscriptSingularity(
       workerScript.log("commitCrime", () => `Attempting to commit ${crime.name}...`);
       return crime.commit(Router, player, 1, workerScript);
     },
-    getCrimeChance: function (crimeRoughName: any): any {
+    getCrimeChance: function (_crimeRoughName: unknown): number {
+      const crimeRoughName = helper.string("getCrimeChance", "crimeRoughName", _crimeRoughName);
       helper.updateDynamicRam("getCrimeChance", getRamCost(player, "getCrimeChance"));
       helper.checkSingularityAccess("getCrimeChance");
 
@@ -1238,7 +1295,8 @@ export function NetscriptSingularity(
 
       return crime.successRate(player);
     },
-    getCrimeStats: function (crimeRoughName: any): any {
+    getCrimeStats: function (_crimeRoughName: unknown): CrimeStats {
+      const crimeRoughName = helper.string("getCrimeStats", "crimeRoughName", _crimeRoughName);
       helper.updateDynamicRam("getCrimeStats", getRamCost(player, "getCrimeStats"));
       helper.checkSingularityAccess("getCrimeStats");
 
@@ -1260,7 +1318,8 @@ export function NetscriptSingularity(
       }
       return Object.values(DarkWebItems).map((p) => p.program);
     },
-    getDarkwebProgramCost: function (programName: any): any {
+    getDarkwebProgramCost: function (_programName: unknown): number {
+      const programName = helper.string("getDarkwebProgramCost", "programName", _programName).toLowerCase();
       helper.updateDynamicRam("getDarkwebProgramCost", getRamCost(player, "getDarkwebProgramCost"));
       helper.checkSingularityAccess("getDarkwebProgramCost");
 
@@ -1272,7 +1331,6 @@ export function NetscriptSingularity(
         return -1;
       }
 
-      programName = programName.toLowerCase();
       const item = Object.values(DarkWebItems).find((i) => i.program.toLowerCase() === programName);
 
       // If the program doesn't exist, throw an error. The reasoning here is that the 99% case is that

src/NetscriptFunctions/Sleeve.ts

@@ -10,10 +10,16 @@ import { Augmentations } from "../Augmentation/Augmentations";
 import { CityName } from "../Locations/data/CityNames";
 import { findCrime } from "../Crime/CrimeHelpers";
 
-import { Sleeve as ISleeve } from "../ScriptEditor/NetscriptDefinitions";
+import {
+  AugmentPair,
+  Sleeve as ISleeve,
+  SleeveInformation,
+  SleeveSkills,
+  SleeveTask,
+} from "../ScriptEditor/NetscriptDefinitions";
 
 export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, helper: INetscriptHelper): ISleeve {
-  const checkSleeveAPIAccess = function (func: any): void {
+  const checkSleeveAPIAccess = function (func: string): void {
     if (player.bitNodeN !== 10 && !SourceFileFlags[10]) {
       throw helper.makeRuntimeErrorMsg(
         `sleeve.${func}`,
@@ -22,7 +28,7 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
     }
   };
 
-  const checkSleeveNumber = function (func: any, sleeveNumber: any): void {
+  const checkSleeveNumber = function (func: string, sleeveNumber: number): void {
     if (sleeveNumber >= player.sleeves.length || sleeveNumber < 0) {
       const msg = `Invalid sleeve number: ${sleeveNumber}`;
       workerScript.log(func, () => msg);
@@ -30,7 +36,7 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
     }
   };
 
-  const getSleeveStats = function (sleeveNumber: any): any {
+  const getSleeveStats = function (sleeveNumber: number): SleeveSkills {
     const sl = player.sleeves[sleeveNumber];
     return {
       shock: 100 - sl.shock,
@@ -42,7 +48,7 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
       agility: sl.agility,
       charisma: sl.charisma,
     };
-  }
+  };
 
   return {
     getNumSleeves: function (): number {
@@ -50,23 +56,23 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
       checkSleeveAPIAccess("getNumSleeves");
       return player.sleeves.length;
     },
-    setToShockRecovery: function (asleeveNumber: any = 0): boolean {
-      const sleeveNumber = helper.number("setToShockRecovery", "sleeveNumber", asleeveNumber);
+    setToShockRecovery: function (_sleeveNumber: unknown): boolean {
+      const sleeveNumber = helper.number("setToShockRecovery", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("setToShockRecovery", getRamCost(player, "sleeve", "setToShockRecovery"));
       checkSleeveAPIAccess("setToShockRecovery");
       checkSleeveNumber("setToShockRecovery", sleeveNumber);
       return player.sleeves[sleeveNumber].shockRecovery(player);
     },
-    setToSynchronize: function (asleeveNumber: any = 0): boolean {
-      const sleeveNumber = helper.number("setToSynchronize", "sleeveNumber", asleeveNumber);
+    setToSynchronize: function (_sleeveNumber: unknown): boolean {
+      const sleeveNumber = helper.number("setToSynchronize", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("setToSynchronize", getRamCost(player, "sleeve", "setToSynchronize"));
       checkSleeveAPIAccess("setToSynchronize");
       checkSleeveNumber("setToSynchronize", sleeveNumber);
       return player.sleeves[sleeveNumber].synchronize(player);
     },
-    setToCommitCrime: function (asleeveNumber: any = 0, aCrimeRoughName: any = ""): boolean {
-      const sleeveNumber = helper.number("setToCommitCrime", "sleeveNumber", asleeveNumber);
-      const crimeRoughName = helper.string("setToCommitCrime", "crimeName", aCrimeRoughName);
+    setToCommitCrime: function (_sleeveNumber: unknown, _crimeRoughName: unknown): boolean {
+      const sleeveNumber = helper.number("setToCommitCrime", "sleeveNumber", _sleeveNumber);
+      const crimeRoughName = helper.string("setToCommitCrime", "crimeName", _crimeRoughName);
       helper.updateDynamicRam("setToCommitCrime", getRamCost(player, "sleeve", "setToCommitCrime"));
       checkSleeveAPIAccess("setToCommitCrime");
       checkSleeveNumber("setToCommitCrime", sleeveNumber);
@@ -76,25 +82,25 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
       }
       return player.sleeves[sleeveNumber].commitCrime(player, crime.name);
     },
-    setToUniversityCourse: function (asleeveNumber: any = 0, auniversityName: any = "", aclassName: any = ""): boolean {
-      const sleeveNumber = helper.number("setToUniversityCourse", "sleeveNumber", asleeveNumber);
-      const universityName = helper.string("setToUniversityCourse", "universityName", auniversityName);
-      const className = helper.string("setToUniversityCourse", "className", aclassName);
+    setToUniversityCourse: function (_sleeveNumber: unknown, _universityName: unknown, _className: unknown): boolean {
+      const sleeveNumber = helper.number("setToUniversityCourse", "sleeveNumber", _sleeveNumber);
+      const universityName = helper.string("setToUniversityCourse", "universityName", _universityName);
+      const className = helper.string("setToUniversityCourse", "className", _className);
       helper.updateDynamicRam("setToUniversityCourse", getRamCost(player, "sleeve", "setToUniversityCourse"));
       checkSleeveAPIAccess("setToUniversityCourse");
       checkSleeveNumber("setToUniversityCourse", sleeveNumber);
       return player.sleeves[sleeveNumber].takeUniversityCourse(player, universityName, className);
     },
-    travel: function (asleeveNumber: any = 0, acityName: any = ""): boolean {
-      const sleeveNumber = helper.number("travel", "sleeveNumber", asleeveNumber);
-      const cityName = helper.string("setToUniversityCourse", "cityName", acityName);
+    travel: function (_sleeveNumber: unknown, _cityName: unknown): boolean {
+      const sleeveNumber = helper.number("travel", "sleeveNumber", _sleeveNumber);
+      const cityName = helper.string("setToUniversityCourse", "cityName", _cityName);
       helper.updateDynamicRam("travel", getRamCost(player, "sleeve", "travel"));
       checkSleeveAPIAccess("travel");
       checkSleeveNumber("travel", sleeveNumber);
       return player.sleeves[sleeveNumber].travel(player, cityName as CityName);
     },
-    setToCompanyWork: function (asleeveNumber: any = 0, acompanyName: any = ""): boolean {
-      const sleeveNumber = helper.number("setToCompanyWork", "sleeveNumber", asleeveNumber);
+    setToCompanyWork: function (_sleeveNumber: unknown, acompanyName: unknown): boolean {
+      const sleeveNumber = helper.number("setToCompanyWork", "sleeveNumber", _sleeveNumber);
       const companyName = helper.string("setToUniversityCourse", "companyName", acompanyName);
       helper.updateDynamicRam("setToCompanyWork", getRamCost(player, "sleeve", "setToCompanyWork"));
       checkSleeveAPIAccess("setToCompanyWork");
@@ -116,10 +122,10 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
 
       return player.sleeves[sleeveNumber].workForCompany(player, companyName);
     },
-    setToFactionWork: function (asleeveNumber: any = 0, afactionName: any = "", aworkType: any = ""): boolean {
-      const sleeveNumber = helper.number("setToFactionWork", "sleeveNumber", asleeveNumber);
-      const factionName = helper.string("setToUniversityCourse", "factionName", afactionName);
-      const workType = helper.string("setToUniversityCourse", "workType", aworkType);
+    setToFactionWork: function (_sleeveNumber: unknown, _factionName: unknown, _workType: unknown): boolean {
+      const sleeveNumber = helper.number("setToFactionWork", "sleeveNumber", _sleeveNumber);
+      const factionName = helper.string("setToUniversityCourse", "factionName", _factionName);
+      const workType = helper.string("setToUniversityCourse", "workType", _workType);
       helper.updateDynamicRam("setToFactionWork", getRamCost(player, "sleeve", "setToFactionWork"));
       checkSleeveAPIAccess("setToFactionWork");
       checkSleeveNumber("setToFactionWork", sleeveNumber);
@@ -140,40 +146,25 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
 
       return player.sleeves[sleeveNumber].workForFaction(player, factionName, workType);
     },
-    setToGymWorkout: function (asleeveNumber: any = 0, agymName: any = "", astat: any = ""): boolean {
-      const sleeveNumber = helper.number("setToGymWorkout", "sleeveNumber", asleeveNumber);
-      const gymName = helper.string("setToUniversityCourse", "gymName", agymName);
-      const stat = helper.string("setToUniversityCourse", "stat", astat);
+    setToGymWorkout: function (_sleeveNumber: unknown, _gymName: unknown, _stat: unknown): boolean {
+      const sleeveNumber = helper.number("setToGymWorkout", "sleeveNumber", _sleeveNumber);
+      const gymName = helper.string("setToUniversityCourse", "gymName", _gymName);
+      const stat = helper.string("setToUniversityCourse", "stat", _stat);
       helper.updateDynamicRam("setToGymWorkout", getRamCost(player, "sleeve", "setToGymWorkout"));
       checkSleeveAPIAccess("setToGymWorkout");
       checkSleeveNumber("setToGymWorkout", sleeveNumber);
 
       return player.sleeves[sleeveNumber].workoutAtGym(player, gymName, stat);
     },
-    getSleeveStats: function (asleeveNumber: any = 0): {
-      shock: number;
-      sync: number;
-      hacking: number;
-      strength: number;
-      defense: number;
-      dexterity: number;
-      agility: number;
-      charisma: number;
-    } {
-      const sleeveNumber = helper.number("getSleeveStats", "sleeveNumber", asleeveNumber);
+    getSleeveStats: function (_sleeveNumber: unknown): SleeveSkills {
+      const sleeveNumber = helper.number("getSleeveStats", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("getSleeveStats", getRamCost(player, "sleeve", "getSleeveStats"));
       checkSleeveAPIAccess("getSleeveStats");
       checkSleeveNumber("getSleeveStats", sleeveNumber);
-      return getSleeveStats(sleeveNumber)
+      return getSleeveStats(sleeveNumber);
     },
-    getTask: function (asleeveNumber: any = 0): {
-      task: string;
-      crime: string;
-      location: string;
-      gymStatType: string;
-      factionWorkType: string;
-    } {
-      const sleeveNumber = helper.number("getTask", "sleeveNumber", asleeveNumber);
+    getTask: function (_sleeveNumber: unknown): SleeveTask {
+      const sleeveNumber = helper.number("getTask", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("getTask", getRamCost(player, "sleeve", "getTask"));
       checkSleeveAPIAccess("getTask");
       checkSleeveNumber("getTask", sleeveNumber);
@@ -187,14 +178,15 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
         factionWorkType: FactionWorkType[sl.factionWorkType],
       };
     },
-    getInformation: function (asleeveNumber: any = 0): any {
-      const sleeveNumber = helper.number("getInformation", "sleeveNumber", asleeveNumber);
+    getInformation: function (_sleeveNumber: unknown): SleeveInformation {
+      const sleeveNumber = helper.number("getInformation", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("getInformation", getRamCost(player, "sleeve", "getInformation"));
       checkSleeveAPIAccess("getInformation");
       checkSleeveNumber("getInformation", sleeveNumber);
 
       const sl = player.sleeves[sleeveNumber];
       return {
+        tor: false,
         city: sl.city,
         hp: sl.hp,
         jobs: Object.keys(player.jobs), // technically sleeves have the same jobs as the player.
@@ -252,8 +244,8 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
         workRepGain: sl.getRepGain(player),
       };
     },
-    getSleeveAugmentations: function (asleeveNumber: any = 0): string[] {
-      const sleeveNumber = helper.number("getSleeveAugmentations", "sleeveNumber", asleeveNumber);
+    getSleeveAugmentations: function (_sleeveNumber: unknown): string[] {
+      const sleeveNumber = helper.number("getSleeveAugmentations", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("getSleeveAugmentations", getRamCost(player, "sleeve", "getSleeveAugmentations"));
       checkSleeveAPIAccess("getSleeveAugmentations");
       checkSleeveNumber("getSleeveAugmentations", sleeveNumber);
@@ -264,11 +256,8 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
       }
       return augs;
     },
-    getSleevePurchasableAugs: function (asleeveNumber: any = 0): {
-      name: string;
-      cost: number;
-    }[] {
-      const sleeveNumber = helper.number("getSleevePurchasableAugs", "sleeveNumber", asleeveNumber);
+    getSleevePurchasableAugs: function (_sleeveNumber: unknown): AugmentPair[] {
+      const sleeveNumber = helper.number("getSleevePurchasableAugs", "sleeveNumber", _sleeveNumber);
       helper.updateDynamicRam("getSleevePurchasableAugs", getRamCost(player, "sleeve", "getSleevePurchasableAugs"));
       checkSleeveAPIAccess("getSleevePurchasableAugs");
       checkSleeveNumber("getSleevePurchasableAugs", sleeveNumber);
@@ -285,9 +274,9 @@ export function NetscriptSleeve(player: IPlayer, workerScript: WorkerScript, hel
 
       return augs;
     },
-    purchaseSleeveAug: function (asleeveNumber: any = 0, aaugName: any = ""): boolean {
-      const sleeveNumber = helper.number("purchaseSleeveAug", "sleeveNumber", asleeveNumber);
-      const augName = helper.string("purchaseSleeveAug", "augName", aaugName);
+    purchaseSleeveAug: function (_sleeveNumber: unknown, _augName: unknown): boolean {
+      const sleeveNumber = helper.number("purchaseSleeveAug", "sleeveNumber", _sleeveNumber);
+      const augName = helper.string("purchaseSleeveAug", "augName", _augName);
       helper.updateDynamicRam("purchaseSleeveAug", getRamCost(player, "sleeve", "purchaseSleeveAug"));
       checkSleeveAPIAccess("purchaseSleeveAug");
       checkSleeveNumber("purchaseSleeveAug", sleeveNumber);

src/NetscriptFunctions/Stanek.ts

@@ -22,28 +22,29 @@ export function NetscriptStanek(player: IPlayer, workerScript: WorkerScript, hel
   }
 
   return {
-    width: function (): number {
-      helper.updateDynamicRam("width", getRamCost(player, "stanek", "width"));
-      checkStanekAPIAccess("width");
+    giftWidth: function (): number {
+      helper.updateDynamicRam("giftWidth", getRamCost(player, "stanek", "giftWidth"));
+      checkStanekAPIAccess("giftWidth");
       return staneksGift.width();
     },
-    height: function (): number {
-      helper.updateDynamicRam("height", getRamCost(player, "stanek", "height"));
-      checkStanekAPIAccess("height");
+    giftHeight: function (): number {
+      helper.updateDynamicRam("giftHeight", getRamCost(player, "stanek", "giftHeight"));
+      checkStanekAPIAccess("giftHeight");
       return staneksGift.height();
     },
-    charge: function (_rootX: unknown, _rootY: unknown): Promise<void> {
-      const rootX = helper.number("stanek.charge", "rootX", _rootX);
-      const rootY = helper.number("stanek.charge", "rootY", _rootY);
+    chargeFragment: function (_rootX: unknown, _rootY: unknown): Promise<void> {
+      const rootX = helper.number("stanek.chargeFragment", "rootX", _rootX);
+      const rootY = helper.number("stanek.chargeFragment", "rootY", _rootY);
 
-      helper.updateDynamicRam("charge", getRamCost(player, "stanek", "charge"));
-      checkStanekAPIAccess("charge");
+      helper.updateDynamicRam("chargeFragment", getRamCost(player, "stanek", "chargeFragment"));
+      checkStanekAPIAccess("chargeFragment");
       const fragment = staneksGift.findFragment(rootX, rootY);
-      if (!fragment) throw helper.makeRuntimeErrorMsg("stanek.charge", `No fragment with root (${rootX}, ${rootY}).`);
+      if (!fragment)
+        throw helper.makeRuntimeErrorMsg("stanek.chargeFragment", `No fragment with root (${rootX}, ${rootY}).`);
       const time = staneksGift.inBonus() ? 200 : 1000;
       return netscriptDelay(time, workerScript).then(function () {
         const charge = staneksGift.charge(player, fragment, workerScript.scriptRef.threads);
-        workerScript.log("stanek.charge", () => `Charged fragment for ${charge} charge.`);
+        workerScript.log("stanek.chargeFragment", () => `Charged fragment for ${charge} charge.`);
         return Promise.resolve();
       });
     },
@@ -61,49 +62,49 @@ export function NetscriptStanek(player: IPlayer, workerScript: WorkerScript, hel
         return { ...af.copy(), ...af.fragment().copy() };
       });
     },
-    clear: function (): void {
-      helper.updateDynamicRam("clear", getRamCost(player, "stanek", "clear"));
-      checkStanekAPIAccess("clear");
-      workerScript.log("stanek.clear", () => `Cleared Stanek's Gift.`);
+    clearGift: function (): void {
+      helper.updateDynamicRam("clearGift", getRamCost(player, "stanek", "clearGift"));
+      checkStanekAPIAccess("clearGift");
+      workerScript.log("stanek.clearGift", () => `Cleared Stanek's Gift.`);
       staneksGift.clear();
     },
-    canPlace: function (_rootX: unknown, _rootY: unknown, _rotation: unknown, _fragmentId: unknown): boolean {
-      const rootX = helper.number("stanek.canPlace", "rootX", _rootX);
-      const rootY = helper.number("stanek.canPlace", "rootY", _rootY);
-      const rotation = helper.number("stanek.canPlace", "rotation", _rotation);
-      const fragmentId = helper.number("stanek.canPlace", "fragmentId", _fragmentId);
-      helper.updateDynamicRam("canPlace", getRamCost(player, "stanek", "canPlace"));
-      checkStanekAPIAccess("canPlace");
+    canPlaceFragment: function (_rootX: unknown, _rootY: unknown, _rotation: unknown, _fragmentId: unknown): boolean {
+      const rootX = helper.number("stanek.canPlaceFragment", "rootX", _rootX);
+      const rootY = helper.number("stanek.canPlaceFragment", "rootY", _rootY);
+      const rotation = helper.number("stanek.canPlaceFragment", "rotation", _rotation);
+      const fragmentId = helper.number("stanek.canPlaceFragment", "fragmentId", _fragmentId);
+      helper.updateDynamicRam("canPlaceFragment", getRamCost(player, "stanek", "canPlaceFragment"));
+      checkStanekAPIAccess("canPlaceFragment");
       const fragment = FragmentById(fragmentId);
-      if (!fragment) throw helper.makeRuntimeErrorMsg("stanek.canPlace", `Invalid fragment id: ${fragmentId}`);
+      if (!fragment) throw helper.makeRuntimeErrorMsg("stanek.canPlaceFragment", `Invalid fragment id: ${fragmentId}`);
       const can = staneksGift.canPlace(rootX, rootY, rotation, fragment);
       return can;
     },
-    place: function (_rootX: unknown, _rootY: unknown, _rotation: unknown, _fragmentId: unknown): boolean {
-      const rootX = helper.number("stanek.place", "rootX", _rootX);
-      const rootY = helper.number("stanek.place", "rootY", _rootY);
-      const rotation = helper.number("stanek.place", "rotation", _rotation);
-      const fragmentId = helper.number("stanek.place", "fragmentId", _fragmentId);
-      helper.updateDynamicRam("place", getRamCost(player, "stanek", "place"));
-      checkStanekAPIAccess("place");
+    placeFragment: function (_rootX: unknown, _rootY: unknown, _rotation: unknown, _fragmentId: unknown): boolean {
+      const rootX = helper.number("stanek.placeFragment", "rootX", _rootX);
+      const rootY = helper.number("stanek.placeFragment", "rootY", _rootY);
+      const rotation = helper.number("stanek.placeFragment", "rotation", _rotation);
+      const fragmentId = helper.number("stanek.placeFragment", "fragmentId", _fragmentId);
+      helper.updateDynamicRam("placeFragment", getRamCost(player, "stanek", "placeFragment"));
+      checkStanekAPIAccess("placeFragment");
       const fragment = FragmentById(fragmentId);
-      if (!fragment) throw helper.makeRuntimeErrorMsg("stanek.place", `Invalid fragment id: ${fragmentId}`);
+      if (!fragment) throw helper.makeRuntimeErrorMsg("stanek.placeFragment", `Invalid fragment id: ${fragmentId}`);
       return staneksGift.place(rootX, rootY, rotation, fragment);
     },
-    get: function (_rootX: unknown, _rootY: unknown): IActiveFragment | undefined {
-      const rootX = helper.number("stanek.get", "rootX", _rootX);
-      const rootY = helper.number("stanek.get", "rootY", _rootY);
-      helper.updateDynamicRam("get", getRamCost(player, "stanek", "get"));
-      checkStanekAPIAccess("get");
+    getFragment: function (_rootX: unknown, _rootY: unknown): IActiveFragment | undefined {
+      const rootX = helper.number("stanek.getFragment", "rootX", _rootX);
+      const rootY = helper.number("stanek.getFragment", "rootY", _rootY);
+      helper.updateDynamicRam("getFragment", getRamCost(player, "stanek", "getFragment"));
+      checkStanekAPIAccess("getFragment");
       const fragment = staneksGift.findFragment(rootX, rootY);
       if (fragment !== undefined) return fragment.copy();
       return undefined;
     },
-    remove: function (_rootX: unknown, _rootY: unknown): boolean {
-      const rootX = helper.number("stanek.remove", "rootX", _rootX);
-      const rootY = helper.number("stanek.remove", "rootY", _rootY);
-      helper.updateDynamicRam("remove", getRamCost(player, "stanek", "remove"));
-      checkStanekAPIAccess("remove");
+    removeFragment: function (_rootX: unknown, _rootY: unknown): boolean {
+      const rootX = helper.number("stanek.removeFragment", "rootX", _rootX);
+      const rootY = helper.number("stanek.removeFragment", "rootY", _rootY);
+      helper.updateDynamicRam("removeFragment", getRamCost(player, "stanek", "removeFragment"));
+      checkStanekAPIAccess("removeFragment");
       return staneksGift.delete(rootX, rootY);
     },
   };