@needle-tools/engine 4.1.0-experimental.12 → 4.1.0

package/src/engine-components/particlesystem/ParticleSystem.ts

@@ -1,4 +1,4 @@
-import { AxesHelper, BackSide, Blending, BufferGeometry, FrontSide, LinearSRGBColorSpace, Material, Matrix4, Mesh, NormalBlending, Object3D, PlaneGeometry, Quaternion, SpriteMaterial, Texture, Vector3, Vector4 } from "three";
+import { AxesHelper, BackSide, Blending, BufferGeometry, FrontSide, LinearSRGBColorSpace, Material, Matrix4, Mesh, MeshBasicMaterial, MeshStandardMaterial, NormalBlending, Object3D, PlaneGeometry, Quaternion, SpriteMaterial, Texture, Vector3, Vector4 } from "three";
 import type { BatchedRenderer, Behavior, BurstParameters, EmissionState, EmitterShape, FunctionColorGenerator, FunctionJSON, FunctionValueGenerator, GeneratorMemory, Particle, ParticleSystemParameters, RecordState, TrailSettings, ValueGenerator } from "three.quarks";
 import { BatchedParticleRenderer, ConstantColor, ConstantValue, ParticleSystem as _ParticleSystem, RenderMode, TrailParticle, Vector3 as QVector3, Vector4 as QVector4 } from "three.quarks";
 
@@ -39,10 +39,10 @@ export class ParticleSystemRenderer extends Behaviour {
     renderMode?: ParticleSystemRenderMode;
 
     @serializable(Material)
-    particleMaterial?: SpriteMaterial;
+    particleMaterial?: SpriteMaterial | MeshBasicMaterial;
 
     @serializable(Material)
-    trailMaterial?: SpriteMaterial;
+    trailMaterial?: SpriteMaterial | MeshBasicMaterial;
 
     // @serializable(Mesh)
     particleMesh?: Mesh | string;
@@ -68,6 +68,7 @@ export class ParticleSystemRenderer extends Behaviour {
                 // showBalloonWarning(msg);
             }
         }
