@relu-interactives/spatial-ecs 0.3.20 → 0.4.0

package/dist/docs/guide/systems/input-system.md

@@ -149,12 +149,15 @@ Toggle visibility on Space, fire on left-click.
 
 ```ts
 import { KeyboardKeys, Behaviour } from "@relu-interactives/spatial-ecs";
+import { Object3DRef } from "@relu-interactives/spatial-ecs/components";
 
 export default class ActionHandler extends Behaviour {
   protected onUpdate() {
     // getKeyDown fires only on the first frame the key is pressed.
     if (this.world.getKeyDown(KeyboardKeys.Space)) {
-      this.transform.visible = !this.transform.visible;
+      // Visibility lives on Object3DRef, not on the transform.
+      const ref = this.getComponent(Object3DRef);
+      if (ref) ref.visibility = !ref.visibility;
     }
 
     // Left mouse button

package/dist/docs/guide/systems/script-object-system.md

@@ -29,7 +29,15 @@ The `moduleLoader` owns cache-busting: with the default dynamic-import loader th
 Construct it and pass it to `World.setup`:
 
 ```ts
-import { ScriptObjectSystem } from "@relu-interactives/spatial-ecs";
+import {
+  ScriptObjectSystem,
+  World,
+  type ModuleLoader,
+} from "@relu-interactives/spatial-ecs";
+
+declare const world: World;
+// Resolves a script URL to its ES module — the templates supply this.
+declare const myModuleLoader: ModuleLoader;
 
 world.setup({
   systems: [new ScriptObjectSystem(myModuleLoader)],

package/dist/docs/guide/vr-and-hand-poses.md

@@ -192,9 +192,11 @@ Add an **XR Hand Pose** component and list the poses to watch for. Each is eithe
 ```ts
 import {
   Behaviour,
-  Object3DRef,
   type XrHandPoseEventDetail,
 } from "@relu-interactives/spatial-ecs";
+import {
+  Object3DRef,
+} from "@relu-interactives/spatial-ecs/components";
 
 export default class Portal extends Behaviour {
   onHandPoseStart(event: XrHandPoseEventDetail) {
@@ -214,16 +216,18 @@ export default class Portal extends Behaviour {
 
 `XrHandPoseEventDetail` is `{ poseId, poseName, handedness, confidence }`. Match on `poseId` — it is the id set in the inspector, not the preset name.
 
-**Changing another object's colour from a pose.** `MaterialComponent.updateValue` takes an index and a PATCH OBJECT — `updateValue(0, { color })`, not `updateValue(0, "color", value)`.
+**Changing another object's colour from a pose.** `MaterialComponent.updateValue` takes an index and a PATCH OBJECT — `updateValue(0, { color })`, not `updateValue(0, { color: value })`.
 
 ```ts
 import {
   Behaviour,
-  MaterialComponent,
   type EntityInput,
   type WorldEntityView,
   type XrHandPoseEventDetail,
 } from "@relu-interactives/spatial-ecs";
+import {
+  MaterialComponent,
+} from "@relu-interactives/spatial-ecs/components";
 
 export default class PoseColor extends Behaviour {
   data = { target: { type: "entity", value: null } as unknown as EntityInput };

package/dist/docs/guide/world-api.md

@@ -10,7 +10,8 @@ This page summarises the methods most useful from a `Behaviour` and shows how to
 ## Inside a Behaviour
 
 ```ts
-import { Behaviour, TransformComponent } from "@relu-interactives/spatial-ecs";
+import { Behaviour } from "@relu-interactives/spatial-ecs";
+import { TransformComponent } from "@relu-interactives/spatial-ecs/components";
 
 export default class Spinner extends Behaviour {
   onUpdate() {
@@ -120,7 +121,8 @@ Both methods accept `Vec3` (`THREE.Vector3` or `{ x, y, z }`) and return `Inters
 ### Find an entity by name and move it
 
 ```ts
-import { Behaviour, TransformComponent } from "@relu-interactives/spatial-ecs";
+import { Behaviour } from "@relu-interactives/spatial-ecs";
+import { TransformComponent } from "@relu-interactives/spatial-ecs/components";
 
 export default class TargetMover extends Behaviour {
   onUpdate() {
@@ -138,7 +140,8 @@ export default class TargetMover extends Behaviour {
 ### Iterate every entity that owns a component
 
 ```ts
-import { Behaviour, LightComponent } from "@relu-interactives/spatial-ecs";
+import { Behaviour } from "@relu-interactives/spatial-ecs";
+import { LightComponent } from "@relu-interactives/spatial-ecs/components";
 
 export default class FlickerAllLights extends Behaviour {
   onUpdate() {
@@ -188,7 +191,10 @@ export default class HierarchyWalker extends Behaviour {
 
 ```ts
 import { Behaviour } from "@relu-interactives/spatial-ecs";
-import type Health from "./Health";
+// Your own Behaviour, in a sibling file.
+declare class Health extends Behaviour {
+  takeDamage(amount: number): void;
+}
 
 export default class DamageDealer extends Behaviour {
   fire() {
@@ -229,12 +235,12 @@ export default class Spawner extends Behaviour {
     );
     this.world.getScene().add(mesh);
 
-    this.world.addComponents(id, [
-      createNameComponent({ value: "RuntimeCube" }),
-      createEntityTypeComponent({ value: "cube" }),
-      createTransformComponent({ position: { x: 0, y: 1, z: 0 } }),
-      createObject3DRefComponent({ object: mesh }),
-    ]);
+    // Each factory takes (world, entityId, ...constructorArgs) and attaches
+    // the component itself — there is nothing to pass to addComponents.
+    createNameComponent(this.world, id, "RuntimeCube");
+    createEntityTypeComponent(this.world, id, "cube");
+    createTransformComponent(this.world, id, { position: { x: 0, y: 1, z: 0 } });
+    createObject3DRefComponent(this.world, id, mesh);
   }
 }
 ```
@@ -343,7 +349,8 @@ export default class LookDetector extends Behaviour {
 ### Read keyboard and mouse input
 
 ```ts
-import { Behaviour, TransformComponent, KeyboardKeys } from "@relu-interactives/spatial-ecs";
+import { Behaviour, KeyboardKeys } from "@relu-interactives/spatial-ecs";
+import { TransformComponent } from "@relu-interactives/spatial-ecs/components";
 
 export default class WASDMove extends Behaviour {
   speed = 3;
@@ -392,11 +399,12 @@ export default class FpsLook extends Behaviour {
 ### Reach into the physics world
 
 ```ts
-import { Behaviour, PhysicsComponent } from "@relu-interactives/spatial-ecs";
+import { Behaviour, KeyboardKeys } from "@relu-interactives/spatial-ecs";
+import { PhysicsComponent } from "@relu-interactives/spatial-ecs/components";
 
 export default class Jump extends Behaviour {
   onUpdate() {
-    if (!this.world.getKeyDown("space")) return;
+    if (!this.world.getKeyDown(KeyboardKeys.Space)) return;
 
     const physics = this.world.getComponent(this.entity.entityId, PhysicsComponent);
     physics?.rigidBody?.applyImpulse({ x: 0, y: 5, z: 0 }, true);
@@ -411,12 +419,12 @@ ticks stop when paused — physics, animation, scripts, and the render pass.
 The last rendered frame stays frozen on the canvas.
 
 ```ts
-import { Behaviour } from "@relu-interactives/spatial-ecs";
+import { Behaviour, KeyboardKeys } from "@relu-interactives/spatial-ecs";
 
 export default class PauseOnHit extends Behaviour {
   onUpdate() {
     // Pause when the spacebar is pressed, resume when pressed again.
-    if (!this.world.getKeyDown("Space")) return;
+    if (!this.world.getKeyDown(KeyboardKeys.Space)) return;
 
     if (this.world.isPaused()) {
       this.world.resume();

package/dist/factories/index.cjs

@@ -2254,6 +2254,12 @@ var _XRRigComponent = class _XRRigComponent extends Component {
     this.teleportArcColor = options?.teleportArcColor ?? "#4da3ff";
     this.teleportArcInvalidColor = options?.teleportArcInvalidColor ?? "#ff5a5a";
     this.teleportArcThickness = options?.teleportArcThickness ?? 0.012;
+    this.passthrough = options?.passthrough ?? false;
+    this.depthOcclusion = options?.depthOcclusion ?? false;
+    this.environmentPhysics = options?.environmentPhysics ?? "none";
+    this.environmentDebug = options?.environmentDebug ?? false;
+    this.hitTest = options?.hitTest ?? false;
+    this.anchors = options?.anchors ?? false;
   }
 };
 __name(_XRRigComponent, "XRRigComponent");