fix: mistake with new GameInstance TContext generic (#155)

Author: fraxken

.changeset/humble-hats-poke.md

@@ -0,0 +1,6 @@
+---
+"@jolly-pixel/runtime": patch
+"@jolly-pixel/engine": patch
+---
+
+Fix some mistake with newest GameInstance TContext generic and add a type GameInstanceDefaultContext to avoid repeting the default type everywhere

packages/engine/src/actor/Actor.ts

@@ -2,10 +2,10 @@
 import * as THREE from "three";
 
 // Import Internal Dependencies
-import { type GameInstance } from "../systems/GameInstance.ts";
-import type { ActorComponent } from "./ActorComponent.ts";
 import { ActorTree } from "./ActorTree.ts";
 import { Transform } from "./Transform.ts";
+import type { GameInstance, GameInstanceDefaultContext } from "../systems/GameInstance.ts";
+import type { ActorComponent } from "./ActorComponent.ts";
 import type { Behavior } from "../components/script/Behavior.ts";
 import type {
   Component
@@ -18,14 +18,18 @@ type RequiresOptions<T extends ComponentConstructor> =
     ? undefined extends O ? false : true
     : false;
 
-export interface ActorOptions<TContext = Record<string, unknown>> {
+export interface ActorOptions<
+  TContext = GameInstanceDefaultContext
+> {
   name: string;
   parent?: Actor<TContext> | null;
   visible?: boolean;
   layer?: number | number[];
 }
 
-export class Actor<TContext = Record<string, unknown>> extends ActorTree<TContext> {
+export class Actor<
+  TContext = GameInstanceDefaultContext
+> extends ActorTree<TContext> {
   gameInstance: GameInstance<any, TContext>;
 
   name: string;
@@ -39,13 +43,16 @@ export class Actor<TContext = Record<string, unknown>> extends ActorTree<TContex
   threeObject = new THREE.Group();
 
   constructor(
-    gameInstance: GameInstance<any, any>,
+    gameInstance: GameInstance<any, TContext>,
     options: ActorOptions<TContext>
   ) {
     super();
     const { name, parent = null, visible = true, layer } = options;
 
-    if (parent !== null && parent.pendingForDestruction) {
+    if (
+      parent !== null &&
+      parent.pendingForDestruction
+    ) {
       throw new Error("Cannot add actor to a parent that is pending for destruction.");
     }
 
@@ -111,14 +118,13 @@ export class Actor<TContext = Record<string, unknown>> extends ActorTree<TContex
   }
 
   getComponentByName<T extends ActorComponent<TContext>>(
-    actor: Actor<TContext>,
-    componentName: string
+    componentTypeName: string
   ): T {
-    const component = actor.components.find(
-      (comp) => comp.typeName === componentName
+    const component = this.components.find(
+      (comp) => comp.typeName === componentTypeName
     );
     if (!component) {
-      throw new Error(`Component with typeName "${componentName}" not found on actor "${actor.name}"`);
+      throw new Error(`Component with typeName "${componentTypeName}" not found on actor "${this.name}"`);
     }
 
     return component as T;

packages/engine/src/actor/ActorComponent.ts

@@ -4,12 +4,17 @@ import { EventEmitter } from "@posva/event-emitter";
 // Import Internal Dependencies
 import { Actor } from "./Actor.ts";
 import { getSignalMetadata, SignalEvent } from "./Signal.ts";
+import type {
+  GameInstanceDefaultContext
+} from "../systems/GameInstance.ts";
 import type {
   Component,
   FreeComponentEnum
 } from "../components/types.ts";
 
-export interface ActorComponentOptions<TContext = Record<string, unknown>> {
+export interface ActorComponentOptions<
+  TContext = GameInstanceDefaultContext
+> {
   actor: Actor<TContext>;
   typeName: FreeComponentEnum;
 }
@@ -18,7 +23,9 @@ export type ActorComponentEvents = {
   metadataInitialized: [];
 };
 
-export class ActorComponent<TContext = Record<string, unknown>> extends EventEmitter<ActorComponentEvents> implements Component {
+export class ActorComponent<
+  TContext = GameInstanceDefaultContext
+> extends EventEmitter<ActorComponentEvents> implements Component {
   protected static Id = 0;
 
   static generateNextId() {

packages/engine/src/actor/ActorTree.ts

@@ -2,19 +2,28 @@
 import pm from "picomatch";
 
 // Import Internal Dependencies
+import type {
+  GameInstanceDefaultContext
+} from "../systems/GameInstance.ts";
 import { Actor } from "./Actor.ts";
 
-export type ActorTreeNode<TContext = Record<string, unknown>> = {
+export type ActorTreeNode<
+  TContext = GameInstanceDefaultContext
+> = {
   actor: Actor<TContext>;
   parent?: Actor<TContext>;
 };
 
-export interface ActorTreeOptions<TContext = Record<string, unknown>> {
+export interface ActorTreeOptions<
+  TContext = GameInstanceDefaultContext
+> {
   addCallback?: (actor: Actor<TContext>) => void;
   removeCallback?: (actor: Actor<TContext>) => void;
 }
 
-export class ActorTree<TContext = Record<string, unknown>> {
+export class ActorTree<
+  TContext = GameInstanceDefaultContext
+> {
   #addCallback?: (actor: Actor<TContext>) => void;
   #removeCallback?: (actor: Actor<TContext>) => void;
 

packages/engine/src/audio/AudioManager.ts

@@ -43,7 +43,7 @@ export class GlobalAudioManager implements AudioManager {
   #audioService: AudioFactory;
 
   static fromGameInstance(
-    gameInstance: GameInstance
+    gameInstance: GameInstance<any, any>
   ): GlobalAudioManager {
     return new GlobalAudioManager({
       listener: gameInstance.audio.listener

packages/engine/src/components/script/Behavior.ts

@@ -2,6 +2,9 @@
 import * as THREE from "three";
 
 // Import Internal Dependencies
+import type {
+  GameInstanceDefaultContext
+} from "../../systems/GameInstance.ts";
 import {
   Actor,
   ActorComponent
@@ -25,7 +28,7 @@ export interface BehaviorOptions {
 
 export class Behavior<
   T extends BehaviorProperties = Record<string, BehaviorPropertiesValue>,
-  TContext = Record<string, unknown>
+  TContext = GameInstanceDefaultContext
 > extends ActorComponent<TContext> {
   #properties: T = Object.create(null);
 

packages/engine/src/systems/GameInstance.ts

@@ -23,7 +23,9 @@ import {
   BrowserGlobalsAdapter
 } from "../adapters/global.ts";
 
-export interface GameInstanceOptions<TContext = Record<string, unknown>> {
+export interface GameInstanceOptions<
+  TContext = GameInstanceDefaultContext
+> {
   enableOnExit?: boolean;
 
   scene: Scene;
@@ -35,7 +37,14 @@ export interface GameInstanceOptions<TContext = Record<string, unknown>> {
   globalsAdapter?: GlobalsAdapter;
 }
 
-export class GameInstance<T = THREE.WebGLRenderer, TContext = Record<string, unknown>> {
+export interface GameInstanceDefaultContext {
+  [key: string]: unknown;
+}
+
+export class GameInstance<
+  T = THREE.WebGLRenderer,
+  TContext = GameInstanceDefaultContext
+> {
   renderer: Renderer<T>;
   input: Input;
   loadingManager: THREE.LoadingManager = new THREE.LoadingManager();
@@ -53,7 +62,7 @@ export class GameInstance<T = THREE.WebGLRenderer, TContext = Record<string, unk
       scene,
       input = new Input(renderer.canvas, { enableOnExit: options.enableOnExit ?? false }),
       audio = new GlobalAudio(),
-      context = {} as TContext,
+      context = Object.create(null),
       windowAdapter = new BrowserWindowAdapter(),
       globalsAdapter = new BrowserGlobalsAdapter()
     } = options;

packages/engine/src/ui/UINode.ts

@@ -2,8 +2,10 @@
 import * as THREE from "three";
 
 // Import Internal Dependencies
-import { type Actor, ActorComponent } from "../actor/index.ts";
+import type { GameInstanceDefaultContext } from "../systems/GameInstance.ts";
 import type { UIRenderer } from "./UIRenderer.ts";
+import { type Actor, ActorComponent } from "../actor/index.ts";
+import { UIRendererID } from "./common.ts";
 
 export type UIAnchorX = "left" | "center" | "right";
 export type UIAnchorY = "top" | "center" | "bottom";
@@ -56,17 +58,19 @@ export interface UINodeOptions extends UINodePositionalOptions {
   };
 }
 
-export class UINode extends ActorComponent<any> {
+export class UINode<TContext = GameInstanceDefaultContext> extends ActorComponent<TContext> {
   #options: UINodeOptions;
 
   constructor(
-    actor: Actor<any>,
+    actor: Actor<TContext>,
     options: UINodeOptions = {}
   ) {
     super({ actor, typeName: "UINode" });
     this.#options = options;
 
-    const uiRenderer = this.actor.gameInstance[Symbol.for("UIRenderer")] as UIRenderer;
+    const uiRenderer = this.actor.gameInstance[
+      UIRendererID
+    ] as UIRenderer<TContext> | undefined;
     if (uiRenderer) {
       uiRenderer.addChildren(this);
     }

packages/engine/src/ui/UIRenderer.ts

@@ -3,8 +3,10 @@ import * as THREE from "three";
 import { CSS2DRenderer as ThreeCSS2DRenderer } from "three/addons/renderers/CSS2DRenderer.js";
 
 // Import Internal Dependencies
-import { type Actor, ActorComponent } from "../actor/index.ts";
+import type { GameInstanceDefaultContext } from "../systems/GameInstance.ts";
 import type { UINode } from "./UINode.ts";
+import { type Actor, ActorComponent } from "../actor/index.ts";
+import { UIRendererID } from "./common.ts";
 
 // CONSTANTS
 const kOrthographicCameraZIndex = 10;
@@ -15,18 +17,18 @@ export interface UIRendererOptions {
   zIndex?: number;
 }
 
-export class UIRenderer extends ActorComponent<any> {
-  static ID = Symbol.for("UIRenderer");
-
+export class UIRenderer<
+  TContext = GameInstanceDefaultContext
+> extends ActorComponent<TContext> {
   camera: THREE.OrthographicCamera;
-  nodes: UINode[] = [];
+  nodes: UINode<TContext>[] = [];
 
   #cssRenderer: ThreeCSS2DRenderer;
   #boundDraw: () => void;
   #boundResize: () => void;
 
   constructor(
-    actor: Actor<any>,
+    actor: Actor<TContext>,
     options: UIRendererOptions = {}
   ) {
     super({ actor, typeName: "UIRenderer" });
@@ -70,13 +72,15 @@ export class UIRenderer extends ActorComponent<any> {
     gameInstance.renderer.on("resize", this.#boundResize);
     gameInstance.renderer.on("draw", this.#boundDraw);
 
-    Object.defineProperty(gameInstance, UIRenderer.ID, {
+    Object.defineProperty(gameInstance, UIRendererID, {
       value: this,
       enumerable: false
     });
   }
 
-  addChildren(node: UINode): void {
+  addChildren(
+    node: UINode<TContext>
+  ): void {
     const nodeIndex = this.nodes.indexOf(node);
     if (nodeIndex !== -1) {
       return;
@@ -118,6 +122,6 @@ export class UIRenderer extends ActorComponent<any> {
 
     this.#cssRenderer.domElement.remove();
 
-    gameInstance[UIRenderer.ID] = undefined;
+    gameInstance[UIRendererID] = undefined;
   }
 }

packages/engine/src/ui/UISprite.ts

@@ -2,6 +2,9 @@
 import * as THREE from "three";
 
 // Import Internal Dependencies
+import type {
+  GameInstanceDefaultContext
+} from "../systems/GameInstance.ts";
 import {
   Actor,
   SignalEvent
@@ -30,14 +33,16 @@ export interface UISpriteOptions extends UINodeOptions {
   styleOnHover?: UISpriteStyle;
 }
 
-export class UISprite extends UINode {
+export class UISprite<
+  TContext = GameInstanceDefaultContext
+> extends UINode<TContext> {
   mesh: THREE.Mesh;
 
   #isHovered = false;
   #isPressed = false;
   #style: UISpriteStyle;
   #styleOnHover: UISpriteStyle | null;
-  #text: UIText | undefined;
+  #text: UIText<TContext> | undefined;
 
   #lastClickTime = 0;
 
@@ -51,7 +56,7 @@ export class UISprite extends UINode {
   onHover = new SignalEvent();
 
   constructor(
-    actor: Actor<any>,
+    actor: Actor<TContext>,
     options: UISpriteOptions = {}
   ) {
     super(actor, options);