+
     }
 
     get transparent(): boolean {
@@ -80,6 +81,24 @@ export class ParticleSystemRenderer extends Behaviour {
         let material = (trailEnabled === true && this.trailMaterial) ? this.trailMaterial : this.particleMaterial;
 
         if (material) {
+
+            if (material.type === "MeshStandardMaterial") {
+                if (debug) console.debug("ParticleSystemRenderer.getMaterial: MeshStandardMaterial detected, converting to MeshBasicMaterial. See https://github.com/Alchemist0823/three.quarks/issues/101");
+                if ("map" in material && material.map) {
+                    material.map.colorSpace = LinearSRGBColorSpace;
+                    material.map.premultiplyAlpha = false;
+                }
+                const newMaterial = new MeshBasicMaterial({ map: material.map });
+                if (trailEnabled) this.trailMaterial = newMaterial;
+                else this.particleMaterial = newMaterial;
+            }
+
+            
+            if (material.map) {
+                material.map.colorSpace = LinearSRGBColorSpace;
+                material.map.premultiplyAlpha = false;
+            }
+
             if (trailEnabled) {
                 // the particle material for trails must be DoubleSide or BackSide (since otherwise the trail is invisible)
                 if (material.side === FrontSide) {
@@ -896,7 +915,7 @@ export class ParticleSystem extends Behaviour implements IParticleSystem {
         if (particleSystemBehaviour instanceof ParticleSystemBaseBehaviour) {
             particleSystemBehaviour.system = this;
         }
-        if (isDevEnvironment()) console.log("add behaviour", particleSystemBehaviour);
+        if (isDevEnvironment() || debug) console.debug("Add custom ParticleSystem Behaviour", particleSystemBehaviour);
         this._particleSystem.addBehavior(particleSystemBehaviour);
         return true;
     }
@@ -908,6 +927,7 @@ export class ParticleSystem extends Behaviour implements IParticleSystem {
         const behaviours = this._particleSystem.behaviors;
         const index = behaviours.indexOf(particleSystemBehaviour);
         if (index !== -1) {
+            if (isDevEnvironment() || debug) console.debug("Remove custom ParticleSystem Behaviour", index, particleSystemBehaviour);
             behaviours.splice(index, 1);
             return true;
         }
@@ -1145,13 +1165,9 @@ export class ParticleSystem extends Behaviour implements IParticleSystem {
         }
     }
 
-    private lastMaterialVersion: number = -1;
+    // private lastMaterialVersion: number = -1;
     private onUpdate() {
-        const mat = this.renderer.getMaterial(this.trails.enabled);
-        if (mat && mat.version != this.lastMaterialVersion && this._particleSystem) {
-            this.lastMaterialVersion = mat.version;
-            this._particleSystem.texture = this._interface.texture;
-        }
+
 
         if (this._bursts) {
             this.emission.bursts = this._bursts;

package/src/engine-components/particlesystem/ParticleSystemModules.ts

@@ -1,6 +1,6 @@
 import { createNoise4D, type NoiseFunction4D } from 'simplex-noise';
 import { BufferGeometry, Color, Euler, Matrix4, Mesh, Object3D, Quaternion, Triangle, Vector2, Vector3, Vector4 } from "three";
-import type { EmitterShape, IParticleSystem as QParticleSystem,Particle, ShapeJSON, Vector3 as QVector3, Vector4 as QVector4 } from "three.quarks";
+import type { EmitterShape, IParticleSystem as QParticleSystem, Particle, ShapeJSON, Vector3 as QVector3, Vector4 as QVector4 } from "three.quarks";
 
 import { isDevEnvironment } from '../../engine/debug/index.js';
 import { Gizmos } from "../../engine/engine_gizmos.js";
@@ -360,9 +360,16 @@ export class MinMaxGradient {
                 this.gradientMax.evaluate(t01, MinMaxGradient._temp2);
                 return MinMaxGradient._temp.lerp(MinMaxGradient._temp2, t);
 
+            case ParticleSystemGradientMode.RandomColor:
+            case "RandomColor":
+                const random_t = Math.random();
+                this.gradientMin.evaluate(t01, MinMaxGradient._temp);
+                this.gradientMax.evaluate(t01, MinMaxGradient._temp2);
+                return MinMaxGradient._temp.lerp(MinMaxGradient._temp2, random_t);
+
         }
         // console.warn("Not implemented", ParticleSystemGradientMode[this.mode]);
-        MinMaxGradient._temp.set(0xff00ff)
+        MinMaxGradient._temp.set(0xffffff)
         MinMaxGradient._temp.alpha = 1;
         return MinMaxGradient._temp;
     }
@@ -685,7 +692,7 @@ export class ShapeModule implements EmitterShape {
     }
 
     update(_system: QParticleSystem, _delta: number): void {
-        throw new Error('Method not implemented: use onUpdate');
+        /* this is called by quarks */
     }
 
     onUpdate(system: IParticleSystem, _context: Context, simulationSpace: ParticleSystemSimulationSpace, obj: Object3D) {

package/src/engine-components/postprocessing/Effects/Antialiasing.ts

@@ -1,5 +1,4 @@
 import { MODULES } from "../../../engine/engine_modules.js";
-
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/BloomEffect.ts

@@ -1,7 +1,7 @@
 import type { BloomEffect as _BloomEffect } from "postprocessing";
 import { MathUtils } from "three";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts

@@ -1,6 +1,6 @@
 import { Vector2 } from "three";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts

@@ -1,6 +1,6 @@
 import { NoToneMapping } from "three";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/Pixelation.ts

@@ -1,6 +1,6 @@
 import type { PixelationEffect as PixelationEffectPP } from "postprocessing";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusion.ts

@@ -1,7 +1,7 @@
 import type { DepthDownsamplingPass, NormalPass, SSAOEffect } from "postprocessing";
 import { Color, PerspectiveCamera } from "three";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts

@@ -1,7 +1,7 @@
 import type { N8AOPostPass } from "n8ao";
 import { Color, PerspectiveCamera } from "three";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { validate } from "../../../engine/engine_util_decorator.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";

package/src/engine-components/postprocessing/Effects/Sharpening.ts

@@ -1,4 +1,5 @@
 import { Uniform } from "three";
+
 import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { PostProcessingEffect } from "../PostProcessingEffect.js";
@@ -23,30 +24,39 @@ export class SharpeningEffect extends PostProcessingEffect {
     private _effect?: any;
 
     onCreateEffect() {
+        this._effect ??= new (createSharpeningEffectType())();
         return this.effect;
     }
 
     private get effect() {
-        this._effect ??= new (createSharpeningEffectType())();
-        // return null;
         return this._effect;
     }
 
     @serializable()
     set amount(value: number) {
-        this.effect.uniforms.get("amount")!.value = value;
+        this._amount = value;
+        if (this._effect)
+            this._effect.uniforms.get("amount")!.value = value;
     }
     get amount() {
-        return this.effect.uniforms.get("amount")!.value;
+        if (this._effect)
+            return this._effect.uniforms.get("amount")!.value;
+        return this._amount;
     }
+    private _amount = 1;
 
     @serializable()
     set radius(value: number) {
-        this.effect.uniforms.get("radius")!.value = value;
+        this._radius = value;
+        if (this._effect)
+            this._effect.uniforms.get("radius")!.value = value;
     }
     get radius() {
-        return this.effect.uniforms.get("radius")!.value;
+        if (this._effect)
+            return this._effect.uniforms.get("radius")!.value;
+        return this._radius;
     }
+    private _radius = 1;
 
     // @serializable()
     // set threshold(value: number) {
@@ -62,21 +72,6 @@ export class SharpeningEffect extends PostProcessingEffect {
 
 function createSharpeningEffectType() {
 
-    class _SharpeningEffect extends MODULES.POSTPROCESSING.MODULE!.Effect {
-        constructor() {
-            super("Sharpening", frag, {
-                vertexShader: vert,
-                blendFunction: MODULES.POSTPROCESSING.MODULE.BlendFunction.NORMAL,
-                uniforms: new Map<string, Uniform<any>>([
-                    ["amount", new Uniform(1)],
-                    ["radius", new Uniform(1)],
-                    // ["threshold", new Uniform(0)],
-                ]),
-            });
-        }
-    }
-    return _SharpeningEffect;
-
     const vert = `
       void mainSupport() {
         vUv = uv;
@@ -125,4 +120,20 @@ function createSharpeningEffectType() {
     
     `
 
+    class _SharpeningEffect extends MODULES.POSTPROCESSING.MODULE!.Effect {
+        constructor() {
+            super("Sharpening", frag, {
+                vertexShader: vert,
+                blendFunction: MODULES.POSTPROCESSING.MODULE.BlendFunction.NORMAL,
+                uniforms: new Map<string, Uniform<any>>([
+                    ["amount", new Uniform(1)],
+                    ["radius", new Uniform(1)],
+                    // ["threshold", new Uniform(0)],
+                ]),
+            });
+        }
+    }
+    return _SharpeningEffect;
+
+
 }

package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts

@@ -1,5 +1,4 @@
 import { MODULES } from "../../../engine/engine_modules.js";
-
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/Effects/Tonemapping.ts

@@ -1,7 +1,7 @@
 import type { ToneMappingEffect as _TonemappingEffect, ToneMappingMode } from "postprocessing";
 import { ACESFilmicToneMapping, AgXToneMapping, LinearToneMapping, NeutralToneMapping, NoToneMapping, ReinhardToneMapping } from "three";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { getParam } from "../../../engine/engine_utils.js";
 import { EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";

package/src/engine-components/postprocessing/Effects/Vignette.ts

@@ -1,6 +1,6 @@
 import type { VignetteEffect } from "postprocessing";
-import { MODULES } from "../../../engine/engine_modules.js";
 
+import { MODULES } from "../../../engine/engine_modules.js";
 import { serializable } from "../../../engine/engine_serialization.js";
 import { type EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 import { VolumeParameter } from "../VolumeParameter.js";

package/src/engine-components/postprocessing/PostProcessingHandler.ts

@@ -1,14 +1,13 @@
 import type { Effect, EffectComposer, Pass, ToneMappingEffect as _TonemappingEffect } from "postprocessing";
-
 import { HalfFloatType, NoToneMapping } from "three";
 
 import { showBalloonWarning } from "../../engine/debug/index.js";
+// import { internal_SetSharpeningEffectModule } from "./Effects/Sharpening.js";
+import { MODULES } from "../../engine/engine_modules.js";
 import { Context } from "../../engine/engine_setup.js";
 import type { Constructor } from "../../engine/engine_types.js";
 import { DeviceUtilities, getParam } from "../../engine/engine_utils.js";
 import { Camera } from "../Camera.js";
-// import { internal_SetSharpeningEffectModule } from "./Effects/Sharpening.js";
-import { MODULES } from "../../engine/engine_modules.js";
 import { PostProcessingEffect, PostProcessingEffectContext } from "./PostProcessingEffect.js";
 
 declare const NEEDLE_USE_POSTPROCESSING: boolean;

package/src/engine-components/webxr/Avatar.ts

@@ -101,7 +101,7 @@ export class Avatar extends Behaviour {
             headObj.quaternion.x *= -1;
 
             // HACK: XRFlag limitation workaround to make sure first person user head is never rendered
-            if (this.context.time.frameCount % 10 === 0) {
+            if (this.context.time.frameCount % 10 === 0 && this.head.asset) {
                 const xrflags = GameObject.getComponentsInChildren(this.head.asset, XRFlag);
                 for (const flag of xrflags) {
                     flag.enabled = false;
@@ -242,9 +242,9 @@ export class Avatar extends Behaviour {
         await this.loadAvatarObjects(this.head, this.leftHand, this.rightHand);
 
         this._leftHandMeshes = [];
-        this.leftHand.asset.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._leftHandMeshes!.push(obj); });
+        this.leftHand.asset?.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._leftHandMeshes!.push(obj as Mesh); });
         this._rightHandMeshes = [];
-        this.rightHand.asset.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._rightHandMeshes!.push(obj); });
+        this.rightHand.asset?.traverse((obj) => { if ((obj as Mesh)?.isMesh) this._rightHandMeshes!.push(obj as Mesh); });
 
         if (PlayerState.isLocalPlayer(this.gameObject)) {
             this._syncTransforms = GameObject.getComponentsInChildren(this.gameObject, SyncedTransform);

package/src/engine-components/webxr/WebXR.ts

@@ -227,23 +227,32 @@ export class WebXR extends Behaviour {
         XRState.Global.Set(isVR ? XRStateFlag.VR : XRStateFlag.AR);
 
         // Handle AR session root
-        if (this.usePlacementReticle && args.xr.isAR) {
+        if (args.xr.isAR) {
             let sessionroot = GameObject.findObjectOfType(WebARSessionRoot);
+            // Only create a WebARSessionRoot if none is in the scene already
             if (!sessionroot) {
-                const implicitSessionRoot = new Object3D();
-                for (const ch of this.context.scene.children)
-                    implicitSessionRoot.add(ch);
-                this.context.scene.add(implicitSessionRoot);
-                sessionroot = GameObject.addComponent(implicitSessionRoot, WebARSessionRoot)!;
-                this._createdComponentsInSession.push(sessionroot);
+                if (this.usePlacementReticle) {
+                    const implicitSessionRoot = new Object3D();
+                    for (const ch of this.context.scene.children)
+                        implicitSessionRoot.add(ch);
+                    this.context.scene.add(implicitSessionRoot);
+                    sessionroot = GameObject.addComponent(implicitSessionRoot, WebARSessionRoot)!;
+                    this._createdComponentsInSession.push(sessionroot);
+                }
+                else if (debug || isDevEnvironment()) {
+                    console.warn("WebXR: No WebARSessionRoot found in scene and usePlacementReticle is disabled in WebXR component.")
+                }
+            }
+
+            if (sessionroot) {
+                // sessionroot.enabled = this.usePlacementReticle; // < not sure if we want to disable the session root when placement reticle if OFF...
+                sessionroot.customReticle = this.customARPlacementReticle;
+                sessionroot.arScale = this.arScale;
+                sessionroot.arTouchTransform = this.usePlacementAdjustment;
+                sessionroot.autoPlace = this.autoPlace;
+                sessionroot.autoCenter = this.autoCenter;
+                sessionroot.useXRAnchor = this.useXRAnchor;
             }
-            
-            sessionroot.customReticle = this.customARPlacementReticle;
-            sessionroot.arScale = this.arScale;
-            sessionroot.arTouchTransform = this.usePlacementAdjustment;
-            sessionroot.autoPlace = this.autoPlace;
-            sessionroot.autoCenter = this.autoCenter;
-            sessionroot.useXRAnchor = this.useXRAnchor;
         }
 
         // handle VR controls

package/src/engine-components/webxr/WebXRImageTracking.ts

@@ -4,7 +4,8 @@ import { Object3DEventMap } from "three";
 import { isDevEnvironment, showBalloonWarning } from "../../engine/debug/index.js";
 import { AssetReference } from "../../engine/engine_addressables.js";
 import { serializable } from "../../engine/engine_serialization.js";
-import { CircularBuffer, getParam } from "../../engine/engine_utils.js";
+import { IGameObject } from "../../engine/engine_types.js";
+import { CircularBuffer, DeviceUtilities, getParam } from "../../engine/engine_utils.js";
 import { type NeedleXREventArgs, NeedleXRSession } from "../../engine/xr/api.js";
 import { IUSDExporterExtension } from "../../engine-components/export/usdz/Extension.js";
 import { imageToCanvas, USDObject, USDWriter, USDZExporterContext } from "../../engine-components/export/usdz/ThreeUSDZExporter.js";
@@ -236,11 +237,17 @@ export class WebXRImageTracking extends Behaviour {
     trackedImages?: WebXRImageTrackingModel[];
 
     /** Applies smoothing based on detected jitter to the tracked image. */
+    @serializable()
     smooth: boolean = true;
 
     private readonly trackedImageIndexMap: Map<number, WebXRImageTrackingModel> = new Map();
     private static _imageElements: Map<string, ImageBitmap | null> = new Map();
 
+    /** @returns true if image tracking is supported on this device. This may return false at runtime if the user's browser did not enable webxr incubations */
+    get supported() { return this._supported; }
+
+    private _supported: boolean = true;
+
     awake(): void {
         if (debug) console.log(this)
         if (!this.trackedImages) return;
@@ -324,6 +331,11 @@ export class WebXRImageTracking extends Behaviour {
     };
 
     onLeaveXR(_args: NeedleXREventArgs): void {
+
+        if(!this.supported && DeviceUtilities.isAndroidDevice()) {
+            showBalloonWarning(this.webXRIncubationsWarning);
+        }
+
         if (this.trackedImages) {
             for (const trackedImage of this.trackedImages) {
                 if (trackedImage.object?.asset) {
@@ -344,9 +356,12 @@ export class WebXRImageTracking extends Behaviour {
         }
     }
 
-    private readonly imageToObjectMap = new Map<WebXRImageTrackingModel, { object: GameObject | null, frames: number, lastTrackingTime: number }>();
+    private readonly imageToObjectMap = new Map<WebXRImageTrackingModel, { object: Object3D | null, frames: number, lastTrackingTime: number }>();
     private readonly currentImages: WebXRTrackedImage[] = [];
 
+    
+    private readonly webXRIncubationsWarning = "Image tracking is currently not supported on this device. On Chrome for Android, you can enable the <a target=\"_blank\" href=\"#\" onclick=\"() => console.log('I')\">chrome://flags/#webxr-incubations</a> flag.";
+
     onUpdateXR(args: NeedleXREventArgs): void {
         this.currentImages.length = 0;
 
@@ -354,12 +369,12 @@ export class WebXRImageTracking extends Behaviour {
         if (!frame) return;
 
         if (!("getImageTrackingResults" in frame)) {
-            const warning = "Image tracking is currently not supported on this device. On Chrome for Android, you can enable the <a target=\"_blank\" href=\"#\" onclick=\"() => console.log('I')\">chrome://flags/#webxr-incubations</a> flag.";
             if (!this["didPrintWarning"]) {
                 this["didPrintWarning"] = true;
-                console.log(warning);
+                console.log(this.webXRIncubationsWarning);
             }
-            showBalloonWarning(warning);
+            this._supported = false;
+            showBalloonWarning(this.webXRIncubationsWarning);
             return;
         }
         // Check if enabled features (if available) contains image tracking - if it's not available this statement should not catch
@@ -442,7 +457,7 @@ export class WebXRImageTracking extends Behaviour {
                 trackedData = { object: null, frames: 0, lastTrackingTime: Date.now() };
                 this.imageToObjectMap.set(model, trackedData);
 
-                model.object.loadAssetAsync().then((asset: GameObject | null) => {
+                model.object.loadAssetAsync().then((asset: Object3D | null) => {
                     if (model.createObjectInstance && asset) {
                         asset = GameObject.instantiate(asset);
                     }
@@ -461,7 +476,7 @@ export class WebXRImageTracking extends Behaviour {
                         if (xr.rig) {
                             xr.rig.gameObject.add(asset);
                             image.applyToObject(asset);
-                            if (!asset.activeSelf)
+                            if (!(asset as IGameObject).activeSelf)
                                 GameObject.setActive(asset, true);
                             // InstancingUtil.markDirty(asset);
                         }
@@ -489,7 +504,7 @@ export class WebXRImageTracking extends Behaviour {
                     xr.rig.gameObject.add(trackedData.object);
 
                     image.applyToObject(trackedData.object, this.smooth ? this.context.time.deltaTimeUnscaled * 3 : undefined);
-                    if (!trackedData.object.activeSelf) {
+                    if (!(trackedData.object as IGameObject).activeSelf) {
                         GameObject.setActive(trackedData.object, true);
                     }
                     // InstancingUtil.markDirty(trackedData.object);

package/src/engine-components/webxr/WebXRRig.ts

@@ -23,11 +23,21 @@ export class XRRig extends Behaviour implements IXRRig {
 
     get isActive() { return this.activeAndEnabled && this.gameObject.visible; }
 
-    /** Sets this rig to be the active XR rig (needs to be called during an active XR session) */
+    /** 
+     * Sets this rig to be the active XR rig (needs to be called during an active XR session) 
+     * Note that this might modify the priority of this rig to be the highest.
+    */
     setAsActiveXRRig() {
         NeedleXRSession.active?.setRigActive(this);
     }
+    /** 
+     * Sets the priority of the rig.
+     */
+    setPriority(value: number) {
+        this.priority = value;
+    }
 
+    /** @internal */
     awake(): void {
         if (debug) {
             const gizmoObj = new Object3D() as IGameObject;
@@ -51,15 +61,18 @@ export class XRRig extends Behaviour implements IXRRig {
 
     private _startScale?: Vector3;
 
+    /** @internal */
     onEnterXR(args: NeedleXREventArgs): void {
         this._startScale = this.gameObject.scale.clone();
         args.xr.addRig(this);
-        if(debug) console.log("WebXR: add Rig", this.name, this.priority);
+        if (debug) console.log("WebXR: add Rig", this.name, this.priority);
     }
+    /** @internal */
     onLeaveXR(args: NeedleXREventArgs): void {
         args.xr.removeRig(this);
         if (this._startScale && this.gameObject)
             this.gameObject.scale.copy(this._startScale);
     }
 
+
 }

package/src/engine-components-experimental/networking/PlayerSync.ts

@@ -20,7 +20,7 @@ declare type PlayerSyncWithAsset = PlayerSync & Required<Pick<PlayerSync, "asset
  * @category Networking
  */
 export class PlayerSync extends Behaviour {
-    
+
     /**
      * This API is experimental and may change or be removed in the future.
      * Create a PlayerSync instance at runtime from a given URL
@@ -36,7 +36,7 @@ export class PlayerSync extends Behaviour {
         const assetReference = AssetReference.getOrCreateFromUrl(url);
         if (!assetReference.asset) {
             const i = await assetReference.loadAssetAsync();
-            GameObject.getOrAddComponent(i, PlayerState);
+            if(i) GameObject.getOrAddComponent(i, PlayerState);
         }
         const ps = new PlayerSync();
         ps._internalInit(init);
@@ -103,6 +103,7 @@ export class PlayerSync extends Behaviour {
         const instance = await this._localInstance;
         if (instance) {
             const pl = GameObject.getComponentsInChildren(instance, PlayerState);
+            if (debug) console.log(`PlayerSync.createInstance: found ${pl?.length} PlayerState components. Owner: ${this.context.connection.connectionId}`);
             if (pl?.length) {
                 for (const state of pl)
                     state.owner = this.context.connection.connectionId!;
@@ -226,7 +227,7 @@ export class PlayerState extends Behaviour {
     }
 
     private onOwnerChange(newOwner: string, oldOwner: string) {
-        if (debug) console.log("PlayerSync.onOwnerChange", this, "newOwner", newOwner, "oldOwner", oldOwner);
+        if (debug) console.log(`PlayerSync.onOwnerChange: ${oldOwner} → ${newOwner} (me: ${this.context.connection.connectionId})`);
 
         // Remove from local owner array if it was local before
         const index = PlayerState._local.indexOf(this);
@@ -259,6 +260,7 @@ export class PlayerState extends Behaviour {
         PlayerState.dispatchEvent(PlayerStateEvent.OwnerChanged, evt);
     }
 
+    /** @internal */
     awake(): void {
         PlayerState.all.push(this);
         if (debug) console.log("Registered new PlayerState", this.guid, PlayerState.all.length - 1, PlayerState.all)
@@ -266,31 +268,10 @@ export class PlayerState extends Behaviour {
         this.context.connection.beginListen(RoomEvents.UserLeftRoom, this.onUserLeftRoom);
     }
 
-    private onUserLeftRoom = (model: { userId: string }) => {
-        if (model.userId === this.owner) {
-            if (debug)
-                console.log("PLAYERSYNC LEFT", this.owner)
-            this.doDestroy();
-            return;
-        }
-    }
-
-
+    /** @internal */
     async start() {
         if (debug) console.log("PLAYERSTATE.START, owner: " + this.owner, this.context.connection.usersInRoom([]))
 
-        // generate number from owner
-        // if (this.owner) {
-        //     // string to number
-        //     let num = 0;
-        //     for (let i = 0; i < this.owner.length; i++) {
-        //         num += this.owner.charCodeAt(i);
-        //     }
-        //     console.log(num)
-        //     num = num / 1000
-        //     this.gameObject.position.y = num;
-        // }
-
         // If a player is spawned but not in the room anymore we want to destroy it
         // this might happen in a case where all users get disconnected at once and the server 
         // still has the syncInstantiate messages that are sent to all clients
@@ -314,29 +295,20 @@ export class PlayerState extends Behaviour {
                     }
                     else if (debug) console.warn("PlayerState.start → owner is still undefined but dontDestroy is set to true", this.name);
                 }
-                else if(debug) console.log("PlayerState.start → owner is assigned", this.owner);
+                else if (debug) console.log("PlayerState.start → owner is assigned", this.owner);
             }, 2000);
         }
     }
 
-    // onEnable() {
-    //     if (debug) this.startCoroutine(this.debugRoutine());
-    // }
-
-    // *debugRoutine() {
-    //     while (!this.destroyed && this.activeAndEnabled) {
-    //         Gizmos.DrawLabel(this.gameObject.worldPosition, this.owner ?? "no owner");
-    //         yield;
-    //     }
-    // }
-
     /** this tells the server that this client has been destroyed and the networking message for the instantiate will be removed */
     doDestroy() {
         if (debug) console.log("PlayerSync.doDestroy → syncDestroy", this.name);
         syncDestroy(this.gameObject, this.context.connection, true, { saveInRoom: false });
     }
 
+    /** @internal */
     onDestroy() {
+        if(debug) console.warn("PlayerState.onDestroy", this.owner);
         this.context.connection.stopListen(RoomEvents.UserLeftRoom, this.onUserLeftRoom);
         PlayerState.all.splice(PlayerState.all.indexOf(this), 1);
 
@@ -346,4 +318,13 @@ export class PlayerState extends Behaviour {
                 PlayerState._local.splice(index, 1);
         }
     }
+
+    private onUserLeftRoom = (model: { userId: string }) => {
+        if (model.userId === this.owner) {
+            if (debug)
+                console.log("PLAYERSYNC LEFT", this.owner)
+            this.doDestroy();
+            return;
+        }
+    }
 }