@woosh/meep-engine 3.3.0 → 3.5.0

package/editor/process/SymbolicDisplayProcess.js

@@ -1,106 +1,106 @@
-import { assert } from "../../src/core/assert.js";
-import { Camera } from "../../src/engine/graphics/ecs/camera/Camera.js";
-import { Light } from "../../src/engine/graphics/ecs/light/Light.js";
-import {
-    ParticleEmitter
-} from "../../src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.js";
-import { SoundEmitter } from "../../src/engine/sound/ecs/emitter/SoundEmitter.js";
-import { EditorProcess } from "./EditorProcess.js";
-import { CameraSymbolicDisplay } from "./symbolic/CameraSymbolicDisplay.js";
-import { GridPositionSymbolicDisplay } from "./symbolic/GridPositionSymbolicDisplay.js";
-import { LightSymbolicDisplay } from "./symbolic/LightSymbolicDisplay.js";
-import {
-    ParticleEmitterSymbolicDisplay
-} from "./symbolic/ParticleEmitterSymbolicDisplay.js";
-import { PathSymbolicDisplay } from "./symbolic/PathSymbolicDisplay.js";
-import {
-    PositionedMarkerSymbolicDisplay
-} from "./symbolic/PositionedMarkerSymbolicDisplay.js";
-import { SoundEmitterSymbolicDisplay } from "./symbolic/SoundEmitterSymbolicDisplay.js";
-
-/**
- * Draws a symbol for everything in a level that has no picture of its own.
- *
- * **Immediate mode, and that is the whole of what this process now is.** Every display used to
- * build a helper entity per subject — a `Renderable` around a three `Object3D` (I-6's retirement
- * list), kept in step through signal bindings and torn down again by an observer when the component
- * went — which is why this process had to spawn a `RenderSystem` to draw at all and had to check
- * whether each display's component types were even registered before starting it. None of that
- * survives: the displays are asked once a frame what the scene looks like and answer with shapes
- * in {@link Gizmo}, and `DebugDrawSystem3` turns them into pixels.
- */
-class SymbolicDisplayProcess extends EditorProcess {
-    name = SymbolicDisplayProcess.Id;
-
-    /**
-     * @type {SymbolicDisplay[]}
-     */
-    displays = [];
-
-    /**
-     * @type {function}
-     */
-    #draw;
-
-    constructor() {
-        super();
-
-        this.#draw = () => this.#record();
-    }
-
-    /**
-     * @param {Editor} editor
-     */
-    initialize(editor) {
-        super.initialize(editor);
-
-        const engine = editor.engine;
-
-        assert.defined(engine, 'engine');
-
-        this.displays = [
-            // the four types that have somewhere to be but nothing to see; the colour is what
-            // tells them apart, so it is picked here rather than inside the display
-            new PositionedMarkerSymbolicDisplay(engine, ParticleEmitter, [1, 0.4, 1, 1]),
-            new PositionedMarkerSymbolicDisplay(engine, Camera, [0.4, 0.9, 1, 1]),
-            new PositionedMarkerSymbolicDisplay(engine, Light, [1, 0.9, 0.3, 1]),
-            new PositionedMarkerSymbolicDisplay(engine, SoundEmitter, [0.4, 1, 0.5, 1]),
-
-            new CameraSymbolicDisplay(engine),
-            new LightSymbolicDisplay(engine),
-            new GridPositionSymbolicDisplay(engine),
-            new PathSymbolicDisplay(engine),
-            new ParticleEmitterSymbolicDisplay(engine),
-            new SoundEmitterSymbolicDisplay(engine)
-        ];
-    }
-
-    startup() {
-        super.startup();
-
-        // per frame rather than per tick, for the reason the selection box is: the recording is
-        // cleared once the frame that consumed it has been submitted, and a frame can be drawn
-        // more than once between two ticks
-        this.editor.engine.graphics.on.preRender.add(this.#draw);
-    }
-
-    shutdown() {
-        super.shutdown();
-
-        this.editor.engine.graphics.on.preRender.remove(this.#draw);
-    }
-
-    #record() {
-        const dataset = this.editor.engine.entityManager.dataset;
-
-        const displays = this.displays;
-
-        for (let i = 0; i < displays.length; i++) {
-            displays[i].record(dataset);
-        }
-    }
-}
-
-SymbolicDisplayProcess.Id = 'symbolic-display-process';
-
-export { SymbolicDisplayProcess };
+import { assert } from "../../src/core/assert.js";
+import { Camera } from "../../src/engine/graphics/ecs/camera/Camera.js";
+import { Light } from "../../src/engine/graphics/ecs/light/Light.js";
+import {
+    ParticleEmitter
+} from "../../src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.js";
+import { AudioEmitter } from "../../src/engine/sound/ecs/audio/AudioEmitter.js";
+import { EditorProcess } from "./EditorProcess.js";
+import { AudioEmitterSymbolicDisplay } from "./symbolic/AudioEmitterSymbolicDisplay.js";
+import { CameraSymbolicDisplay } from "./symbolic/CameraSymbolicDisplay.js";
+import { GridPositionSymbolicDisplay } from "./symbolic/GridPositionSymbolicDisplay.js";
+import { LightSymbolicDisplay } from "./symbolic/LightSymbolicDisplay.js";
+import {
+    ParticleEmitterSymbolicDisplay
+} from "./symbolic/ParticleEmitterSymbolicDisplay.js";
+import { PathSymbolicDisplay } from "./symbolic/PathSymbolicDisplay.js";
+import {
+    PositionedMarkerSymbolicDisplay
+} from "./symbolic/PositionedMarkerSymbolicDisplay.js";
+
+/**
+ * Draws a symbol for everything in a level that has no picture of its own.
+ *
+ * **Immediate mode, and that is the whole of what this process now is.** Every display used to
+ * build a helper entity per subject — a `Renderable` around a three `Object3D` (I-6's retirement
+ * list), kept in step through signal bindings and torn down again by an observer when the component
+ * went — which is why this process had to spawn a `RenderSystem` to draw at all and had to check
+ * whether each display's component types were even registered before starting it. None of that
+ * survives: the displays are asked once a frame what the scene looks like and answer with shapes
+ * in {@link Gizmo}, and `DebugDrawSystem3` turns them into pixels.
+ */
+class SymbolicDisplayProcess extends EditorProcess {
+    name = SymbolicDisplayProcess.Id;
+
+    /**
+     * @type {SymbolicDisplay[]}
+     */
+    displays = [];
+
+    /**
+     * @type {function}
+     */
+    #draw;
+
+    constructor() {
+        super();
+
+        this.#draw = () => this.#record();
+    }
+
+    /**
+     * @param {Editor} editor
+     */
+    initialize(editor) {
+        super.initialize(editor);
+
+        const engine = editor.engine;
+
+        assert.defined(engine, 'engine');
+
+        this.displays = [
+            // the four types that have somewhere to be but nothing to see; the colour is what
+            // tells them apart, so it is picked here rather than inside the display
+            new PositionedMarkerSymbolicDisplay(engine, ParticleEmitter, [1, 0.4, 1, 1]),
+            new PositionedMarkerSymbolicDisplay(engine, Camera, [0.4, 0.9, 1, 1]),
+            new PositionedMarkerSymbolicDisplay(engine, Light, [1, 0.9, 0.3, 1]),
+            new PositionedMarkerSymbolicDisplay(engine, AudioEmitter, [0.4, 1, 0.5, 1]),
+
+            new CameraSymbolicDisplay(engine),
+            new LightSymbolicDisplay(engine),
+            new GridPositionSymbolicDisplay(engine),
+            new PathSymbolicDisplay(engine),
+            new ParticleEmitterSymbolicDisplay(engine),
+            new AudioEmitterSymbolicDisplay(engine)
+        ];
+    }
+
+    startup() {
+        super.startup();
+
+        // per frame rather than per tick, for the reason the selection box is: the recording is
+        // cleared once the frame that consumed it has been submitted, and a frame can be drawn
+        // more than once between two ticks
+        this.editor.engine.graphics.on.preRender.add(this.#draw);
+    }
+
+    shutdown() {
+        super.shutdown();
+
+        this.editor.engine.graphics.on.preRender.remove(this.#draw);
+    }
+
+    #record() {
+        const dataset = this.editor.engine.entityManager.dataset;
+
+        const displays = this.displays;
+
+        for (let i = 0; i < displays.length; i++) {
+            displays[i].record(dataset);
+        }
+    }
+}
+
+SymbolicDisplayProcess.Id = 'symbolic-display-process';
+
+export { SymbolicDisplayProcess };

package/editor/process/symbolic/{SoundEmitterSymbolicDisplay.js → AudioEmitterSymbolicDisplay.js}

@@ -1,57 +1,67 @@
-import { Transform } from "../../../src/engine/ecs/transform/Transform.js";
-import { Gizmo } from "../../../src/engine/graphics/render/gizmo/Gizmo.js";
-import { SoundEmitter } from "../../../src/engine/sound/ecs/emitter/SoundEmitter.js";
-import { entity_is_editor_owned, SymbolicDisplay } from "./SymbolicDisplay.js";
-
-/**
- * Inside this one an emitter is at full volume.
- *
- * @type {number[]}
- */
-const NEAR_COLOR = [1, 0.67, 0, 1];
-
-/**
- * Outside this one it is inaudible.
- *
- * @type {number[]}
- */
-const FAR_COLOR = [1, 1, 0, 0.5];
-
-/**
- * @type {Float32Array}
- */
-const scratch_center = new Float32Array(3);
-
-/**
- * The two distances a sound emitter rolls off between.
- *
- * The same pair of spheres the three version drew and the same two colours, because what they mean
- * is the attenuation model rather than anything about a renderer: inside the near one there is no
- * attenuation, past the far one there is no sound.
- *
- * @see SymbolicDisplay
- */
-export class SoundEmitterSymbolicDisplay extends SymbolicDisplay {
-    /**
-     * @param {EntityComponentDataset} dataset
-     */
-    record(dataset) {
-        dataset.traverseEntities([SoundEmitter, Transform], (emitter, transform, entity) => {
-            if (entity_is_editor_owned(dataset, entity)) {
-                return;
-            }
-
-            const position = transform.position;
-
-            scratch_center[0] = position.x;
-            scratch_center[1] = position.y;
-            scratch_center[2] = position.z;
-
-            Gizmo.color = NEAR_COLOR;
-            Gizmo.draw_wire_sphere(scratch_center, emitter.distanceMin);
-
-            Gizmo.color = FAR_COLOR;
-            Gizmo.draw_wire_sphere(scratch_center, emitter.distanceMax);
-        });
-    }
-}
+import { Transform } from "../../../src/engine/ecs/transform/Transform.js";
+import { Gizmo } from "../../../src/engine/graphics/render/gizmo/Gizmo.js";
+import { AudioEmitter } from "../../../src/engine/sound/ecs/audio/AudioEmitter.js";
+import { entity_is_editor_owned, SymbolicDisplay } from "./SymbolicDisplay.js";
+
+/**
+ * Inside this one an emitter is at full volume.
+ *
+ * @type {number[]}
+ */
+const NEAR_COLOR = [1, 0.67, 0, 1];
+
+/**
+ * Outside this one it is inaudible.
+ *
+ * @type {number[]}
+ */
+const FAR_COLOR = [1, 1, 0, 0.5];
+
+/**
+ * @type {Float32Array}
+ */
+const scratch_center = new Float32Array(3);
+
+/**
+ * The two distances a native audio emitter rolls off between.
+ *
+ * The same pair of spheres and the same two colours the three version drew, because what they mean is
+ * the attenuation model rather than anything about a component or a renderer: inside the near one there
+ * is no attenuation, past the far one there is no sound.
+ *
+ * Only drawn for a 3D event. A 2D one is position-independent — it sounds the same wherever the
+ * entity is — so its distance pair is inert data and drawing it would claim a rolloff that is not
+ * there.
+ *
+ * @see SymbolicDisplay
+ */
+export class AudioEmitterSymbolicDisplay extends SymbolicDisplay {
+    /**
+     * @param {EntityComponentDataset} dataset
+     */
+    record(dataset) {
+        dataset.traverseEntities([AudioEmitter, Transform], (emitter, transform, entity) => {
+            if (entity_is_editor_owned(dataset, entity)) {
+                return;
+            }
+
+            const event = emitter.event;
+
+            if (!event.is3D) {
+                return;
+            }
+
+            const position = transform.position;
+
+            scratch_center[0] = position.x;
+            scratch_center[1] = position.y;
+            scratch_center[2] = position.z;
+
+            Gizmo.color = NEAR_COLOR;
+            Gizmo.draw_wire_sphere(scratch_center, event.distanceMin);
+
+            Gizmo.color = FAR_COLOR;
+            Gizmo.draw_wire_sphere(scratch_center, event.distanceMax);
+        });
+    }
+}

package/package.json

@@ -1,94 +1,94 @@
-{
-  "name": "@woosh/meep-engine",
-  "license": "SEE LICENSE IN LICENSE",
-  "productName": "Meep",
-  "homepage": "https://meep.company-named.com/",
-  "description": "Pure JavaScript game engine. Fully featured and production ready.",
-  "type": "module",
-  "author": "Alexander Goldring",
-  "version": "3.3.0",
-  "exports": {
-    "./build/*": "./build/*",
-    "./src/*": "./src/*",
-    "./editor/*": "./editor/*",
-    "./*.md": "./*.md"
-  },
-  "sideEffects": [
-    "**/*.css",
-    "**/*.scss"
-  ],
-  "scripts": {
-    "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=junit.xml",
-    "build-module": "rollup -c rollup.config.js",
-    "publish-npm": "npm publish",
-    "generate-types": "npx -p typescript tsc --project tsconfig.types.json || exit 0;",
-    "test": "vitest run"
-  },
-  "browserslist": [
-    "last 2 chrome version",
-    "last 2 firefox version",
-    "last 2 safari version"
-  ],
-  "files": [
-    "build",
-    "src",
-    "editor",
-    "samples",
-    "package.json",
-    "README.md",
-    "!src/**/*.spec.js",
-    "!editor/**/*.spec.js"
-  ],
-  "dependencies": {
-    "opentype.js": "1.3.3",
-    "pako": "2.0.3",
-    "robust-predicates": "3.0.2"
-  },
-  "peerDependencies": {
-    "dat.gui": ">=0.7.0",
-    "stats.js": ">=0.17.0"
-  },
-  "peerDependenciesMeta": {
-    "stats.js": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "25.0.2",
-    "@rollup/plugin-node-resolve": "15.1.0",
-    "@rollup/plugin-strip": "3.0.2",
-    "@rollup/plugin-terser": "0.4.3",
-    "@vitest/coverage-v8": "^4.1.10",
-    "jsdom": "^30.0.1",
-    "rollup": "3.26.2",
-    "typescript": "5.2.2",
-    "vitest": "^4.1.10",
-    "web-tree-sitter": "^0.26.12"
-  },
-  "keywords": [
-    "game-engine",
-    "gamedev",
-    "ecs",
-    "entity-component-system",
-    "data-oriented",
-    "zero-allocation",
-    "modular",
-    "tree-shaking",
-    "3d",
-    "webgl",
-    "webgl2",
-    "webgpu",
-    "webaudio",
-    "particles",
-    "bvh",
-    "behavior-tree",
-    "inverse-kinematics",
-    "fabrik",
-    "clustered-lighting",
-    "color-management",
-    "typescript"
-  ],
-  "engines": {
-    "node": ">=24"
-  }
-}
+{
+  "name": "@woosh/meep-engine",
+  "license": "SEE LICENSE IN LICENSE",
+  "productName": "Meep",
+  "homepage": "https://meep.company-named.com/",
+  "description": "Pure JavaScript game engine. Fully featured and production ready.",
+  "type": "module",
+  "author": "Alexander Goldring",
+  "version": "3.5.0",
+  "exports": {
+    "./build/*": "./build/*",
+    "./src/*": "./src/*",
+    "./editor/*": "./editor/*",
+    "./*.md": "./*.md"
+  },
+  "sideEffects": [
+    "**/*.css",
+    "**/*.scss"
+  ],
+  "scripts": {
+    "test:ci": "vitest run --coverage --reporter=default --reporter=junit --outputFile=junit.xml",
+    "build-module": "rollup -c rollup.config.js",
+    "publish-npm": "npm publish",
+    "generate-types": "npx -p typescript tsc --project tsconfig.types.json || exit 0;",
+    "test": "vitest run",
+    "dev": "vite"
+  },
+  "browserslist": [
+    "last 2 chrome version",
+    "last 2 firefox version",
+    "last 2 safari version"
+  ],
+  "files": [
+    "build",
+    "src",
+    "editor",
+    "samples",
+    "package.json",
+    "README.md",
+    "!src/**/*.spec.js",
+    "!editor/**/*.spec.js"
+  ],
+  "dependencies": {
+    "opentype.js": "1.3.3",
+    "pako": "2.0.3",
+    "robust-predicates": "3.0.2"
+  },
+  "peerDependencies": {
+    "dat.gui": ">=0.7.0",
+    "stats.js": ">=0.17.0"
+  },
+  "peerDependenciesMeta": {
+    "stats.js": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "25.0.2",
+    "@rollup/plugin-node-resolve": "15.1.0",
+    "@rollup/plugin-strip": "3.0.2",
+    "@rollup/plugin-terser": "0.4.3",
+    "@vitest/coverage-v8": "^4.1.10",
+    "jsdom": "^30.0.1",
+    "rollup": "3.26.2",
+    "typescript": "5.2.2",
+    "vite": "^8.2.2",
+    "vitest": "^4.1.10",
+    "web-tree-sitter": "^0.26.12"
+  },
+  "keywords": [
+    "game-engine",
+    "gamedev",
+    "ecs",
+    "entity-component-system",
+    "data-oriented",
+    "zero-allocation",
+    "modular",
+    "tree-shaking",
+    "3d",
+    "webgpu",
+    "webaudio",
+    "particles",
+    "bvh",
+    "behavior-tree",
+    "inverse-kinematics",
+    "fabrik",
+    "clustered-lighting",
+    "color-management",
+    "typescript"
+  ],
+  "engines": {
+    "node": ">=24"
+  }
+}