@needle-tools/engine 2.35.3-pre → 2.35.5-pre

package/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.35.5-pre] - 2022-10-24
+- Change: AudioSource exposes ``clip`` field
+- Change: improve error and messaging overlay
+- Change: detect when serialized Object3D and AssetReference are missing ``@serializable`` attribute and show message in overlay
+- Change: add WebXR hands path to controllers
+- Fix: WebXR controllers now use interactable object when grabbing (instead of hit object previously) which fixes interaction with nested hierarchies in XR and DragControls
+
+## [2.35.4-pre] - 2022-10-23
+- Change: Renderer ``material`` is now ``sharedMaterial`` to make it more clear for Unity devs that the material is not being cloned when accessed
+- Fix: When not specifying any explicit networking backend for glitch deployment it now falls back to the current glitch instance for networking
+
 ## [2.35.3-pre] - 2022-10-21
 - Add: Screenshare component ``share`` method now takes optional options to configure device and MediaStreamConstraints for starting the stream 
 - Fix: WebXR should show EnterVR button when enabled in Unity

package/dist/needle-engine.d.ts

@@ -100,8 +100,12 @@ declare module "engine/engine_types" {
         intensity: number;
         color: Color;
     }
+    export interface ISharedMaterials {
+        [num: number]: Material;
+    }
     export interface IRenderer extends IComponent {
-        material: Material;
+        sharedMaterial: Material;
+        get sharedMaterials(): ISharedMaterials;
     }
     export interface ICollider extends IComponent {
         get isCollider(): any;
@@ -210,6 +214,45 @@ declare module "engine/extensions/NEEDLE_persistent_assets" {
         resolve(parser: GLTFParser, path: string): Promise<void> | null | any;
     }
 }
+declare module "engine/engine_networking_utils" {
+    export function isLocalNetwork(hostname?: string): boolean;
+    export function isHostedOnGlitch(): boolean;
+}
+declare module "engine/engine_element_overlay" {
+    import { Context } from "engine/engine_setup";
+    export const arContainerClassName = "ar";
+    export const quitARClassName = "quit-ar";
+    export class AROverlayHandler {
+        get ARContainer(): HTMLElement | null;
+        constructor();
+        private arContainer;
+        closeARCallback: any;
+        currentSession: THREE.XRSession | null;
+        registeredCloseEventElements: Element[];
+        private _createdAROnlyElements;
+        private _reparentedObjects;
+        requestEndAR(): void;
+        onBegin(context: Context, overlayContainer: HTMLElement, session: THREE.XRSession): void;
+        onEnd(_context: Context): void;
+        findOrCreateARContainer(element: HTMLElement): HTMLElement;
+        private onRequestedEndAR;
+        private createFallbackCloseARButton;
+    }
+}
+declare module "engine/debug/debug_overlay" {
+    export enum LogType {
+        Log = 0,
+        Warn = 1,
+        Error = 2
+    }
+    export function makeErrorsVisibleForDevelopment(): void;
+    export function addLog(type: LogType, message: string | any[], _file?: string | null, _line?: number | null): void;
+}
+declare module "engine/debug/debug" {
+    import { LogType } from "engine/debug/debug_overlay";
+    export { LogType };
+    export function showBalloonMessage(text: string, logType?: LogType): void;
+}
 declare module "engine/engine_serialization_core" {
     import { GLTF } from "three/examples/jsm/loaders/GLTFLoader";
     import { Object3D } from "three";
@@ -1700,27 +1743,6 @@ declare module "engine/engine_setup" {
         private executeCoroutines;
     }
 }
