@combos-fun/engine 0.0.44 → 0.0.46

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/engine",
-  "version": "0.0.44",
+  "version": "0.0.46",
   "description": "ECS microkernel",
   "main": "index.js",
   "module": "dist/engine.esm.js",
@@ -45,7 +45,7 @@
     "lodash-es": "^4.17.21",
     "resource-loader": "^4.0.0-rc4",
     "sprite-timeline": "^1.10.2",
-    "@combos-fun/inspector-decorator": "0.0.44"
+    "@combos-fun/inspector-decorator": "0.0.46"
   },
   "devDependencies": {
     "tsx": "^4.20.3"

package/plugin-authoring.md

@@ -103,16 +103,17 @@ Extend `Renderer` from `plugin-renderer` with `@decorators.componentObserver`.
 
 ```ts
 class MyRenderer extends Renderer {
+  renderSystem: RendererSystem;
   init() {
-    this.rendererSystem = this.game.getSystem(RendererSystem);
-    this.rendererSystem.rendererManager.register(this);
+    this.renderSystem = this.game.getSystem(RendererSystem);
+    this.renderSystem.rendererManager.register(this);
   }
   componentChanged(changed: ComponentChanged) {
-    const container = this.rendererSystem.containerManager.getContainer(
+    const container = this.containerManager.getContainer(
       changed.gameObject.id,
     );
     switch (changed.type) {
-      case OBSERVER_TYPE.ADD: /* create pixi object, container.addChild(obj) */ break;
+      case OBSERVER_TYPE.ADD: /* subclass adapter: addChild(graphics); composition: addChild(sprite.sprite) */ break;
       case OBSERVER_TYPE.CHANGE: /* mutate */ break;
       case OBSERVER_TYPE.REMOVE: /* destroy + container.removeChild */ break;
     }
@@ -125,6 +126,8 @@ class MyRenderer extends Renderer {
 
 `RendererSystem` must be added before any system calling `getSystem(RendererSystem)` in `init`.
 
+`@combos-fun/renderer-adapter` has two patterns: subclass adapters (`Graphics`, `Text`, `NinePatch`, `Container`) **are** Pixi display objects (`addChild(graphics)`). Composition adapters (`Sprite`, `TilingSprite`, `SpriteAnimation`) are not — `addChild(sprite.sprite)` / `tilingSprite.tilingSprite` / `animatedSprite`. See `@combos-fun/renderer-adapter/agent-skill`.
+
 ## 3D Three.js `Renderer3D` subclass (`@combos-fun/plugin-renderer-3d`)
 
 Extend `Renderer3D` with `@decorators.componentObserver`.

package/references/public-api.md

@@ -8,6 +8,8 @@ Open only when the short `agent-skill` card is insufficient for a named symbol o
 
 `Game`, `Scene`, `GameObject`, `Component`, `System`, `Transform`, `resource`, `resourceLoader`, `decorators`, `IDEProp`, `componentObserver`, `LOAD_EVENT`, `RESOURCE_TYPE`, `OBSERVER_TYPE`, `LOAD_SCENE_MODE`, `RESOURCE_TYPE_STRATEGY`, `normalizeResourceSrc`, `normalizeSpritesheetData`, `version`, `COMBOS_GAME_PLUGIN_INIT_SUCCESS`, `COMBOS_GAME_READY`, `COMBOS_GAME_SET_PLAYING`, `COMBOS_GAME_STATE_CHANGED`, `postParentPluginInitSuccess`, `postParentGameReady`, `postParentGameState`, `parseSetPlayingMessage`, `DEFAULT_ALLOWED_MESSAGE_HOST_SUFFIXES`, `isAllowedMessageOrigin`, `mergeAllowedMessageOrigins`.
 
+`IDEProp` (this package) only pushes property **names** onto `constructor.IDEProps` as an **array**. New inspector / Scene Edit fields use `@Field` from `@combos-fun/inspector-decorator` (string key `IDE_PROPERTY_METADATA`). `plugin-development-tool` prefers `@Field`; it ignores the `IDEProp` array. Do not add `@IDEProp` on new components.
+
 ### Types
 
 `GameParams`, `PluginStruct`, `TransformParams`, `ComponentChanged`, `UpdateParams`, `ComponentParams`, `ObserverInfo`, `PureObserverInfo`, `ResourceBase`, `ResourceStruct`, `SystemConstructor`, `CombosGamePluginInitSuccessMessage`, `CombosGameReadyMessage`, `CombosGameStateChangedMessage`, `CombosGameSetPlayingMessage`.
@@ -64,7 +66,13 @@ Recommended flow: create the game with `autoStart:false`, wait for `combos-game:
 
 ### `Game` methods
 
-`addSystem(system)`, `removeSystem(system | class | string)` (calls `system.destroy()` internally), `getSystem(class | string)`, `loadScene({ scene, mode?, params? })` (`LOAD_SCENE_MODE.SINGLE | MULTI_CANVAS`), `start()`, `pause()`, `resume()`, `setPlaying(playing)` (host bridge: cold-start-or-resume / pause), `destroy()`.
+`addSystem` is **async** (`Promise<T | undefined>`): `await game.addSystem(new XxxSystem(params))`. Duplicate System classes are warned and skipped. `Game({ systems })` already awaits each `init` at bootstrap.
+
+A TypeScript overload also types `addSystem(XxxSystem, [params])`, but `Game.ts` does `new S(obj)` **without spreading**. That calls the constructor with the tuple as the first argument. Use the instance form.
+
+`removeSystem(system | class | string)` (calls `system.destroy()` internally), `getSystem(class | string)`, `loadScene({ scene, mode?, params? })` (`LOAD_SCENE_MODE.SINGLE | MULTI_CANVAS`), `start()`, `pause()`, `resume()`, `setPlaying(playing)` (host bridge: cold-start-or-resume / pause), `destroy()`.
+
+`getSystem` / `removeSystem` string lookup matches `static systemName` (copied onto `system.name` in the constructor), **not** the TypeScript class name. Prefer the class: `game.getSystem(ImgSystem)`. `game.getSystem('Img')` works; `game.getSystem('ImgSystem')` is undefined. 2D render plugins use short names (`'Img'`, `'Sprite'`, `'Event'`); most 3D / physics / audio systems use the class-shaped name (`'Renderer3DSystem'`, `'PhysicsSystem'`). `Transition` is `'transition'` (lowercase).
 
 ### `resource` singleton