@combos-fun/engine 0.0.53 → 0.2.0

package/agent-skill.md

@@ -8,7 +8,7 @@ Read when starting an engine task or resolving an engine API/lifecycle question.
 
 ## Microkernel model
 
-- Core: `Game`, `Scene`, `GameObject`, `Component`, `System`, `Transform`, `resource`, `decorators`; rendering, physics, and audio come from plugins.
+- Core: `Game`, `Scene`, `GameObject`, `Component`, `System`, `resource`, `decorators`. Hierarchy is `GameObject.parent` / `children` / `addChild`. 2D pose is `Transform2D` in `@combos-fun/plugin-renderer`; 3D pose is `Transform3D` in `@combos-fun/plugin-renderer-3d`.
 - Register an instance with `await game.addSystem(new XxxSystem(...))`; `Game({ systems })` awaits each system's `init`. Avoid `addSystem(XxxSystem, [params])`: runtime passes the tuple as one constructor argument.
 - Observe components with `@decorators.componentObserver({ Name: ['prop'] })`, then drain `componentObserver.clear()` in `update()`.
 - Frame order: all `Component.update` → all `Component.lateUpdate` → all `System.update` → all `System.lateUpdate`. `start()` runs on the first update tick.

package/combos-plugin.json

@@ -12,7 +12,6 @@
     "GameObject",
     "Component",
     "System",
-    "Transform",
     "resource",
     "decorators",
     "OBSERVER_TYPE",

package/dist/engine.cjs.js

@@ -2,8 +2,6 @@
 
 var EventEmitter = require('eventemitter3');
 var lodashEs = require('lodash-es');
-var tslib = require('tslib');
-var inspectorDecorator = require('@combos-fun/inspector-decorator');
 var resourceLoader$1 = require('resource-loader');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
