NETSCRIPTSLEEVE: Add cyclesWorked to ns.sleeve.getTask return (#409)

markdown/bitburner.sleevebladeburnertask.md

@@ -13,5 +13,6 @@ type SleeveBladeburnerTask = {
   actionType: "General" | "Contracts";
   actionName: string;
   cyclesWorked: number;
+  cyclesNeeded: number;
 };
 ```

markdown/bitburner.sleevecrimetask.md

@@ -8,7 +8,12 @@
 **Signature:**
 
 ```typescript
-type SleeveCrimeTask = { type: "CRIME"; crimeType: CrimeType | `${CrimeType}`; cyclesWorked: number };
+type SleeveCrimeTask = {
+  type: "CRIME";
+  crimeType: CrimeType | `${CrimeType}`;
+  cyclesWorked: number;
+  cyclesNeeded: number;
+};
 ```
 **References:** [CrimeType](./bitburner.crimetype.md)
 

markdown/bitburner.sleeveinfiltratetask.md

@@ -8,5 +8,5 @@
 **Signature:**
 
 ```typescript
-type SleeveInfiltrateTask = { type: "INFILTRATE"; cyclesWorked: number };
+type SleeveInfiltrateTask = { type: "INFILTRATE"; cyclesWorked: number; cyclesNeeded: number };
 ```

src/NetscriptFunctions/Sleeve.ts

@@ -150,7 +150,7 @@ export function NetscriptSleeve(): InternalAPI<Sleeve> {
 
       const sl = Player.sleeves[sleeveNumber];
       if (sl.currentWork === null) return null;
-      return sl.currentWork.APICopy();
+      return sl.currentWork.APICopy(sl);
     },
     getSleeve: (ctx) => (_sleeveNumber) => {
       const sleeveNumber = helpers.number(ctx, "sleeveNumber", _sleeveNumber);

src/PersonObjects/Sleeve/Sleeve.ts

@@ -286,7 +286,7 @@ export class Sleeve extends Person implements SleevePerson {
     if (company == null) return false;
     if (companyPosition == null) return false;
 
-    this.startWork(new SleeveCompanyWork({ companyName: companyName }));
+    this.startWork(new SleeveCompanyWork(companyName));
 
     return true;
   }

src/PersonObjects/Sleeve/Work/SleeveBladeburnerWork.ts

@@ -32,7 +32,7 @@ export class SleeveBladeburnerWork extends Work {
   }
 
   process(sleeve: Sleeve, cycles: number) {
-    if (!Player.bladeburner) throw new Error("sleeve doing blade work without being a member");
+    if (!Player.bladeburner) return sleeve.stopWork();
     this.cyclesWorked += cycles;
     const actionIdent = Player.bladeburner.getActionIdFromTypeAndName(this.actionType, this.actionName);
     if (!actionIdent) throw new Error(`Error getting ${this.actionName} action`);
@@ -62,12 +62,13 @@ export class SleeveBladeburnerWork extends Work {
     }
   }
 
-  APICopy() {
+  APICopy(sleeve: Sleeve) {
     return {
       type: WorkType.BLADEBURNER as "BLADEBURNER",
       actionType: this.actionType,
       actionName: this.actionName,
       cyclesWorked: this.cyclesWorked,
+      cyclesNeeded: this.cyclesNeeded(sleeve),
     };
   }
 

src/PersonObjects/Sleeve/Work/SleeveCompanyWork.ts

@@ -10,19 +10,15 @@ import { influenceStockThroughCompanyWork } from "../../../StockMarket/PlayerInf
 import { Player } from "@player";
 import { CompanyPositions } from "../../../Company/CompanyPositions";
 
-interface SleeveCompanyWorkParams {
-  companyName: string;
-}
-
 export const isSleeveCompanyWork = (w: Work | null): w is SleeveCompanyWork =>
   w !== null && w.type === WorkType.COMPANY;
 
 export class SleeveCompanyWork extends Work {
   companyName: string;
 
-  constructor(params?: SleeveCompanyWorkParams) {
+  constructor(companyName?: string) {
     super(WorkType.COMPANY);
-    this.companyName = params?.companyName ?? LocationName.NewTokyoNoodleBar;
+    this.companyName = companyName ?? LocationName.NewTokyoNoodleBar;
   }
 
   getCompany(): Company {

src/PersonObjects/Sleeve/Work/SleeveCrimeWork.ts

@@ -52,6 +52,7 @@ export class SleeveCrimeWork extends Work {
       type: WorkType.CRIME as "CRIME",
       crimeType: this.crimeType,
       cyclesWorked: this.cyclesWorked,
+      cyclesNeeded: this.cyclesNeeded(),
     };
   }
 

src/PersonObjects/Sleeve/Work/SleeveInfiltrateWork.ts

@@ -20,8 +20,8 @@ export class SleeveInfiltrateWork extends Work {
     return infiltrateCycles;
   }
 
-  process(_sleeve: Sleeve, cycles: number) {
-    if (!Player.bladeburner) throw new Error("sleeve doing blade work without being a member");
+  process(sleeve: Sleeve, cycles: number) {
+    if (!Player.bladeburner) return sleeve.stopWork();
     this.cyclesWorked += cycles;
     if (this.cyclesWorked > this.cyclesNeeded()) {
       this.cyclesWorked -= this.cyclesNeeded();
@@ -33,6 +33,7 @@ export class SleeveInfiltrateWork extends Work {
     return {
       type: WorkType.INFILTRATE as "INFILTRATE",
       cyclesWorked: this.cyclesWorked,
+      cyclesNeeded: this.cyclesNeeded(),
     };
   }
 

src/PersonObjects/Sleeve/Work/SleeveRecoveryWork.ts

@@ -20,9 +20,7 @@ export class SleeveRecoveryWork extends Work {
   }
 
   APICopy() {
-    return {
-      type: WorkType.RECOVERY as "RECOVERY",
-    };
+    return { type: WorkType.RECOVERY as "RECOVERY" };
   }
 
   /** Serialize the current object to a JSON save state. */

src/PersonObjects/Sleeve/Work/SleeveSupportWork.ts

@@ -20,9 +20,7 @@ export class SleeveSupportWork extends Work {
   }
 
   APICopy() {
-    return {
-      type: WorkType.SUPPORT as "SUPPORT",
-    };
+    return { type: WorkType.SUPPORT as "SUPPORT" };
   }
 
   /** Serialize the current object to a JSON save state. */

src/PersonObjects/Sleeve/Work/SleeveSynchroWork.ts

@@ -21,9 +21,7 @@ export class SleeveSynchroWork extends Work {
   }
 
   APICopy() {
-    return {
-      type: WorkType.SYNCHRO as "SYNCHRO",
-    };
+    return { type: WorkType.SYNCHRO as "SYNCHRO" };
   }
 
   /** Serialize the current object to a JSON save state. */

src/PersonObjects/Sleeve/Work/Work.ts

@@ -22,7 +22,7 @@ export abstract class Work {
   }
 
   abstract process(sleeve: Sleeve, cycles: number): void;
-  abstract APICopy(): SleeveTask;
+  abstract APICopy(sleeve: Sleeve): SleeveTask;
   abstract toJSON(): IReviverValue;
   finish(): void {
     /* left for children to implement */

src/ScriptEditor/NetscriptDefinitions.d.ts

@@ -878,6 +878,7 @@ type SleeveBladeburnerTask = {
   actionType: "General" | "Contracts";
   actionName: string;
   cyclesWorked: number;
+  cyclesNeeded: number;
 };
 
 /** @public */
@@ -891,7 +892,12 @@ type SleeveClassTask = {
 type SleeveCompanyTask = { type: "COMPANY"; companyName: string };
 
 /** @public */
-type SleeveCrimeTask = { type: "CRIME"; crimeType: CrimeType | `${CrimeType}`; cyclesWorked: number };
+type SleeveCrimeTask = {
+  type: "CRIME";
+  crimeType: CrimeType | `${CrimeType}`;
+  cyclesWorked: number;
+  cyclesNeeded: number;
+};
 
 /** @public */
 type SleeveFactionTask = {
@@ -901,7 +907,7 @@ type SleeveFactionTask = {
 };
 
 /** @public */
-type SleeveInfiltrateTask = { type: "INFILTRATE"; cyclesWorked: number };
+type SleeveInfiltrateTask = { type: "INFILTRATE"; cyclesWorked: number; cyclesNeeded: number };
 
 /** @public */
 type SleeveRecoveryTask = { type: "RECOVERY" };