improve logging

Author: sojs-coder

Parts/Camera.ts

@@ -40,7 +40,11 @@ export class Camera extends Part {
         // Could be used in rendering context
         const transform = this.child<Transform>("Transform")
         if (!transform) {
-            this.top?.warn(`Camera <${this.name}> (${this.id}) does not have a Transform component. View matrix will not be calculated.`);
+            if (!this.warned.has("TransformMissing")) {
+                // Warn only once about missing Transform component
+                const seen = this.top?.warn(`Camera <${this.name}> (${this.id}) does not have a Transform component. View matrix will not be calculated.`);
+                if (seen) this.warned.add("TransformMissing");
+            }
             return { offset: Vector.From(0), scale: this.zoom };
         }
         return {
@@ -55,7 +59,9 @@ export class Camera extends Part {
         if (transform) {
             this.zoom = transform.scale;
         } else {
-            this.top?.warn(`Camera <${this.name}> (${this.id}) does not have a Transform component. Camera zoom will not be updated.`);
+            if (!this.warned.has("TransformMissing")) {
+                this.top?.warn(`Camera <${this.name}> (${this.id}) does not have a Transform component. Camera zoom will not be updated.`) ? this.warned.add("TransformMissing") : null;
+            }
         }
     }
 

Parts/Children/AnimatedSprite.ts

@@ -9,7 +9,6 @@ export class AnimatedSprite extends Renderer {
     loadedSheet?: HTMLImageElement; // Loaded image for the spritesheet
     frames: Record<string, HTMLImageElement[]> = {}; // Object to hold individual frame images for each animation
     currentFrameIndex: number = 0; // Index of the current frame being displayed
-    hasWarnedAboutTransform: boolean = false; // Flag to prevent multiple warnings about missing Transform part
     width: number; // Width of the animated sprite
     height: number; // Height of the animated sprite
     bouncing: boolean = false; // Flag to indicate if the sprite animation is in reverse (bouncing)
@@ -240,9 +239,9 @@ export class AnimatedSprite extends Renderer {
             }
             const transform = this.sibling<Transform>("Transform");
             if (!transform) {
-                if (!this.hasWarnedAboutTransform) {
-                    this.top?.warn(`AnimatedSprite <${this.name}> attached to ${this.parent?.name} does not have a Transform component. Skipping rendering. This will only show once.`);
-                    this.hasWarnedAboutTransform = true;
+                if (!this.warned.has("TransformMissing")) {
+                    const seen = this.top?.warn(`AnimatedSprite <${this.name}> attached to ${this.parent?.name} does not have a Transform component. Skipping rendering. This will only show once.`);
+                    if (seen) this.warned.add("TransformMissing");
                 }
                 return;
             }

Parts/Children/Button.ts

@@ -6,6 +6,7 @@ import { Scene } from "../Scene";
 import { Renderer } from "./Renderer";
 import { Sound } from "../Sound";
 import { isNamedTupleMember } from "typescript";
+import type { Camera } from "../Camera";
 
 export class Button extends Renderer {
     styles?: ButtonStyles;
@@ -24,11 +25,9 @@ export class Button extends Renderer {
         this.clickSound = clickSound;
         this.hoverSound = hoverSound;
         this.activeSound = activeSound;
-        console.log(clickSound, hoverSound, activeSound);
         this.type = "Button";
 
         this.onclick = (event: MouseEvent, input: any) => {
-            console.log(`Button <${this.name}> clicked!`);
             if (this.onClickHandler) {
                 this.onClickHandler();
             }
@@ -41,9 +40,8 @@ export class Button extends Renderer {
 
         this.onhover = () => {
             this.isHovered = true;
-            console.log('hovered', this.hoverSound);
             if (this.hoverSound) {
-    
+
                 this.hoverSound.play({ clone: true });
             }
         };
@@ -68,29 +66,13 @@ export class Button extends Renderer {
             }
         };
     }
-    onRegister(attribute: string, value: any): void {
-        super.onRegister(attribute, value);
-        if (attribute == "scene") {
-            const scene = value as Scene;
-            if (!scene.child<Input>("Input")) {
-                const input = new Input({
-                    key: () => {},
-                    keyup: () => {},
-                    mousemove: () => {},
-                    click: () => {}
-                });
-                scene.addChild(input);
-            }
-        }
-    }
     onMount(parent: Part) {
         super.onMount(parent);
         if (!this.sibling("Transform")) {
             this.top?.warn(
                 `Button <${this.name}> (${this.id}) does not have Transform sibling. Please ensure you add a Transform component before adding a Button.`
             );
         }
-
         // Set superficial dimensions based on default styles
         const defaultStyle = this.styles?.default;
         this.superficialWidth = defaultStyle?.width ?? 100;
@@ -109,7 +91,24 @@ export class Button extends Renderer {
         if (!transform) {
             throw new Error(`Button <${this.name}> does not have a Transform sibling. Ensure it is mounted to a GameObject with a Transform component.`);
         }
-
+        const scene = this.registrations["scene"] as Scene | undefined;
+        if (scene) {
+            if (!scene.child<Input>("Input")) {
+                const input = new Input({
+                    key: () => { },
+                    keyup: () => { },
+                    mousemove: () => { },
+                    click: () => { }
+                });
+                scene.addChild(input);
+            }
+            if (!scene.child<Camera>("Camera") && !this.warned.has("Camera")) {
+                const seen = this.top?.error(`Button <${this.name}> requires a Camera to function properly. Please add a Camera to the Scene.`);
+                if (seen) {
+                    this.warned.add("Camera");
+                }
+            }
+        }
         const position = transform.worldPosition;
         const rotation = transform.rotation;
         const scale = transform.scale;

Parts/Game.ts

@@ -8,7 +8,6 @@ export class Game extends Part {
     canvas: HTMLCanvasElement;
     currentScene?: Scene;
     childrenArray: Scene[];
-    hasWarnedActUsage: boolean = false;
     devmode: boolean;
     context: CanvasRenderingContext2D;
     showtoolTips: boolean = false;
@@ -38,6 +37,7 @@ export class Game extends Part {
         this.context.imageSmoothingEnabled = !disableAntiAliasing;
         this.debugEmoji = "🎮";
         this.tooltipLocked = false;
+        this.top = this;
         if (this.devmode) {
             let tooltip = document.getElementById("debug-tooltip");
             if (!tooltip) {
@@ -170,11 +170,12 @@ export class Game extends Part {
 
     pause() {
         this._isPaused = true;
+        this.debug("Game paused");
         SoundManager.pauseGame();
-
     }
 
     resume() {
+        this.debug("Game resumed");
         this._isPaused = false;
         SoundManager.resumeGame();
     }
@@ -203,9 +204,9 @@ export class Game extends Part {
     }
 
     act(purposeful: boolean | number = false) {
-        if (!this.hasWarnedActUsage && !purposeful) {
-            this.warn(`Act called on Game <${this.name}>. Use start() to begin the game loop. Calling act() directly will run 1 frame of the current scene. This message will appear only once.`);
-            this.hasWarnedActUsage = true;
+        if (!this.warned.has("ActUsage") && !purposeful) {
+            const seen = this.warn(`Act called on Game <${this.name}>. Use start() to begin the game loop. Calling act() directly will run 1 frame of the current scene. This message will appear only once.`);
+            if (seen) this.warned.add("ActUsage");
         }
         if (this.currentScene) {
             this.currentScene.act(0);
@@ -229,22 +230,28 @@ export class Game extends Part {
     warn (...args: any[]) {
         if (this.messageHook && typeof this.messageHook === "function") {
             this.messageHook("warn", ...args);
+            return true;
         } else {
             console.warn(`[${this.name}] - WARN`, ...args);
+            return false;
         }
     }
     error (...args: any[]) {
         if (this.messageHook && typeof this.messageHook === "function") {
             this.messageHook("error", ...args);
+            return true;
         } else {
             console.error(`[${this.name}] - ERROR`, ...args);
+            return false;
         }
     }
     debug (...args: any[]) {
         if (this.messageHook && typeof this.messageHook === "function") {
             this.messageHook("debug", ...args);
+            return true;
         } else {
             console.debug(`[${this.name}]`, ...args);
+            return false;
         }
     }
     updateDebugToolTip() {

Parts/Input.ts

@@ -64,7 +64,9 @@ export class Input extends Part {
                 const view = camera.getViewMatrix();
                 const transform = camera.child<Transform>("Transform");
                 if (!transform) {
-                    this.top?.warn("Camera does not have a Transform child.");
+                    if (!this.warned.has("TransformMissing")) {
+                        this.top?.warn("Camera does not have a Transform child.") ? this.warned.add("TransformMissing") : null;
+                    }
                     return;
                 }
                 finalX = (mouseX - game.canvas.width / 2) / view.scale.x + transform.worldPosition.x;

Parts/Layer.ts

@@ -1,6 +1,7 @@
 import { GameObject } from "./GameObject";
 import { generateUID } from "../helpers";
 import { Part } from "./Part";
+import type { Game } from "./Game";
 
 export class Layer extends Part {
     constructor({ name }: { name: string }) {

Parts/Part.ts

@@ -31,7 +31,7 @@ export class Part {
     _superficialHeight: number = 0; // General height of object
     ties: Set<Tie> = new Set(); // Ties to other parts, allowing for dynamic attribute linking
     type: string;
-
+    warned: Set<string> = new Set(); // Set to track warnings for this part, preventing duplicate warnings
     private _childrenByName: { [name: string]: Part } = {}; // For quick access to children by name
     private _childrenByType: { [type: string]: Array<Part> } = {}; // For quick access to children by type
     constructor({ name }: { name?: string } = {}) {
@@ -120,9 +120,6 @@ export class Part {
     }
     onMount(parent: Part) {
         this.parent = parent;
-        for (const [k, v] of Object.entries(parent.registrations)) {
-            this.setAll(k, v);
-        }
     }
     onRegister(attribute: string, value: any) {
         // This method can be overridden in subclasses to handle registration logic
@@ -167,6 +164,9 @@ export class Part {
         if (this.top) {
             child.setTop(this.top); // Set the top-level parent for the child
         }
+        for (const [k, v] of Object.entries(this.registrations)) {
+            child.setAll(k, v);
+        }
         child.onMount(this);
     }
     addChildren(...children: Part[]) {

Parts/Scene.ts

@@ -15,13 +15,14 @@ export class Scene extends Part {
     addChild(part: Part) {
         part.setAll("scene", this);
         super.addChild(part);
+
     }
     addChildren(...parts: Part[]) {
         parts.forEach((part) => this.addChild(part));
     }
     act(delta: number) {
         if (!this.top) {
-            this.top?.warn(`Act called on Scene <${this.name}> without a top-level parent. Ensure this scene is added to a Game instance before calling act().`);
+            throw new Error(`Act called on Scene <${this.name}> without a top-level parent. Ensure this scene is added to a Game instance before calling act().`);
         }
 
         if (!this.top || !(this.top instanceof Game)) {