@hotbunny/hackhub-content-sdk 0.9.5 → 0.9.7

package/README.md

@@ -1,4 +1,4 @@
-# @hotbunny/hackhub-content-sdk
+# Hackhub Content SDK
 
 Official modding SDK for [HackHub - Ultimate Hacker Simulator](https://store.steampowered.com/app/2980270/HackHub__Ultimate_Hacker_Simulator/) on Steam. Create custom quests, websites, terminal commands, desktop apps, and more.
 
@@ -27,6 +27,7 @@ import { Bootstrap, RegisterModPackage } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
+
     OnModPackageLoaded() {
         console.log("Mod loaded!");
     }
@@ -34,6 +35,7 @@ export default class MyMod extends Bootstrap {
     OnModPackageUnloaded() {
         console.log("Mod unloaded");
     }
+
 }
 ```
 
@@ -42,7 +44,7 @@ export default class MyMod extends Bootstrap {
 Quests use a generic type parameter for type-safe data. `CreateData()` initializes the data once when the quest is first claimed. After that, access via `this.Data` and update via `this.SetData()`:
 
 ```typescript
-import { Quest, Events, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
+import { Quest, Network, RegisterQuest } from "@hotbunny/hackhub-content-sdk";
 
 interface InfiltrationData {
     targetIp: string;
@@ -51,10 +53,10 @@ interface InfiltrationData {
 
 @RegisterQuest
 class InfiltrationQuest extends Quest<InfiltrationData> {
+
     Name = "Infiltration";
     Title = "Server Infiltration";
     Description = "Hack into the target server and download the data.";
-    Employer = { name: "Mr. X", avatar: "mrx" };
     Rewards = { money: 5000, xp: 200 };
     Objectives = [
         { name: "scan", description: "Scan the target server" },
@@ -74,21 +76,21 @@ class InfiltrationQuest extends Quest<InfiltrationData> {
 
     OnStart() {
         Network.createSubnetNetwork({
-            ip: this.Data.targetIp,   // fully typed
+            ip: this.Data.targetIp,
             type: "ROUTER",
             ports: [{ external: 22, internal: 22, active: true, service: "ssh" }],
             users: [Network.createUser({ username: "admin", password: "secret123" })],
             children: [],
         });
 
-        Events.on("Terminal.NmapScan", (data) => {
+        this.Events.on("Terminal.NmapScan", (data) => {
             if (data.ip === this.Data.targetIp) {
-                this.SetData("attempts", this.Data.attempts + 1);  // type-safe key & value
+                this.SetData("attempts", this.Data.attempts + 1);
                 this.completeObjective("scan");
             }
         });
 
-        Events.on("Terminal.SSH.Connected", (data) => {
+        this.Events.on("Terminal.SSH.Connected", (data) => {
             if (data.ip === this.Data.targetIp) this.completeObjective("connect");
         });
     }
@@ -96,6 +98,7 @@ class InfiltrationQuest extends Quest<InfiltrationData> {
     OnComplete() {
         Network.destroyNetwork(this.Data.targetIp);
     }
+
 }
 ```
 
@@ -106,14 +109,11 @@ Quests can send in-game emails and start phone call dialogs:
 ```typescript
 @RegisterQuest
 class StoryQuest extends Quest<{ contacted: boolean }> {
+
     Name = "StoryQuest";
     Title = "Story Quest";
     Objectives = [{ name: "start", description: "Begin the mission" }];
 
-    CreateData() {
-        return { contacted: false };
-    }
-
     Mails = [
         { title: "Mission Briefing", content: "Your target is ready. Good luck." },
     ];
@@ -130,10 +130,15 @@ class StoryQuest extends Quest<{ contacted: boolean }> {
         ],
     };
 
+    CreateData() {
+        return { contacted: false };
+    }
+
     OnStart() {
         this.sendMail(0);
         this.createDialog("default");
     }
+
 }
 ```
 
@@ -144,10 +149,12 @@ import { Website, RegisterWebsite } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterWebsite
 class MyWebsite extends Website {
+
     SiteName = "darkforum";
     DisplayName = "DarkForum";
     Description = "Underground hacking forum";
     HTML = "website.html";
+
 }
 ```
 
@@ -158,12 +165,14 @@ import { Command, RegisterCommand } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterCommand
 class PingCommand extends Command {
+
     CommandName = "myping";
     Description = "Custom ping command";
 
     OnCommand(args: string[], tools: any) {
         tools.println(`Pinging ${args[0] || "nowhere"}...`);
     }
+
 }
 ```
 
@@ -174,11 +183,13 @@ import { App, RegisterApp } from "@hotbunny/hackhub-content-sdk";
 
 @RegisterApp
 class MyApp extends App {
+
     AppName = "mytool";
     DisplayName = "My Tool";
     Description = "A custom desktop application";
     HTML = "app.html";
     Size = { width: 600, height: 400 };
+
 }
 ```
 
@@ -191,6 +202,7 @@ import { Bootstrap, ModSettingDefinition, ModSettings, RegisterModPackage } from
 
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
+
     Settings: ModSettingDefinition[] = [
         {
             key: "difficulty",
@@ -212,6 +224,7 @@ export default class MyMod extends Bootstrap {
         const hints = ModSettings.get<boolean>("showHints");
         console.log(`Difficulty: ${difficulty}, Hints: ${hints}`);
     }
+
 }
 ```
 
@@ -222,7 +235,9 @@ For fully custom settings panels, use an HTML file rendered in iframe:
 ```typescript
 @RegisterModPackage
 export default class MyMod extends Bootstrap {
+
     SettingsHTML = "settings.html";
+
 }
 ```
 

package/index.d.ts

@@ -1077,9 +1077,30 @@ export declare abstract class Bootstrap {
 	/** Called when the mod is being unloaded (e.g. disabled by user). */
 	OnModPackageUnloaded(): void;
 }
+/**
+ * Scoped event manager for a quest. All listeners registered via
+ * `this.Events.on()` are automatically removed when the quest
+ * completes or is abandoned, preventing memory leaks.
+ */
+export declare class QuestEvents {
+	private _listeners;
+	/** @internal */ _globalOn?: (event: string, callback: Function) => () => void;
+	/**
+	 * Listen to a game event or custom event. The listener is automatically
+	 * removed when the quest completes or is abandoned.
+	 */
+	on<T extends string>(event: T, callback: (data: T extends keyof ModEventMap ? ModEventMap[T] : any) => void): () => void;
+	/** Remove a specific listener. */
+	off(event: string, callback: Function): void;
+	/** Remove all listeners registered through this quest. */
+	offAll(): void;
+}
 /**
  * Base class for mod quests. Extend with a generic type for type-safe quest data.
  *
+ * Use `this.Events.on()` instead of the global `Events.on()` so listeners
+ * are automatically cleaned up when the quest completes or is abandoned.
+ *
  * @example
  * ```ts
  * interface MyData { targetIp: string; attempts: number; }
@@ -1097,8 +1118,9 @@ export declare abstract class Bootstrap {
  *     }
  *
  *     OnStart() {
- *         console.log(this.Data.targetIp); // fully typed
- *         this.SetData("attempts", 1);     // type-safe key & value
+ *         this.Events.on("Terminal.NmapScan", (data) => {
+ *             if (data.ip === this.Data.targetIp) this.completeObjective("scan");
+ *         });
  *     }
  * }
  * ```
@@ -1132,9 +1154,14 @@ export declare abstract class Quest<T extends Record<string, any> = Record<strin
 	Dialog?: QuestDialogDefinition;
 	/** Quest data created by CreateData(). Populated at runtime by the game engine. */
 	Data: T;
+	/**
+	 * Scoped event manager. Listeners registered here are automatically
+	 * cleaned up when the quest completes or is abandoned.
+	 */
+	Events: QuestEvents;
 	/**
 	 * Called when the quest is first claimed/started.
-	 * Use this to set up event listeners for objective completion.
+	 * Use this to set up event listeners via `this.Events.on()`.
 	 */
 	OnStart(): void | Promise<void>;
 	/** Called when all objectives are completed and the quest finishes. */
@@ -1316,6 +1343,7 @@ export declare abstract class App {
 	 */
 	Exports?: Record<string, any>;
 }
+type () => void$1 = () => void;
 /**
  * Game events API. Allows mods to listen to in-game events
  * such as terminal commands, file operations, network events, etc.
@@ -1353,7 +1381,7 @@ export declare namespace Events {
 	 * For known `ModEventMap` keys, the callback is fully typed.
 	 * For custom string events, the callback receives `any`.
 	 */
-	export function on<T extends string>(event: T, callback: (data: T extends keyof ModEventMap ? ModEventMap[T] : any) => void): () => void;
+	export function on<T extends string>(event: T, callback: (data: T extends keyof ModEventMap ? ModEventMap[T] : any) => void): () => void$1;
 	/** Remove a specific event listener. */
 	export function off(event: string, callback: Function): void;
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotbunny/hackhub-content-sdk",
-    "version": "0.9.5",
+    "version": "0.9.7",
     "description": "Official modding SDK for HackHub - Ultimate Hacker Simulator on Steam. Create custom quests, websites, terminal commands, and desktop apps.",
     "types": "index.d.ts",
     "exports": {