@ignifx/editor-host 0.17.0 → 0.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ignifx/editor-host",
3
- "version": "0.17.0",
3
+ "version": "0.18.0",
4
4
  "description": "ignifx editor host: runs a project's own engine inside the ignifx editor's scene view and play view, over a versioned protocol.",
5
5
  "keywords": [
6
6
  "ignifx"
@@ -52,19 +52,19 @@
52
52
  "typescript-native": "npm:typescript@7.0.2",
53
53
  "vite": "^8.2.2",
54
54
  "vitest": "^5.0.0",
55
- "@ignifx/2d": "0.17.0",
56
- "@ignifx/3d": "0.17.0",
57
- "@ignifx/core": "0.17.0",
58
- "@ignifx/input": "0.17.0",
59
- "@ignifx/physics": "0.17.0",
60
- "@ignifx/physics-2d": "0.17.0",
61
- "@ignifx/vite-plugin": "0.17.0"
55
+ "@ignifx/2d": "0.18.0",
56
+ "@ignifx/3d": "0.18.0",
57
+ "@ignifx/core": "0.18.0",
58
+ "@ignifx/input": "0.18.0",
59
+ "@ignifx/physics": "0.18.0",
60
+ "@ignifx/physics-2d": "0.18.0",
61
+ "@ignifx/vite-plugin": "0.18.0"
62
62
  },
63
63
  "peerDependencies": {
64
64
  "@babylonjs/lite": "1.34.0",
65
65
  "vite": "^8.2.2",
66
- "@ignifx/core": "0.17.0",
67
- "@ignifx/vite-plugin": "0.17.0"
66
+ "@ignifx/core": "0.18.0",
67
+ "@ignifx/vite-plugin": "0.18.0"
68
68
  },
69
69
  "peerDependenciesMeta": {
70
70
  "@ignifx/vite-plugin": {
@@ -3,7 +3,7 @@ name: editor-host
3
3
  description: Connects an ignifx project to the ignifx editor with @ignifx/editor-host: the Vite plugin that serves the editor's scene view from the project's own dev server, the virtual:ignifx/editor play controls a game's main.ts hands its app to (play, pause, step, stop, playState, playStateChanged, playStats, screenshot, queryRuntime, sendInput), and the host half of the editor protocol 0.3 over a MessagePort (hello/ready, heartbeat, and the scene document methods openScene, applyOps, readBack, select, pick, frame, setGizmo, setViewMode, screenshot, getSchemas, describeSettings, setAnimateMaterials, getColliderOutlines, sampleAnimation, sampleSpriteAnimation), including the 2D view mode. Use when wiring a project or template for the editor, when the user mentions @ignifx/editor-host, editorHostPlugin, attachEditorPlayControls, virtual:ignifx/editor, startEditorHost or /__ignifx_editor__/, or when debugging why the editor cannot connect to a view or why the scene view disagrees with the editor's document.
4
4
  license: Apache-2.0
5
5
  metadata:
6
- ignifx-version: "0.17.0"
6
+ ignifx-version: "0.18.0"
7
7
  ---
8
8
 
9
9
  # @ignifx/editor-host
@@ -25,7 +25,7 @@ editor's, even though its name starts with `editor-`.
25
25
 
26
26
  ## Environment
27
27
 
28
- - Engine: ignifx `0.17.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
28
+ - Engine: ignifx `0.18.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
29
29
  - Peers: `@ignifx/core` and `@babylonjs/lite` (the scene view's gizmos); for the `./vite` entry,
30
30
  `@ignifx/vite-plugin` and `vite`.
31
31
  - A development dependency of the project, at the same version as its `@ignifx/core`.
@@ -393,10 +393,13 @@ object `openScene` sends, through `world.loadSceneFile`; `readBack` answers with
393
393
  - **The grid.** With a canvas the scene host lists the `grid` capability and draws a grid: a
394
394
  ground grid at `y = 0` in 3D view mode (depth-tested, centred under the eye, coarser the higher
395
395
  the eye, faded out before its edge) and a faint grid over the 2D view (one line per layer pixel
396
- from zoom 8). `setGrid { visible?, size? }` sets the whole grid each call; a field left out takes
396
+ from zoom 8). `setGrid { visible?, size?, overlay?, height? }` sets the whole grid each call; a field left out takes
397
397
  its default (`visible: true`, `size: 1` metre, 0.001 to 1000). The grid starts visible at every
398
398
  load, so re-send the editor's state after `ready`. It is never picked or saved, and never in the
399
- play view; `screenshot` includes it while it is visible.
399
+ play view; `screenshot` includes it while it is visible. With the `gridOverlay` capability,
400
+ `setGrid` also takes `overlay` (default `false`: the 3D grid draws over the scene, fainter, so a
401
+ floor mesh does not hide it) and `height` (default `0`: the 3D grid plane's world y, -100 000 to
402
+ 100 000 metres); an older host ignores both.
400
403
  - **Live tilemap painting.** With a canvas the scene host lists `tilemapCells` and answers
401
404
  `setTilemapCells { asset, layer, cells }`: `cells` are flat `[index, tile, …]` pairs in the
402
405
  `.tilemap.json` file's order (row-major, top row first), `layer` a layer name or index. Every