@needle-tools/engine 3.28.6-beta → 3.28.7-beta.1

package/lib/engine/engine_gltf_builtin_components.js

@@ -1,299 +1,299 @@
-import "./codegen/register_types.js";
-import { TypeStore } from "./engine_typestore.js";
-import { InstantiateIdProvider } from "./engine_networking_instantiate.js";
-import { deserializeObject, serializeObject } from "./engine_serialization.js";
-import { assign, ImplementationInformation, SerializationContext } from "./engine_serialization_core.js";
-import { debugExtension } from "./engine_default_parameters.js";
-import { editorGuidKeyName, builtinComponentKeyName } from "./engine_constants.js";
-import { addNewComponent } from "./engine_components.js";
-import { getParam } from "./engine_utils.js";
-import { LogType, showBalloonMessage } from "./debug/index.js";
-import { isLocalNetwork } from "./engine_networking_utils.js";
-const debug = debugExtension;
-const debugTypeStore = getParam("debugtypestore");
-if (debugTypeStore)
-    console.log(TypeStore);
-export function writeBuiltinComponentData(comp, context) {
-    // const fn = (comp as unknown as ISerializable)?.onBeforeSerialize;
-    // if (fn) {
-    //     const res = fn?.call(comp);
-    //     if (res !== undefined) {
-    //         res["name"] = comp.constructor.name;
-    //         return res;
-    //     }
-    // }
-    const serializable = comp;
-    const data = serializeObject(serializable, context);
-    // console.log(data);
-    if (data !== undefined)
-        return data;
-    return null;
-}
-const typeImplementationInformation = new ImplementationInformation();
-const $context_deserialize_queue = Symbol("deserialize-queue");
-export async function createBuiltinComponents(context, gltfId, gltf, seed = null, extension) {
-    if (!gltf)
-        return;
-    const lateResolve = [];
-    let idProvider = seed;
-    if (typeof idProvider === "number") {
-        idProvider = new InstantiateIdProvider(seed);
-    }
-    const idEnd = gltfId.indexOf("?");
-    gltfId = idEnd === -1 ? gltfId : gltfId.substring(0, idEnd);
-    const serializationContext = new SerializationContext(gltf.scene);
-    serializationContext.gltfId = gltfId;
-    serializationContext.context = context;
-    serializationContext.gltf = gltf;
-    serializationContext.nodeToObject = extension?.nodeToObjectMap;
-    serializationContext.implementationInformation = typeImplementationInformation;
-    // If we're loading multiple gltf files in one scene we need to make sure we deserialize all of them in one go
-    // for that we collect them in one list per context
-    let deserializeQueue = context[$context_deserialize_queue];
-    if (!deserializeQueue)
-        deserializeQueue = context[$context_deserialize_queue] = [];
-    if (gltf.scenes) {
-        for (const scene of gltf.scenes) {
-            await onCreateBuiltinComponents(serializationContext, scene, deserializeQueue, lateResolve);
-        }
-    }
-    if (gltf.children) {
-        for (const ch of gltf.children) {
-            await onCreateBuiltinComponents(serializationContext, ch, deserializeQueue, lateResolve);
-        }
-    }
-    context.new_scripts_pre_setup_callbacks.push(() => {
-        // First deserialize ALL components that were loaded before pre setup
-        // Down below they get new guids assigned so we have to do all of them first
-        // E.g. in cases where we load multiple glb files on startup from one scene
-        // and they might have cross-glb references
-        const queue = context[$context_deserialize_queue];
-        if (queue) {
-            for (const des of queue) {
-                handleDeserialization(des, serializationContext);
-            }
-            queue.length = 0;
-        }
-        // when dropping the same file multiple times we need to generate new guids
-        // e.g. SyncTransform sends its own guid to the server to know about ownership
-        // so it requires a unique guid for a new instance
-        // doing it here at the end of resolving of references should ensure that
-        // and this should run before awake and onenable of newly created components
-        if (idProvider) {
-            // TODO: should we do this after setup callbacks now?
-            const guidsMap = {};
-            const resolveGuids = [];
-            recursiveCreateGuids(gltf, idProvider, guidsMap, resolveGuids);
-            for (const scene of gltf.scenes)
-                recursiveCreateGuids(scene, idProvider, guidsMap, resolveGuids);
-            // make sure to resolve all guids AFTER new guids have been assigned
-            for (const res of resolveGuids) {
-                res.resolveGuids(guidsMap);
-            }
-        }
-    });
-    // tools.findAnimationsLate(context, gltf, context.new_scripts_pre_setup_callbacks);
-    // console.log("finished creating builtin components", gltf.scene?.name, gltf);
-}
-function recursiveCreateGuids(obj, idProvider, guidsMap, resolveGuids) {
-    if (idProvider === null)
-        return;
-    if (!obj)
-        return;
-    const prev = obj.guid;
-    obj.guid = idProvider.generateUUID();
-    if (prev && prev !== "invalid")
-        guidsMap[prev] = obj.guid;
-    // console.log(obj);
-    if (obj && obj.userData && obj.userData.components) {
-        for (const comp of obj.userData.components) {
-            if (comp === null)
-                continue;
-            const prev = comp.guid;
-            comp.guid = idProvider.generateUUID();
-            if (prev && prev !== "invalid")
-                guidsMap[prev] = comp.guid;
-            if (comp.resolveGuids)
-                resolveGuids.push(comp);
-        }
-    }
-    if (obj.children) {
-        for (const child of obj.children) {
-            recursiveCreateGuids(child, idProvider, guidsMap, resolveGuids);
-        }
-    }
-}
-const unknownComponentsBuffer = [];
-async function onCreateBuiltinComponents(context, obj, deserialize, lateResolve) {
-    if (!obj)
-        return;
-    // iterate injected data
-    const data = obj.userData;
-    if (data) {
-        const components = data.builtin_components;
-        if (components && components.length > 0) {
-            // console.log(obj);
-            for (const compData of components) {
-                try {
-                    if (compData === null)
-                        continue;
-                    const type = TypeStore.get(compData.name);
-                    // console.log(compData, compData.name, type, TypeStore);
-                    if (type !== undefined && type !== null) {
-                        const instance = new type();
-                        instance.sourceId = context.gltfId;
-                        // assign basic fields
-                        assign(instance, compData, context.implementationInformation);
-                        // assign the guid of the original instance
-                        if ("guid" in compData)
-                            instance[editorGuidKeyName] = compData.guid;
-                        // Object.assign(instance, compData);
-                        // dont call awake here because some references might not be resolved yet and components that access those fields in awake will throw
-                        // for example Duplicatable reference to object might still be { node: id }
-                        const callAwake = false;
-                        addNewComponent(obj, instance, callAwake);
-                        deserialize.push({ instance, compData, obj });
-                        // if the component instance is a camera and we dont have a main camera yet
-                        // we want to assign it to the context BEFORE any component becomes active (ensuring that in awake and onEnable the mainCamera is assigned)
-                        // alternatively we could try to search for the mainCamera in the getter of the context when creating the engine for the first time
-                        if (instance.isCamera && context.context) {
-                            if (context.context.mainCamera === null && (instance.tag === "MainCamera"))
-                                context.context.setCurrentCamera(instance);
-                        }
-                    }
-                    else {
-                        if (debug)
-                            console.debug("unknown component: " + compData.name);
-                        if (!unknownComponentsBuffer.includes(compData.name))
-                            unknownComponentsBuffer.push(compData.name);
-                    }
-                }
-                catch (err) {
-                    console.error(compData.name + " - " + err.message, err);
-                }
-            }
-            // console.debug("finished adding gltf builtin components", obj);
-        }
-        if (unknownComponentsBuffer.length > 0) {
-            const unknown = unknownComponentsBuffer.join(", ");
-            console.warn("unknown components: " + unknown);
-            unknownComponentsBuffer.length = 0;
-            if (isLocalNetwork())
-                showBalloonMessage(`<strong>Unknown components in scene</strong>:\n\n${unknown}\n\nThis could mean you forgot to add a npmdef to your ExportInfo\n<a href="https://engine.needle.tools/docs/project_structure.html#creating-and-installing-a-npmdef" target="_blank">documentation</a>`, LogType.Warn);
-        }
-    }
-    if (obj.children) {
-        for (const ch of obj.children) {
-            await onCreateBuiltinComponents(context, ch, deserialize, lateResolve);
-        }
-    }
-}
-function handleDeserialization(data, context) {
-    const { instance, compData, obj } = data;
-    context.object = obj;
-    context.target = instance;
-    // const beforeFn = (instance as ISerializationCallbackReceiver)?.onBeforeDeserialize;
-    // console.log(beforeFn, instance);
-    // if (beforeFn) beforeFn.call(instance, data.compData);
-    let deserialized = true;
-    // console.log(instance, compData);
-    // TODO: first build components and then deserialize data?
-    // currently a component referencing another component can not find it if the referenced component hasnt been added
-    // we should split this up in two steps then.
-    deserialized = deserializeObject(instance, compData, context) === true;
-    // if (!deserialized) {
-    //     // now loop through data again and search for special reference types
-    //     for (const key in compData) {
-    //         const entry = compData[key];
-    //         if (!entry) {
-    //             instance[key] = null;
-    //             continue;
-    //         }
-    //         const fn = (instance as ISerializationCallbackReceiver)?.onDeserialize;
-    //         if (fn) {
-    //             const res = fn.call(instance, key, entry);
-    //             if (res !== undefined) {
-    //                 instance[key] = res;
-    //                 continue;
-    //             }
-    //         }
-    //         // if (!resolve(instance, key, entry, lateResolve)) {
-    //         // }
-    //     }
-    // }
-    // console.log(instance);
-    // const afterFn = (instance as ISerializationCallbackReceiver)?.onAfterDeserialize;
-    // if (afterFn) afterFn.call(instance);
-    if (debug)
-        console.debug("add " + compData.name, compData, instance);
-}
-// // TODO: THIS should be legacy once we update unity builtin component exports
-// function resolve(instance, key: string, entry, lateResolve: LateResolveCallback[]): boolean {
-//     switch (entry["$type"]) {
-//         default:
-//             const type = entry["$type"];
-//             if (type !== undefined) {
-//                 const res = tryResolveType(type, entry);
-//                 if (res !== undefined)
-//                     instance[key] = res;
-//                 return res !== undefined;
-//             }
-//             break;
-//         // the thing is a reference
-//         case "reference":
-//             // we expect some identifier entry to use for finding the reference
-//             const guid = entry["guid"];
-//             lateResolve.push(async (gltf) => {
-//                 instance[key] = findInGltf(guid, gltf);
-//             });
-//             return true;
-//     }
-//     if (Array.isArray(entry)) {
-//         // the thing is an array
-//         const targetArray = instance[key];
-//         for (const index in entry) {
-//             const val = entry[index];
-//             if (val === null) {
-//                 targetArray[index] = null;
-//                 continue;
-//             }
-//             switch (val["$type"]) {
-//                 default:
-//                     const type = val["$type"];
-//                     if (type !== undefined) {
-//                         const res = tryResolveType(type, entry);
-//                         if (res !== undefined) targetArray[index] = res;
-//                     }
-//                     break;
-//                 case "reference":
-//                     // this entry is a reference
-//                     const guid = val["guid"];
-//                     lateResolve.push(async (gltf) => {
-//                         targetArray[index] = findInGltf(guid, gltf);
-//                     });
-//                     break;
-//             }
-//         }
-//         return true;
-//     }
-//     return false;
-// }
-// function findInGltf(guid: string, gltf) {
-//     let res = tools.tryFindScript(guid);
-//     if (!res) res = tools.tryFindObject(guid, gltf, true);
-//     return res;
-// }
-// function tryResolveType(type, entry): any | undefined {
-//     switch (type) {
-//         case "Vector2":
-//             return new Vector2(entry.x, entry.y);
-//         case "Vector3":
-//             return new Vector3(entry.x, entry.y, entry.z);
-//         case "Vector4":
-//             return new Vector4(entry.x, entry.y, entry.z, entry.w);
-//         case "Quaternion":
-//             return new Quaternion(entry.x, entry.y, entry.z, entry.w);
-//     }
-//     return undefined;
-// }
+import "./codegen/register_types.js";
+import { TypeStore } from "./engine_typestore.js";
+import { InstantiateIdProvider } from "./engine_networking_instantiate.js";
+import { deserializeObject, serializeObject } from "./engine_serialization.js";
+import { assign, ImplementationInformation, SerializationContext } from "./engine_serialization_core.js";
+import { debugExtension } from "./engine_default_parameters.js";
+import { editorGuidKeyName, builtinComponentKeyName } from "./engine_constants.js";
+import { addNewComponent } from "./engine_components.js";
+import { getParam } from "./engine_utils.js";
+import { LogType, showBalloonMessage } from "./debug/index.js";
+import { isLocalNetwork } from "./engine_networking_utils.js";
+const debug = debugExtension;
+const debugTypeStore = getParam("debugtypestore");
+if (debugTypeStore)
+    console.log(TypeStore);
+export function writeBuiltinComponentData(comp, context) {
+    // const fn = (comp as unknown as ISerializable)?.onBeforeSerialize;
+    // if (fn) {
+    //     const res = fn?.call(comp);
+    //     if (res !== undefined) {
+    //         res["name"] = comp.constructor.name;
+    //         return res;
+    //     }
+    // }
+    const serializable = comp;
+    const data = serializeObject(serializable, context);
+    // console.log(data);
+    if (data !== undefined)
+        return data;
+    return null;
+}
+const typeImplementationInformation = new ImplementationInformation();
+const $context_deserialize_queue = Symbol("deserialize-queue");
+export async function createBuiltinComponents(context, gltfId, gltf, seed = null, extension) {
+    if (!gltf)
+        return;
+    const lateResolve = [];
+    let idProvider = seed;
+    if (typeof idProvider === "number") {
+        idProvider = new InstantiateIdProvider(seed);
+    }
+    const idEnd = gltfId.indexOf("?");
+    gltfId = idEnd === -1 ? gltfId : gltfId.substring(0, idEnd);
+    const serializationContext = new SerializationContext(gltf.scene);
+    serializationContext.gltfId = gltfId;
+    serializationContext.context = context;
+    serializationContext.gltf = gltf;
+    serializationContext.nodeToObject = extension?.nodeToObjectMap;
+    serializationContext.implementationInformation = typeImplementationInformation;
+    // If we're loading multiple gltf files in one scene we need to make sure we deserialize all of them in one go
+    // for that we collect them in one list per context
+    let deserializeQueue = context[$context_deserialize_queue];
+    if (!deserializeQueue)
+        deserializeQueue = context[$context_deserialize_queue] = [];
+    if (gltf.scenes) {
+        for (const scene of gltf.scenes) {
+            await onCreateBuiltinComponents(serializationContext, scene, deserializeQueue, lateResolve);
+        }
+    }
+    if (gltf.children) {
+        for (const ch of gltf.children) {
+            await onCreateBuiltinComponents(serializationContext, ch, deserializeQueue, lateResolve);
+        }
+    }
+    context.new_scripts_pre_setup_callbacks.push(() => {
+        // First deserialize ALL components that were loaded before pre setup
+        // Down below they get new guids assigned so we have to do all of them first
+        // E.g. in cases where we load multiple glb files on startup from one scene
+        // and they might have cross-glb references
+        const queue = context[$context_deserialize_queue];
+        if (queue) {
+            for (const des of queue) {
+                handleDeserialization(des, serializationContext);
+            }
+            queue.length = 0;
+        }
+        // when dropping the same file multiple times we need to generate new guids
+        // e.g. SyncTransform sends its own guid to the server to know about ownership
+        // so it requires a unique guid for a new instance
+        // doing it here at the end of resolving of references should ensure that
+        // and this should run before awake and onenable of newly created components
+        if (idProvider) {
+            // TODO: should we do this after setup callbacks now?
+            const guidsMap = {};
+            const resolveGuids = [];
+            recursiveCreateGuids(gltf, idProvider, guidsMap, resolveGuids);
+            for (const scene of gltf.scenes)
+                recursiveCreateGuids(scene, idProvider, guidsMap, resolveGuids);
+            // make sure to resolve all guids AFTER new guids have been assigned
+            for (const res of resolveGuids) {
+                res.resolveGuids(guidsMap);
+            }
+        }
+    });
+    // tools.findAnimationsLate(context, gltf, context.new_scripts_pre_setup_callbacks);
+    // console.log("finished creating builtin components", gltf.scene?.name, gltf);
+}
+function recursiveCreateGuids(obj, idProvider, guidsMap, resolveGuids) {
+    if (idProvider === null)
+        return;
+    if (!obj)
+        return;
+    const prev = obj.guid;
+    obj.guid = idProvider.generateUUID();
+    if (prev && prev !== "invalid")
+        guidsMap[prev] = obj.guid;
+    // console.log(obj);
+    if (obj && obj.userData && obj.userData.components) {
+        for (const comp of obj.userData.components) {
+            if (comp === null)
+                continue;
+            const prev = comp.guid;
+            comp.guid = idProvider.generateUUID();
+            if (prev && prev !== "invalid")
+                guidsMap[prev] = comp.guid;
+            if (comp.resolveGuids)
+                resolveGuids.push(comp);
+        }
+    }
+    if (obj.children) {
+        for (const child of obj.children) {
+            recursiveCreateGuids(child, idProvider, guidsMap, resolveGuids);
+        }
+    }
+}
+const unknownComponentsBuffer = [];
+async function onCreateBuiltinComponents(context, obj, deserialize, lateResolve) {
+    if (!obj)
+        return;
+    // iterate injected data
+    const data = obj.userData;
+    if (data) {
+        const components = data.builtin_components;
+        if (components && components.length > 0) {
+            // console.log(obj);
+            for (const compData of components) {
+                try {
+                    if (compData === null)
+                        continue;
+                    const type = TypeStore.get(compData.name);
+                    // console.log(compData, compData.name, type, TypeStore);
+                    if (type !== undefined && type !== null) {
+                        const instance = new type();
+                        instance.sourceId = context.gltfId;
+                        // assign basic fields
+                        assign(instance, compData, context.implementationInformation);
+                        // assign the guid of the original instance
+                        if ("guid" in compData)
+                            instance[editorGuidKeyName] = compData.guid;
+                        // Object.assign(instance, compData);
+                        // dont call awake here because some references might not be resolved yet and components that access those fields in awake will throw
+                        // for example Duplicatable reference to object might still be { node: id }
+                        const callAwake = false;
+                        addNewComponent(obj, instance, callAwake);
+                        deserialize.push({ instance, compData, obj });
+                        // if the component instance is a camera and we dont have a main camera yet
+                        // we want to assign it to the context BEFORE any component becomes active (ensuring that in awake and onEnable the mainCamera is assigned)
+                        // alternatively we could try to search for the mainCamera in the getter of the context when creating the engine for the first time
+                        if (instance.isCamera && context.context) {
+                            if (context.context.mainCamera === null && (instance.tag === "MainCamera"))
+                                context.context.setCurrentCamera(instance);
+                        }
+                    }
+                    else {
+                        if (debug)
+                            console.debug("unknown component: " + compData.name);
+                        if (!unknownComponentsBuffer.includes(compData.name))
+                            unknownComponentsBuffer.push(compData.name);
+                    }
+                }
+                catch (err) {
+                    console.error(compData.name + " - " + err.message, err);
+                }
+            }
+            // console.debug("finished adding gltf builtin components", obj);
+        }
+        if (unknownComponentsBuffer.length > 0) {
+            const unknown = unknownComponentsBuffer.join(", ");
+            console.warn("unknown components: " + unknown);
+            unknownComponentsBuffer.length = 0;
+            if (isLocalNetwork())
+                showBalloonMessage(`<strong>Unknown components in scene</strong>:\n\n${unknown}\n\nThis could mean you forgot to add a npmdef to your ExportInfo\n<a href="https://engine.needle.tools/docs/project_structure.html#creating-and-installing-a-npmdef" target="_blank">documentation</a>`, LogType.Warn);
+        }
+    }
+    if (obj.children) {
+        for (const ch of obj.children) {
+            await onCreateBuiltinComponents(context, ch, deserialize, lateResolve);
+        }
+    }
+}
+function handleDeserialization(data, context) {
+    const { instance, compData, obj } = data;
+    context.object = obj;
+    context.target = instance;
+    // const beforeFn = (instance as ISerializationCallbackReceiver)?.onBeforeDeserialize;
+    // console.log(beforeFn, instance);
+    // if (beforeFn) beforeFn.call(instance, data.compData);
+    let deserialized = true;
+    // console.log(instance, compData);
+    // TODO: first build components and then deserialize data?
+    // currently a component referencing another component can not find it if the referenced component hasnt been added
+    // we should split this up in two steps then.
+    deserialized = deserializeObject(instance, compData, context) === true;
+    // if (!deserialized) {
+    //     // now loop through data again and search for special reference types
+    //     for (const key in compData) {
+    //         const entry = compData[key];
+    //         if (!entry) {
+    //             instance[key] = null;
+    //             continue;
+    //         }
+    //         const fn = (instance as ISerializationCallbackReceiver)?.onDeserialize;
+    //         if (fn) {
+    //             const res = fn.call(instance, key, entry);
+    //             if (res !== undefined) {
+    //                 instance[key] = res;
+    //                 continue;
+    //             }
+    //         }
+    //         // if (!resolve(instance, key, entry, lateResolve)) {
+    //         // }
+    //     }
+    // }
+    // console.log(instance);
+    // const afterFn = (instance as ISerializationCallbackReceiver)?.onAfterDeserialize;
+    // if (afterFn) afterFn.call(instance);
+    if (debug)
+        console.debug("add " + compData.name, compData, instance);
+}
+// // TODO: THIS should be legacy once we update unity builtin component exports
+// function resolve(instance, key: string, entry, lateResolve: LateResolveCallback[]): boolean {
+//     switch (entry["$type"]) {
+//         default:
+//             const type = entry["$type"];
+//             if (type !== undefined) {
+//                 const res = tryResolveType(type, entry);
+//                 if (res !== undefined)
+//                     instance[key] = res;
+//                 return res !== undefined;
+//             }
+//             break;
+//         // the thing is a reference
+//         case "reference":
+//             // we expect some identifier entry to use for finding the reference
+//             const guid = entry["guid"];
+//             lateResolve.push(async (gltf) => {
+//                 instance[key] = findInGltf(guid, gltf);
+//             });
+//             return true;
+//     }
+//     if (Array.isArray(entry)) {
+//         // the thing is an array
+//         const targetArray = instance[key];
+//         for (const index in entry) {
+//             const val = entry[index];
+//             if (val === null) {
+//                 targetArray[index] = null;
+//                 continue;
+//             }
+//             switch (val["$type"]) {
+//                 default:
+//                     const type = val["$type"];
+//                     if (type !== undefined) {
+//                         const res = tryResolveType(type, entry);
+//                         if (res !== undefined) targetArray[index] = res;
+//                     }
+//                     break;
+//                 case "reference":
+//                     // this entry is a reference
+//                     const guid = val["guid"];
+//                     lateResolve.push(async (gltf) => {
+//                         targetArray[index] = findInGltf(guid, gltf);
+//                     });
+//                     break;
+//             }
+//         }
+//         return true;
+//     }
+//     return false;
+// }
+// function findInGltf(guid: string, gltf) {
+//     let res = tools.tryFindScript(guid);
+//     if (!res) res = tools.tryFindObject(guid, gltf, true);
+//     return res;
+// }
+// function tryResolveType(type, entry): any | undefined {
+//     switch (type) {
+//         case "Vector2":
+//             return new Vector2(entry.x, entry.y);
+//         case "Vector3":
+//             return new Vector3(entry.x, entry.y, entry.z);
+//         case "Vector4":
+//             return new Vector4(entry.x, entry.y, entry.z, entry.w);
+//         case "Quaternion":
+//             return new Quaternion(entry.x, entry.y, entry.z, entry.w);
+//     }
+//     return undefined;
+// }
 //# sourceMappingURL=engine_gltf_builtin_components.js.map

package/lib/engine/engine_hot_reload.d.ts

@@ -1,5 +1,5 @@
-/** true during hot reload, can be used to modify behaviour in onEnable and onDisable */
-export declare function isHotReloading(): boolean;
-export declare function registerHotReloadType(instance: object): void;
-export declare function unregisterHotReloadType(instance: object): void;
-export declare function applyHMRChanges(newModule: any): boolean;
+/** true during hot reload, can be used to modify behaviour in onEnable and onDisable */
+export declare function isHotReloading(): boolean;
+export declare function registerHotReloadType(instance: object): void;
+export declare function unregisterHotReloadType(instance: object): void;
+export declare function applyHMRChanges(newModule: any): boolean;