@combos-fun/plugin-renderer-event 0.0.45 → 0.0.46

package/agent-skill.md

@@ -1,12 +1,6 @@
 # `@combos-fun/plugin-renderer-event` — Agent notes
 
-Pointer / touch event input for the 2D pipeline via Pixi v8 interaction. Provides hit-area shapes and a unified `tap` / `touchstart` / `touchmove` / `touchend` event surface on the `Event` Component.
-
-## When to read
-
-Read for any input task: tap detection, drag, swipe, hit-area shapes, or when integrating with `plugin-a11y` (which forwards DOM clicks as Event events).
-
-## Public API
+Read only for 2D pointer/touch input, hit areas, dragging, or a11y-forwarded activation.
 
 ```ts
 import {
@@ -18,80 +12,31 @@ import {
 } from '@combos-fun/plugin-renderer-event';
 ```
 
-`componentName = 'Event'`, `systemName = 'Event'` (class is `EventSystem` — use `game.getSystem(EventSystem)`, not the string).
+`Event.componentName = 'Event'`; `EventSystem.systemName = 'Event'`.
 
-### `HIT_AREA_TYPE`
+`HIT_AREA_TYPE` is `Circle | Ellipse | Polygon | Rect | RoundedRect`. `EventParams.hitArea` is required; pass a concrete local-space `style` even though its type is optional because the system reads shape fields directly. Circle uses `x/y/radius`; Ellipse and Rect use `x/y/width/height`; RoundedRect also uses `radius`; Polygon uses flat `paths`.
 
-`Circle`, `Ellipse`, `Polygon`, `Rect`, `RoundedRect`.
+`EventSystemParams.moveWhenInside` defaults to `false`. It sets Pixi `globalMove = !moveWhenInside`, so `true` limits move events to the pointer being inside.
 
-### `EventParams`
+Emitted events are `touchstart`, `touchmove`, `touchend`, `tap`, `touchendoutside`, and `touchcancel`. Every callback receives:
 
 ```ts
 {
-  hitArea: {
-    type: HIT_AREA_TYPE;
-    style?: { x?, y?, radius?, width?, height?, paths? };
-  };
+  stopPropagation: () => void,
+  data: {
+    pointerId: number,
+    position: { x: number, y: number },      // global/canvas space
+    localPosition: { x: number, y: number } // GameObject container space
+  },
+  gameObject
 }
 ```
 
-### `EventSystemParams`
-
-| Field | Type | Notes |
-|-------|------|-------|
-| `moveWhenInside` | `boolean?` | Drives Pixi `events.features.globalMove` |
-
-### Events emitted by the `Event` component
-
-`touchstart`, `touchmove`, `touchend`, `tap`, `touchendoutside`, `touchcancel`.
-
-Callback payload:
-
 ```ts
-(payload) => {
-  payload.stopPropagation();
-  payload.data.pointerId;
-  payload.data.position;        // global / canvas-space
-  payload.data.localPosition;   // local to the GameObject
-  payload.gameObject;
-};
-```
-
-## Required setup
-
-- Add `RendererSystem` (from `plugin-renderer`) before `EventSystem`.
-- Provide `hitArea.style` in the same coordinate space as the visual:
-  `style` is interpreted in **local space** of the GameObject.
-
-## Runtime behaviour
-
-- Each `Event` component installs a Pixi hit-area on its container; the
-  system routes Pixi pointer events into Combos events.
-- `plugin-a11y` forwards DOM clicks on the a11y overlay as
-  `touchstart` / `touchend` / `tap` on the matching `Event` component.
-
-## Common pitfalls
-
-| Symptom | Fix |
-|---------|-----|
-| `tap` never fires | Add `EventSystem`, attach an `Event` component with a `hitArea` |
-| Hit area off-target | `style` coords are in local space — origin is the GameObject's `Transform.origin` |
-| Double-fire from a11y + canvas | Only attach handler once; A11y forwards through Event so a single subscription is enough |
-
-## Minimal example
-
-```ts
-import { Event, HIT_AREA_TYPE } from '@combos-fun/plugin-renderer-event';
-
 go.addComponent(new Event({
-  hitArea: { type: HIT_AREA_TYPE.Rect, style: { width: 200, height: 80 } },
+  hitArea: { type: HIT_AREA_TYPE.Rect, style: { x: 0, y: 0, width: 200, height: 80 } },
 }));
-
-go.getComponent(Event)!.on('tap', (e) => {
-  /* handle */
-});
+go.getComponent(Event)!.on('tap', ({ stopPropagation }) => stopPropagation());
 ```
 
-## Verification
-
-`pnpm --filter @combos-fun/plugin-renderer-event run build`.
+`plugin-a11y` forwards its DOM activation through this same Event Component, so subscribe once rather than adding a second a11y-specific action handler.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combos-fun/plugin-renderer-event",
-  "version": "0.0.45",
+  "version": "0.0.46",
   "description": "Pointer / touch event input via Pixi v8 interaction",
   "main": "index.js",
   "module": "dist/plugin-renderer-event.esm.js",
@@ -37,8 +37,8 @@
   "author": "sun668 <q947692259@gmail.com>",
   "dependencies": {
     "pixi.js": "^8.18.1",
-    "@combos-fun/plugin-renderer": "0.0.45",
-    "@combos-fun/engine": "0.0.45"
+    "@combos-fun/plugin-renderer": "0.0.46",
+    "@combos-fun/engine": "0.0.46"
   },
   "scripts": {
     "build": "node ../../scripts/build-package.mjs"