@@ -16,10 +14,10 @@ var EventEmitter__default = /*#__PURE__*/_interopDefault(EventEmitter);
  * @returns component' name
  * @example
  * ```typescript
- * import { Transform } from '@combos-fun/engine'
+ * import { Component } from '@combos-fun/engine'
  *
- * assert(getComponentName(Transform) === 'Transform')
- * assert(getComponentName(new Transform()) === 'Transform')
+ * assert(getComponentName(MyComponent) === 'MyComponent')
+ * assert(getComponentName(new MyComponent()) === 'MyComponent')
  * ```
  */
 function getComponentName(component) {
@@ -114,14 +112,38 @@ function removeObjectCache(component) {
  * @param {pureObserverProp} param0.prop - pure observer prop
  * @param {ObserverType} param0.type - observer type
  */
-function addObserver({ systemName, componentName, component, prop, type }) {
+function addObserver({ systemName, componentName, component, prop, type, gameObject }) {
     systemInstance[systemName]?.componentObserver?.add({
         component,
         prop,
         type,
         componentName,
+        gameObject,
     });
 }
+const GAME_OBJECT_OBSERVER = 'GameObject';
+/**
+ * Push a GameObject field change (parent / inScene) to systems that observe `GameObject`.
+ * Hierarchy is not a Component; callers must notify explicitly from addChild / scene.
+ */
+function notifyGameObjectProp(gameObject, propName, type = exports.OBSERVER_TYPE.CHANGE) {
+    if (!gameObject)
+        return;
+    const prop = { prop: [propName], deep: false };
+    for (const systemName in observerInfos) {
+        const info = observerInfos[systemName]?.[GAME_OBJECT_OBSERVER];
+        if (!info?.some(p => p.prop[0] === propName))
+            continue;
+        addObserver({
+            systemName,
+            componentName: GAME_OBJECT_OBSERVER,
+            component: undefined,
+            gameObject,
+            prop,
+            type,
+        });
+    }
+}
 function pushToQueue({ prop, component, componentName, }) {
     for (const systemName in observerInfos) {
         const observerInfo = observerInfos[systemName] || {};
@@ -297,154 +319,6 @@ function setSystemObserver(system, S) {
     systemInstance[S.systemName] = system;
 }
 
-/** Basic component for gameObject, See {@link TransformParams}  */
-class Transform extends Component {
-    constructor() {
-        super(...arguments);
-        this.name = 'Transform';
-        this._parent = null;
-        /** Whether this transform in a scene object */
-        this.inScene = false;
-        /** Child transform components */
-        this.children = [];
-        this.position = { x: 0, y: 0 };
-        this.size = { width: 0, height: 0 };
-        this.origin = { x: 0, y: 0 };
-        this.anchor = { x: 0, y: 0 };
-        this.scale = { x: 1, y: 1 };
-        this.skew = { x: 0, y: 0 };
-        this.rotation = 0;
-    }
-    /**
-     * component's name
-     * @readonly
-     */
-    static { this.componentName = 'Transform'; }
-    /**
-     * Init component
-     * @param params - Transform init data
-     */
-    init(params = {}) {
-        const props = ['position', 'size', 'origin', 'anchor', 'scale', 'skew'];
-        for (const key of props) {
-            Object.assign(this[key], params[key]);
-        }
-        this.rotation = params.rotation ?? this.rotation;
-    }
-    set parent(val) {
-        if (val) {
-            val.addChild(this);
-        }
-        else if (this.parent) {
-            this.parent.removeChild(this);
-        }
-    }
-    /**
-     * Get parent of this component
-     */
-    get parent() {
-        return this._parent;
-    }
-    /**
-     * Add Child Transform
-     * @remarks
-     * If `child` is already a child of this component, `child` will removed to the last of children list
-     * If `child` is already a child of other component, `child` will removed from its parent first
-     * @param child - child gameObject's transform component
-     */
-    addChild(child) {
-        if (child.parent === this) {
-            const index = this.children.findIndex(item => item === child);
-            this.children.splice(index, 1);
-        }
-        else if (child.parent) {
-            child.parent.removeChild(child);
-        }
-        child._parent = this;
-        this.children.push(child);
-    }
-    /**
-     * Remove child transform
-     * @param child - child gameObject's transform component
-     */
-    removeChild(child) {
-        const index = this.children.findIndex(item => item === child);
-        if (index > -1) {
-            this.children.splice(index, 1);
-            child._parent = null;
-        }
-    }
-    /** Clear all child transform */
-    clearChildren() {
-        this.children.length = 0;
-    }
-}
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'vector2',
-        step: 1,
-        group: 'Transform',
-        label: 'Position',
-        description: 'Position on the design canvas (x right, y down).',
-    })
-], Transform.prototype, "position", void 0);
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'size',
-        step: 1,
-        min: 0,
-        group: 'Transform',
-        label: 'Size',
-        description: 'Width and height of the object in design pixels.',
-    })
-], Transform.prototype, "size", void 0);
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'vector2',
-        step: 0.1,
-        group: 'Transform',
-        label: 'Origin',
-        description: 'Local origin used for layout math.',
-    })
-], Transform.prototype, "origin", void 0);
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'vector2',
-        step: 0.1,
-        group: 'Transform',
-        label: 'Anchor',
-        description: 'Anchor point (0–1) used when positioning and scaling.',
-    })
-], Transform.prototype, "anchor", void 0);
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'vector2',
-        step: 0.1,
-        group: 'Transform',
-        label: 'Scale',
-        description: 'Scale multipliers on X and Y (1 = original size).',
-    })
-], Transform.prototype, "scale", void 0);
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'vector2',
-        step: 0.1,
-        group: 'Transform',
-        label: 'Skew',
-        description: 'Skew amounts on X and Y.',
-    })
-], Transform.prototype, "skew", void 0);
-tslib.__decorate([
-    inspectorDecorator.Field({
-        type: 'number',
-        step: 0.1,
-        group: 'Transform',
-        label: 'Rotation',
-        description: 'Rotation in radians.',
-        editor: 'number-stepper',
-    })
-], Transform.prototype, "rotation", void 0);
-
 let _id = 0;
 /** Generate unique id for gameObject */
 function getId() {
@@ -456,28 +330,23 @@ function getId() {
  */
 class GameObject {
     /**
-     * Consruct a new gameObject
+     * Construct a new gameObject
      * @param name - the name of this gameObject
-     * @param obj - optional transform parameters for default Transform component
      */
-    constructor(name, obj) {
+    constructor(name) {
+        this._parent = null;
         /** A key-value map for components on this gameObject */
         this._componentCache = {};
+        /** Child gameObjects in sibling order */
+        this.children = [];
+        /** Whether this gameObject is registered on a scene */
+        this.inScene = false;
         /** Components apply to this gameObject */
         this.components = [];
         /** GameObject has been destroyed */
         this.destroyed = false;
         this._name = name;
         this.id = getId();
-        this.addComponent(Transform, obj);
-    }
-    /**
-     * Get default transform component
-     * @returns transform component on this gameObject
-     * @readonly
-     */
-    get transform() {
-        return this.getComponent(Transform);
     }
     /**
      * Get parent gameObject
@@ -485,7 +354,7 @@ class GameObject {
      * @readonly
      */
     get parent() {
-        return this.transform && this.transform.parent && this.transform.parent.gameObject;
+        return this._parent;
     }
     /**
      * Get the name of this gameObject
@@ -499,10 +368,8 @@ class GameObject {
             return;
         const scene = this._scene;
         this._scene = val;
-        if (this.transform && this.transform.children) {
-            for (const child of this.transform.children) {
-                child.gameObject.scene = val;
-            }
+        for (const child of this.children) {
+            child.scene = val;
         }
         if (val) {
             val.addGameObject(this);
@@ -524,16 +391,28 @@ class GameObject {
      * @param gameObject - child gameobject
      */
     addChild(gameObject) {
-        if (!gameObject || !gameObject.transform || gameObject === this)
+        if (!gameObject || gameObject === this)
             return;
         if (!(gameObject instanceof GameObject)) {
             throw new Error('addChild only receive GameObject');
         }
-        if (!this.transform) {
+        if (this.destroyed) {
             throw new Error(`gameObject '${this.name}' has been destroy`);
         }
-        gameObject.transform.parent = this.transform;
+        if (gameObject.parent === this) {
+            const index = this.children.indexOf(gameObject);
+            if (index > -1)
+                this.children.splice(index, 1);
+            this.children.push(gameObject);
+            return;
+        }
+        if (gameObject.parent) {
+            gameObject.parent.removeChild(gameObject);
+        }
+        gameObject._parent = this;
+        this.children.push(gameObject);
         gameObject.scene = this.scene;
+        notifyGameObjectProp(gameObject, 'parent', exports.OBSERVER_TYPE.CHANGE);
     }
     /**
      * Remove child gameObject
@@ -543,8 +422,12 @@ class GameObject {
         if (!(gameObject instanceof GameObject) || !gameObject.parent || gameObject.parent !== this) {
             return gameObject;
         }
-        gameObject.transform.parent = null;
+        const index = this.children.indexOf(gameObject);
+        if (index > -1)
+            this.children.splice(index, 1);
+        gameObject._parent = null;
         gameObject.scene = null;
+        notifyGameObjectProp(gameObject, 'parent', exports.OBSERVER_TYPE.CHANGE);
         return gameObject;
     }
     addComponent(C, obj) {
@@ -586,9 +469,6 @@ class GameObject {
         else if (c.componentName) {
             componentName = c.componentName;
         }
-        if (componentName === 'Transform') {
-            throw new Error("Transform can't be removed");
-        }
         return this._removeComponent(componentName);
     }
     _removeComponent(componentName) {
@@ -631,15 +511,15 @@ class GameObject {
     }
     /** Destroy this gameObject */
     destroy() {
-        if (!this.transform) {
+        if (this.destroyed) {
             console.error('Cannot destroy gameObject that have already been destroyed.');
             return;
         }
-        Array.from(this.transform.children).forEach(({ gameObject }) => {
-            gameObject.destroy();
+        Array.from(this.children).forEach(child => {
+            child.destroy();
         });
         this.remove();
-        this.transform.clearChildren();
+        this.children.length = 0;
         for (const key in this._componentCache) {
             this._removeComponent(key);
         }
@@ -671,22 +551,30 @@ class ComponentObserver {
      * @param type - change event type
      * @param componentName - `component.name` this parameter will deprecated
      */
-    add({ component, prop, type, componentName }) {
+    add({ component, prop, type, componentName, gameObject }) {
+        const go = gameObject ?? component?.gameObject;
         if (type === exports.OBSERVER_TYPE.REMOVE) {
-            if (this.events.find((changed) => changed.component === component && changed.type === exports.OBSERVER_TYPE.ADD)) {
-                this.events = this.events.filter(changed => changed.component !== component);
+            const sameTarget = (changed) => component
+                ? changed.component === component
+                : changed.gameObject === go && changed.componentName === componentName;
+            if (this.events.find(changed => sameTarget(changed) && changed.type === exports.OBSERVER_TYPE.ADD)) {
+                this.events = this.events.filter(changed => !sameTarget(changed));
                 return;
             }
-            this.events = this.events.filter(changed => changed.component !== component);
+            this.events = this.events.filter(changed => !sameTarget(changed));
         }
-        const index = this.events.findIndex(changed => changed.component === component && lodashEs.isEqual(changed.prop, prop) && changed.type === type);
+        const index = this.events.findIndex(changed => changed.gameObject === go &&
+            changed.component === component &&
+            changed.componentName === componentName &&
+            lodashEs.isEqual(changed.prop, prop) &&
+            changed.type === type);
         if (index > -1) {
             this.events.splice(index, 1);
         }
         this.events.push({
-            gameObject: component.gameObject,
+            gameObject: go,
             component,
-            prop: prop,
+            prop,
             type,
             componentName,
         });
@@ -961,8 +849,8 @@ class Ticker {
  * Scene is a gameObject container
  */
 class Scene extends GameObject {
-    constructor(name, obj) {
-        super(name, obj);
+    constructor(name) {
+        super(name);
         this.gameObjects = [];
         this.scene = this; // gameObject.scene = this
     }
@@ -972,9 +860,10 @@ class Scene extends GameObject {
      */
     addGameObject(gameObject) {
         this.gameObjects.push(gameObject);
-        if (gameObject.transform) {
-            gameObject.transform.inScene = true;
-        }
+        if (gameObject.inScene)
+            return;
+        gameObject.inScene = true;
+        notifyGameObjectProp(gameObject, 'inScene', exports.OBSERVER_TYPE.CHANGE);
     }
     /**
      * Remove gameObject
@@ -984,8 +873,9 @@ class Scene extends GameObject {
         const index = this.gameObjects.indexOf(gameObject);
         if (index === -1)
             return;
-        if (gameObject.transform) {
-            gameObject.transform.inScene = false;
+        if (gameObject.inScene) {
+            gameObject.inScene = false;
+            notifyGameObjectProp(gameObject, 'inScene', exports.OBSERVER_TYPE.CHANGE);
         }
         this.gameObjects.splice(index, 1);
     }
@@ -1001,7 +891,7 @@ class Scene extends GameObject {
 }
 
 /** Generated at build from package.json */
-const version = "0.0.53";
+const version = "0.2.0";
 
 /**
  * Sent to `window.parent` after each `System.init` completes during `Game.addSystem`
@@ -2188,7 +2078,6 @@ exports.IDEProp = IDEProp;
 exports.RESOURCE_TYPE_STRATEGY = RESOURCE_TYPE_STRATEGY;
 exports.Scene = Scene;
 exports.System = System;
-exports.Transform = Transform;
 exports.componentObserver = componentObserver;
 exports.decorators = decorators;
 exports.isAllowedMessageOrigin = isAllowedMessageOrigin;