-declare module "engine/engine_element_overlay" {
-    import { Context } from "engine/engine_setup";
-    export const arContainerClassName = "ar";
-    export const quitARClassName = "quit-ar";
-    export class AROverlayHandler {
-        get ARContainer(): HTMLElement | null;
-        constructor();
-        private arContainer;
-        closeARCallback: any;
-        currentSession: THREE.XRSession | null;
-        registeredCloseEventElements: Element[];
-        private _createdAROnlyElements;
-        private _reparentedObjects;
-        requestEndAR(): void;
-        onBegin(context: Context, overlayContainer: HTMLElement, session: THREE.XRSession): void;
-        onEnd(_context: Context): void;
-        findOrCreateARContainer(element: HTMLElement): HTMLElement;
-        private onRequestedEndAR;
-        private createFallbackCloseARButton;
-    }
-}
 declare module "engine/engine_element_loading" {
     import { LoadingProgressArgs } from "engine/engine_setup";
     export class LoadingElementOptions {
@@ -2077,10 +2099,10 @@ declare module "engine/extensions/NEEDLE_gameobject_data" {
 declare module "engine/extensions/NEEDLE_render_objects" {
     import { SourceIdentifier } from "engine/engine_types";
     import { GLTF, GLTFLoaderPlugin, GLTFParser } from "three/examples/jsm/loaders/GLTFLoader";
-    import { IRenderer as Renderer } from "engine/engine_types";
+    import { IRenderer } from "engine/engine_types";
     export class NEEDLE_render_objects implements GLTFLoaderPlugin {
         private static stencils;
-        static applyStencil(obj?: Renderer | null): void;
+        static applyStencil(obj?: IRenderer | null): void;
         private parser;
         private source;
         constructor(parser: GLTFParser, source: SourceIdentifier);
@@ -2284,6 +2306,9 @@ declare module "engine/api" {
     export { InstancingUtil } from "engine/engine_instancing";
     export * from "engine/engine_gameobject";
     export * from "engine/engine_components";
+    export { AssetReference } from "engine/engine_addressables";
+    export { FrameEvent } from "engine/engine_setup";
+    export * from "engine/debug/debug";
 }
 declare module "engine-components/AlignmentConstraint" {
     import { Behaviour } from "engine-components/Component";
@@ -2328,7 +2353,7 @@ declare module "engine-components/AudioSource" {
         static registerWaitForAllowAudio(cb: Function): void;
         private static _userInteractionRegistered;
         private static _beginWaitForUserInteraction;
-        private clip;
+        clip: string;
         playOnAwake: boolean;
         get loop(): boolean;
         set loop(val: boolean);
@@ -3108,7 +3133,7 @@ declare module "engine-components/Renderer" {
     import { Behaviour } from "engine-components/Component";
     import * as THREE from "three";
     import { Mesh, Texture } from "three";
-    import { IRenderer } from "engine/engine_types";
+    import { IRenderer, ISharedMaterials } from "engine/engine_types";
     export { InstancingUtil } from "engine/engine_instancing";
     export class FieldWithDefault {
         path: string | null;
@@ -3120,7 +3145,8 @@ declare module "engine-components/Renderer" {
         Back = 1,
         Front = 2
     }
-    class SharedMaterialArray {
+    class SharedMaterialArray implements ISharedMaterials {
+        [num: number]: THREE.Material;
         private _renderer;
         private _targets;
         is(renderer: Renderer): boolean;
@@ -3138,8 +3164,12 @@ declare module "engine-components/Renderer" {
         renderOrder: number[] | undefined;
         allowOcclusionWhenDynamic: boolean;
         private _lightmaps?;
-        get mesh(): Mesh | undefined;
+        get sharedMesh(): Mesh | undefined;
+        get sharedMaterial(): THREE.Material;
+        set sharedMaterial(mat: THREE.Material);
+        /**@deprecated please use sharedMaterial */
         get material(): THREE.Material;
+        /**@deprecated please use sharedMaterial */
         set material(mat: THREE.Material);
         private _sharedMaterials;
         get sharedMaterials(): SharedMaterialArray;
@@ -3543,9 +3573,6 @@ declare module "engine-components/DragControls" {
         private onDragEnd;
     }
 }
-declare module "engine/engine_networking_utils" {
-    export function isLocalNetwork(hostname?: string): boolean;
-}
 declare module "engine-components/Networking" {
     import { INetworkingWebsocketUrlProvider } from "engine/engine_networking";
     import { Behaviour } from "engine-components/Component";
@@ -5359,9 +5386,6 @@ declare module "needle-engine" {
     export * from "engine-components/codegen/components";
     export * from "engine-components/js-extensions/Object3D";
 }
-declare module "engine/debug/error_overlay" {
-    export function makeErrorsVisibleForDevelopment(): void;
-}
 declare module "engine/engine" {
     import * as engine_setup from "engine/engine_setup";
     import * as engine_scenetools from "engine/engine_scenetools";