@pizzapopcorn/unijs 0.0.4 → 0.0.6

package/dist/unity.js

@@ -4,17 +4,316 @@
     (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.Unity = factory());
 })(this, (function () { 'use strict';
 
+    class Transform {
+        
+        constructor(gameObject) {
+            this.gameObject = gameObject;
+        }
+
+        /**
+         * Gets the GameObject's world position.
+         * @returns {object}
+         */
+        get position() {
+            return this.#tryInvokeGameObjectEvent("transform.getPosition", "");
+        }
+
+        /**
+         * Sets the GameObject's world position.
+         * @param {object} value
+         */
+        set position(value) {
+            this.#assertVector3(value);
+            this.#tryInvokeGameObjectEvent("transform.setPosition", value);
+        }
+
+        /**
+         * Gets the GameObject's local position.
+         * @returns {object}
+         */
+        get localPosition() {
+            return this.#tryInvokeGameObjectEvent("transform.getLocalPosition", "");
+        }
+
+        /**
+         * Sets the GameObject's local position.
+         * @param {object} value
+         */
+        set localPosition(value) {
+            this.#assertVector3(value);
+            this.#tryInvokeGameObjectEvent("transform.setLocalPosition", value);
+        }
+
+        /**
+         * Gets the GameObject's local rotation.
+         * @returns {object}
+         */
+        get rotation() {
+            return this.#tryInvokeGameObjectEvent("transform.getRotation", "");
+        }
+
+        /**
+         * Sets the GameObject's local rotation.
+         * @param {object} value
+         */
+        set rotation(value) {
+            this.#assertQuaternion(value);
+            this.#tryInvokeGameObjectEvent("transform.setRotation", value);
+        }
+
+        /**
+         * Gets the GameObject's euler angles in degrees.
+         * @returns {object}
+         */
+        get eulerAngles() {
+            return this.#tryInvokeGameObjectEvent("transform.getEulerAngles", "");
+        }
+
+        /**
+         * Sets the GameObject's euler angles.
+         * @param {object} value
+         */
+        set eulerAngles(value) {
+            console.warn("[Unity] eulerAngles is read-only.");
+        }
+
+        /**
+         * Gets the GameObject's local scale.
+         * @returns {object}
+         */
+        get localScale() {
+            return this.#tryInvokeGameObjectEvent("transform.getLocalScale", "");
+        }
+
+        /**
+         * Sets the GameObject's local scale.
+         * @param {object} value
+         */
+        set localScale(value) {
+            this.#assertVector3(value);
+            this.#tryInvokeGameObjectEvent("transform.setLocalScale", value);
+        }
+
+        /**
+         * Gets the GameObject's lossy scale (Read Only).
+         * @returns {object}
+         */
+        get lossyScale() {
+            return this.#tryInvokeGameObjectEvent("transform.getLossyScale", "");
+        }
+
+        /**
+         * Sets the GameObject's lossy scale.
+         * @param {object} value
+         */
+        set lossyScale(value) {
+            console.warn("[Unity] lossyScale is read-only.");
+        }
+
+        /** 
+         * Translates the GameObject's position by the specified amount on each axis.
+         * @param {number} x
+         * @param {number} y
+         * @param {number} z
+         */
+        Translate(x, y, z) {
+            this.#tryInvokeGameObjectEvent("transform.translate", { x: x, y: y, z: z });
+        }
+
+        /**
+         * Rotates the GameObject around its local axis by the specified amount in degrees.
+         * @param {number} x
+         * @param {number} y
+         * @param {number} z
+         */
+        Rotate(x, y, z) {
+            this.#tryInvokeGameObjectEvent("transform.rotate", { x: x, y: y, z: z });
+        }
+
+        
+        #tryInvokeGameObjectEvent(eventName, payload) {
+            if(!this.gameObject) {
+                console.error("[Unity] The GameObject associated with this Transform is null");
+            }
+            return this.gameObject._invokeGameObjectEvent(eventName, payload);
+        }
+
+        #assertVector3(value) {
+            if (typeof value !== "object" || value === null || typeof value.x !== "number" || typeof value.y !== "number" || typeof value.z !== "number") {
+                throw new Error(`[Unity] Invalid Vector3: ${JSON.stringify(value)}`);
+            }
+        }
+
+        #assertQuaternion(value) {
+            if (typeof value !== "object" || value === null || typeof value.x !== "number" || typeof value.y !== "number" || typeof value.z !== "number" || typeof value.w !== "number") {
+                throw new Error(`[Unity] Invalid Quaternion: ${JSON.stringify(value)}`);
+            }
+        }
+    }
+
+    class Rigidbody {
+        
+        constructor(gameObject) {
+            this.gameObject = gameObject;
+        }
+
+        /**
+         * Gets the mass of the RigidBody.
+         * @returns {number}
+         */
+        get mass() {
+            return this.#tryInvokeGameObjectEvent("physics.getMass", "");
+        }
+
+        /**
+         * Gets whether the RigidBody is affected by gravity.
+         * @returns {boolean}
+         */
+        get useGravity() {
+            return this.#tryInvokeGameObjectEvent("physics.getUseGravity", "");
+        }
+
+        /**
+         * Gets whether the RigidBody is kinematic.
+         * @returns {boolean}
+         */
+        get isKinematic() {
+            return this.#tryInvokeGameObjectEvent("physics.getIsKinematic", "");
+        }
+
+        /**
+         * Gets the linear damping of the RigidBody.
+         * @returns {number}
+         */
+        get linearDamping() {
+            return this.#tryInvokeGameObjectEvent("physics.getLinearDamping", "");
+        }
+
+        /**
+         * Gets the angular damping of the RigidBody.
+         * @returns {number}
+         */
+        get angularDamping() {
+            return this.#tryInvokeGameObjectEvent("physics.getAngularDamping", "");
+        }
+
+        /**
+         * Adds a force to the RigidBody.
+         * @param {number} x
+         * @param {number} y
+         * @param {number} z
+         */
+        AddForce(x, y, z) {
+            this.#tryInvokeGameObjectEvent("physics.addForce", { x: x, y: y, z: z });
+        }
+
+        /**
+         * Adds a torque to the RigidBody.
+         * @param {number} x
+         * @param {number} y
+         * @param {number} z
+         */
+        AddTorque(x, y, z) {
+            this.#tryInvokeGameObjectEvent("physics.addTorque", { x: x, y: y, z: z });
+        }
+
+        /**
+         * Sets the linear velocity of the RigidBody.
+         * @param {number} x
+         * @param {number} y
+         * @param {number} z
+         */
+        SetVelocity(x, y, z) {
+            this.#tryInvokeGameObjectEvent("physics.setVelocity", { x: x, y: y, z: z });
+        }
+
+        /**
+         * Gets the linear velocity of the RigidBody.
+         * @returns {object}
+         */
+        GetVelocity() {
+            return this.#tryInvokeGameObjectEvent("physics.getVelocity", "");
+        }
+
+        /**
+         * Sets the angular velocity of the RigidBody.
+         * @param {number} x
+         * @param {number} y
+         * @param {number} z
+         */
+        SetAngularVelocity(x, y, z) {
+            this.#tryInvokeGameObjectEvent("physics.setAngularVelocity", { x: x, y: y, z: z });
+        }
+
+        /**
+         * Gets the angular velocity of the RigidBody.
+         * @returns {object}
+         */
+        GetAngularVelocity() {
+            return this.#tryInvokeGameObjectEvent("physics.getAngularVelocity", "");
+        }
+
+        /**
+         * Sets whether the RigidBody is affected by gravity.
+         * @param {boolean} useGravity
+         */
+        SetUseGravity(useGravity) {
+            this.#tryInvokeGameObjectEvent("physics.setUseGravity", useGravity);
+        }
+
+        /**
+         * Sets whether the RigidBody is kinematic.
+         * @param {boolean} isKinematic
+         */
+        SetIsKinematic(isKinematic) {
+            this.#tryInvokeGameObjectEvent("physics.setIsKinematic", isKinematic);
+        }
+
+        /**
+         * Sets the mass of the RigidBody.
+         * @param {number} mass
+         */
+        SetMass(mass) {
+            this.#tryInvokeGameObjectEvent("physics.setMass", mass);
+        }
+
+        /**
+         * Sets the linear damping of the RigidBody.
+         * @param {number} linearDamping
+         */
+        SetLinearDamping(linearDamping) {
+            this.#tryInvokeGameObjectEvent("physics.setLinearDamping", linearDamping);
+        }
+
+        #tryInvokeGameObjectEvent(eventName, payload) {
+            if(!this.gameObject) {
+                console.error("[Unity] The GameObject associated with this RigidBody is null");
+                return null;
+            }
+            return this.gameObject._invokeGameObjectEvent(eventName, payload);
+        }
+    }
+
     class GameObject {
+        #transform = null;
+        #rigidbody = null;
 
         static keyGameObjects = {};
         static #lifeCycleCallbacks = {
             awake: {},
             start: {},
+            update: {},
             enable: {},
             disable: {},
             destroy: {}
         }
 
+        /**
+         * Gets a GameObject by its JS Key (previously set in Unity using the JSKeyGameObject component).
+         * @param {string} key
+         * @returns {GameObject | null}
+         * @constructor
+         */
         static GetKeyGameObject(key){
             if(!GameObject.keyGameObjects.hasOwnProperty(key)) {
                 console.error(`GameObject with key '${key}' not found`);
@@ -22,7 +321,30 @@
             }
             return GameObject.keyGameObjects[key];
         }
+        
+        /**
+         * Instantiates a prefab at the specified position and rotation either in world space or relative to a parent GameObject.
+         * @param {string} prefabPath - The path to the prefab to instantiate from a Resources folder.
+         * @param {Object} position - The position to instantiate the prefab at (Defaults to Vector3.Zero).
+         * @param {Object} rotation - The rotation to instantiate the prefab with (Defaults to Quaternion.Identity).
+         * @param {GameObject | Transform | null} parent - The parent GameObject to instantiate the prefab relative to (Defaults to null).
+         */
+        static Instantiate(prefabPath, position = { x: 0, y: 0, z: 0 }, rotation = { x: 0, y: 0, z: 0, w: 1 }, parent = null) {
+            if(parent === null){
+                Unity.InvokeEvent("InstanceEvent:InstantiateGameObject", { prefabPath: prefabPath, position: position, rotation: rotation });
+            }
+            else {
+                const p = parent instanceof GameObject ? parent : parent instanceof Transform ? parent.gameObject : null;
+                if(p === null) return;
+                p.Instantiate(prefabPath, position, rotation);
+            }
+        }
 
+        /**
+         * Registers a callback for a GameObject's Awake event using its JS Key. If the GameObject doesn't exist yet, it will trigger when it's created.
+         * @param {string} key
+         * @param {function} callback
+         */
         static onAwake(key, callback){
             if(!GameObject.#lifeCycleCallbacks.awake.hasOwnProperty(key)) {
                 GameObject.#lifeCycleCallbacks.awake[key] = new Set();
@@ -30,13 +352,35 @@
             GameObject.#lifeCycleCallbacks.awake[key].add(callback);
         }
 
+        /**
+         * Registers a callback for a GameObject's Start event using its JS Key. If the GameObject doesn't exist yet, it will trigger when it's created.
+         * @param {string} key
+         * @param {function} callback
+         */
         static onStart(key, callback) {
             if(!GameObject.#lifeCycleCallbacks.start.hasOwnProperty(key)) {
                 GameObject.#lifeCycleCallbacks.start[key] = new Set();
             }
             GameObject.#lifeCycleCallbacks.start[key].add(callback);
         }
+        
+        /**
+         * Registers a callback for a GameObject's Update event using its JS Key. If the GameObject doesn't exist yet, it will trigger when it's created.
+         * @param {string} key
+         * @param {function} callback
+         */
+        static onUpdate(key, callback) {
+            if(!GameObject.#lifeCycleCallbacks.update.hasOwnProperty(key)) {
+                GameObject.#lifeCycleCallbacks.update[key] = new Set();
+            }
+            GameObject.#lifeCycleCallbacks.update[key].add(callback);
+        }
 
+        /**
+         * Registers a callback for a GameObject's OnEnable event using its JS Key. If the GameObject doesn't exist yet, it will trigger when it's created.
+         * @param {string} key
+         * @param {function} callback
+         */
         static onEnable(key, callback) {
             if(!GameObject.#lifeCycleCallbacks.enable.hasOwnProperty(key)) {
                 GameObject.#lifeCycleCallbacks.enable[key] = new Set();
@@ -44,6 +388,11 @@
             GameObject.#lifeCycleCallbacks.enable[key].add(callback);
         }
 
+        /**
+         * Registers a callback for a GameObject's OnDisable event using its JS Key. If the GameObject doesn't exist yet, it will trigger when it's created and then disabled.
+         * @param {string} key
+         * @param {function} callback
+         */
         static onDisable(key, callback) {
             if(!GameObject.#lifeCycleCallbacks.disable.hasOwnProperty(key)) {
                 GameObject.#lifeCycleCallbacks.disable[key] = new Set();
@@ -51,6 +400,11 @@
             GameObject.#lifeCycleCallbacks.disable[key].add(callback);
         }
 
+        /**
+         * Registers a callback for a GameObject's Destroy event using its JS Key. If the GameObject doesn't exist yet, it will trigger when it's created and then destroyed.
+         * @param {string} key
+         * @param {function} callback
+         */
         static onDestroy(key, callback) {
             if(!GameObject.#lifeCycleCallbacks.destroy.hasOwnProperty(key)) {
                 GameObject.#lifeCycleCallbacks.destroy[key] = new Set();
@@ -58,10 +412,12 @@
             GameObject.#lifeCycleCallbacks.destroy[key].add(callback);
         }
 
+        /**Only for unity js library use*/
         static _register(key, data) {
             GameObject.keyGameObjects[key] = new GameObject(key, data);
         }
 
+        /**Only for unity js library use*/
         static _receiveLifeCycleEvent(key, event) {
             const gameObject = GameObject.keyGameObjects[key];
             if(!gameObject) return;
@@ -73,7 +429,6 @@
                 }
             }
             if(event === "destroy") {
-                gameObject.transform = null;
                 delete GameObject.keyGameObjects[key];
             }
         }
@@ -81,22 +436,61 @@
         constructor(key, data) {
             this.key = key;
             this.name = data.name;
-            this.transform = data.transform;
+            this.#transform = new Transform(this);
+            if(data.hasRigidbody) {
+                this.#rigidbody = new Rigidbody(this);
+            }
             this.hierarchyPath = data.hasOwnProperty("hierarchyPath") ? data.hierarchyPath : "";
         }
+        
+        /**
+         * Gets the Transform component of the GameObject.
+         * @returns {Transform}
+         */
+        get transform() {
+            return this.#transform;
+        }
+
+        /**
+         * Gets the RigidBody component of the GameObject.
+         * @returns {Rigidbody | null}
+         */
+        get rigidbody() {
+            if(this.HasComponent("Rigidbody")) {
+                this.#rigidbody = new Rigidbody(this);
+                return this.#rigidbody;
+            }
+            return null;
+        }
 
+        /** 
+         * Sets the GameObject's active state.
+         * @param {boolean} active
+         */
         SetActive(active) {
-            this?.#invokeGameObjectEvent("gameObject.setActive", active);
+            this?._invokeGameObjectEvent("gameObject.setActive", active);
         }
 
+        /**
+         * Invokes a method on the GameObject via SendMessage. Use GameObject.types for type options.
+         * <br>In order for it to work with custom types, you need to get the fully qualified name of the type.
+         * @param {string} methodName 
+         * @param {string} paramType 
+         * @param {string} paramValue 
+         */
         InvokeMethod(methodName, paramType = "", paramValue = "") {
             paramType = Unity.types[paramType] || paramType;
-            this?.#invokeGameObjectEvent("gameObject.invokeMethod", { methodName: methodName, parameterType: paramType, parameterValue: paramValue });
+            this?._invokeGameObjectEvent("gameObject.invokeMethod", { methodName: methodName, parameterType: paramType, parameterValue: paramValue });
         }
 
+        /**
+         * Gets a child GameObject by index or name.
+         * @param {number | string} query 
+         * @returns {GameObject | null}
+         */
         GetChild(query) {
             const eventName = typeof query === "string" ? "gameObject.findChild" : "gameObject.getChild";
-            const childData = this?.#invokeGameObjectEvent(eventName, query);
+            const childData = this?._invokeGameObjectEvent(eventName, query);
             if(childData !== null) {
                 const currentPath = this.hierarchyPath === "" ? this.key : this.hierarchyPath;
                 childData.hierarchyPath = currentPath + "/" + childData.name;
@@ -105,33 +499,45 @@
             return null;
         }
 
-        Translate(x, y, z) {
-            this?.#invokeGameObjectEvent("transform.translate", { x: x, y: y, z: z });
+        /**
+         * Looks for a text component and sets its text to the specified value. It works with Legacy, TextMeshPro, and TextMesh components.
+         * @param {string} text
+         */
+        SetText(text) {
+            this?._invokeGameObjectEvent("text.setText", text);
         }
 
-        Rotate(x, y, z) {
-            this?.#invokeGameObjectEvent("transform.rotate", { x: x, y: y, z: z });
+        /**
+         * Destroys the GameObject.
+         */
+        Destroy() {
+            this?._invokeGameObjectEvent("gameObject.destroy", "");
         }
-
-        SetLocalScale(x, y, z) {
-            this?.#invokeGameObjectEvent("transform.setLocalScale", { x: x, y: y, z: z });
+        
+        /**
+         * Instantiates a prefab at the specified position and rotation relative to this GameObject's transform.
+         * @param {string} prefabPath - The path to the prefab to instantiate from a Resources folder.
+         * @param {Object} position - The position to instantiate the prefab at (Defaults to Vector3.Zero).
+         * @param {Object} rotation - The rotation to instantiate the prefab with (Defaults to Quaternion.Identity).
+         */
+        Instantiate(prefabPath, position = { x: 0, y: 0, z: 0 }, rotation = { x: 0, y: 0, z: 0, w: 1 }) {
+            this?._invokeGameObjectEvent("gameObject.instantiate", { prefabPath: prefabPath, position: position, rotation: rotation });
         }
-
-        SetLocalPosition(x, y, z) {
-            this?.#invokeGameObjectEvent("transform.setLocalPosition", { x: x, y: y, z: z });
+        
+        HasComponent(componentName) {
+            return this?._invokeGameObjectEvent("gameObject.hasComponent", componentName);
         }
-
-        SetText(text) {
-            this?.#invokeGameObjectEvent("text.setText", text);
+        
+        GetComponent(componentName) {
+            return this?._invokeGameObjectEvent("gameObject.getComponent", componentName);
         }
-
-        Destroy() {
-            this?.#invokeGameObjectEvent("gameObject.destroy", "");
+        
+        AddComponent(componentName) {
+            return this?._invokeGameObjectEvent("gameObject.addComponent", componentName);
         }
 
-        #invokeGameObjectEvent(eventName, payload) {
-            if(!this.transform) return null;
-
+        /**Only for internal library use*/
+        _invokeGameObjectEvent(eventName, payload) {
             let payloadJson = payload;
             if(typeof payload === "object") payloadJson = JSON.stringify(payload);
             else if(typeof payload !== "string") payloadJson = payload.toString();
@@ -158,9 +564,65 @@
         }
     }
 
+    class Time {
+        /**
+         * Current time in seconds.
+         * @returns {number}
+         */
+        static get time() {
+            return Unity.InvokeEvent("InstanceEvent:GetTime");
+        }
+        
+        /**
+         * The time since the last frame in seconds.
+         * @returns {number}
+         */
+        static get deltaTime() {
+            return Unity.InvokeEvent("InstanceEvent:GetDeltaTime");
+        }
+        
+        /**
+         * The interval in seconds of in-game time at which physics and other fixed frame rate updates (like MonoBehaviour's MonoBehaviour.FixedUpdate) are performed.
+         * @returns {number}
+         */
+        static get fixedDeltaTime() {
+            return Unity.InvokeEvent("InstanceEvent:GetFixedDeltaTime");
+        }
+        
+        /**
+         * The timeScale-independent interval in seconds from the last frame to the current one
+         * @returns {number}
+         */
+        static get unscaledDeltaTime() {
+            return Unity.InvokeEvent("InstanceEvent:GetUnscaledDeltaTime");
+        }
+        
+        /**
+         * The real time in seconds since Unity started running.
+         * @returns {number}
+         */
+        static get realtimeSinceStartup() {
+            return Unity.InvokeEvent("InstanceEvent:GetRealtimeSinceStartup");
+        }
+        
+        /**
+         * The scale at which time passes.
+         * @returns {number}
+         */
+        static get timeScale() {
+            return Unity.InvokeEvent("InstanceEvent:GetTimeScale");
+        }
+        
+        static set timeScale(value) {
+            Unity.InvokeEvent("InstanceEvent:SetTimeScale", value);
+        }
+    }
+
     let Unity$1 = class Unity {
         /** @type {typeof GameObject} */
         static GameObject = GameObject;
+        /** @type {typeof Time} */
+        static Time = Time;
         static internalLogs = false;
         static types = {
             int: "System.Int32",
@@ -185,6 +647,11 @@
         static #onInstanceReadyListeners = new Set();
         static #onEventListeners = {};
 
+        /**
+         * Loads the Unity canvas from the specified URL and injects it into the specified element.
+         * @param {string} url 
+         * @param {string} elementId 
+         */
         static LoadInstance(url, elementId) {
             Unity.#instanceReady = false;
             const r = new XMLHttpRequest();
@@ -207,10 +674,29 @@
             r.send();
         }
 
+        /**
+         * Gets the current Unity version.
+         * @returns {string}
+         */
+        static GetVersion() {
+            return Unity.InvokeEvent("InstanceEvent:GetUnityVersion");
+        }
+        
+        /**
+         * Gets the current build version.
+         * @returns {string}
+         */
         static GetBuildVersion() {
             return Unity.InvokeEvent("InstanceEvent:GetBuildVersion");
         }
 
+        /**
+         * Invokes a global event that can be listened to by both Unity and JS.
+         * An optional payload can be sent, and the event can also return anything.
+         * @param {string} eventName
+         * @param {any} payload
+         * @returns {any}
+         */
         static InvokeEvent(eventName, payload = undefined) {
             const responseJson = Unity.#invokeEventInternal(eventName, payload);
             try {
@@ -228,6 +714,13 @@
             }
         }
 
+        /**
+         * Async version of InvokeEvent. Invokes a global async event that can be listened to by both Unity and JS.
+         * An optional payload can be sent, and the event can also return anything.
+         * @param {string} eventName
+         * @param {any} payload
+         * @returns {Promise<any>}
+         */
         static async InvokeEventAsync(eventName, payload = undefined) {
             return new Promise(resolve => {
                 const responseJson = Unity.#invokeEventInternal(eventName, payload);
@@ -248,6 +741,10 @@
             })
         }
 
+        /**
+         * Awaits the Unity WaitForEndOfFrame coroutine.
+         * @returns {Promise<void>}
+         */
         static async WaitForEndOfFrameAsync() {
             return new Promise((resolve) => {
                 const eventId = crypto.randomUUID().toString();
@@ -262,10 +759,56 @@
             });
         }
 
+        /**
+         * Loads a scene and awaits its completion.
+         * @param {string} sceneName
+         * @returns {Promise<void>}
+         */
+        static async LoadSceneAsync(sceneName) {
+            return new Promise((resolve) => {
+                const eventName = `SceneLoadedEvent:${sceneName}`;
+                Unity.onEvent(eventName, () => {
+                    resolve();
+                    delete Unity.#onEventListeners[eventName];
+                });
+                
+                Unity.InvokeEvent("InstanceEvent:LoadScene", sceneName);
+            });
+        }
+
+        /**
+         * Returns true if a scene is currently loading.
+         * @returns {boolean}
+         */
+        static IsSceneLoading() {
+            return Unity.InvokeEvent("InstanceEvent:IsSceneLoading");
+        }
+
+        /**
+         * Returns the current scene load progress. If no scene is currently loading, it returns 0.
+         * @returns {number}
+         */
+        static GetSceneLoadProgress() {
+            return Unity.InvokeEvent("InstanceEvent:GetSceneLoadProgress");
+        }
+
+        /**
+         * Loads an asset bundle from the provided URL and awaits its completion.
+         * @param {string} bundleUrl
+         * @returns {Promise<void>}
+         */
         static async LoadBundleAsync(bundleUrl) {
             await Unity.InvokeEventAsync("InstanceEvent:LoadBundle", bundleUrl);
         }
 
+        /**
+         * This function loads the bundle, instantiates a prefab from it, and then unloads the bundle so you don't have to handle it manually.
+         * An optional parent JS Key can be provided to place the instantiated prefab under a specific GameObject.
+         * @param {string} bundleUrl
+         * @param {string} prefabName
+         * @param {string} parentKey
+         * @returns {Promise<void>}
+         */
         static async InstantiatePrefabFromBundleAsync(bundleUrl, prefabName, parentKey = "") {
             await Unity.InvokeEventAsync("InstanceEvent:InstantiatePrefabFromBundle", {
                 bundleUrl: bundleUrl,
@@ -276,6 +819,10 @@
 
         // Listeners -----------------------------
 
+        /**
+         * Registers a callback that will be invoked when the Unity instance is ready.
+         * @param {function} callback
+         */
         static onInstanceReady(callback) {
             if(!Unity.#instanceReady) {
                 Unity.#onInstanceReadyListeners.add(callback);
@@ -285,6 +832,11 @@
             }
         }
 
+        /**
+         * Registers a callback that will be invoked when a global event is received. It can listen to events from both Unity and JS.
+         * @param {string} eventName
+         * @param {function} callback
+         */
         static onEvent(eventName, callback) {
             if(!Unity.#onEventListeners.hasOwnProperty(eventName)) {
                 Unity.#onEventListeners[eventName] = new Set();
@@ -292,6 +844,11 @@
             Unity.#onEventListeners[eventName].add(callback);
         }
 
+        /**
+         * Unregisters a callback previously registered with onEvent.
+         * @param {string} eventName
+         * @param {function} callback
+         */
         static offEvent(eventName, callback) {
             if(!Unity.#onEventListeners.hasOwnProperty(eventName)) return;
             Unity.#onEventListeners[eventName].delete(callback);

package/dist/unity.min.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Unity=t()}(this,function(){"use strict";class e{static keyGameObjects={};static#e={awake:{},start:{},enable:{},disable:{},destroy:{}};static GetKeyGameObject(t){return e.keyGameObjects.hasOwnProperty(t)?e.keyGameObjects[t]:(console.error(`GameObject with key '${t}' not found`),null)}static onAwake(t,n){e.#e.awake.hasOwnProperty(t)||(e.#e.awake[t]=new Set),e.#e.awake[t].add(n)}static onStart(t,n){e.#e.start.hasOwnProperty(t)||(e.#e.start[t]=new Set),e.#e.start[t].add(n)}static onEnable(t,n){e.#e.enable.hasOwnProperty(t)||(e.#e.enable[t]=new Set),e.#e.enable[t].add(n)}static onDisable(t,n){e.#e.disable.hasOwnProperty(t)||(e.#e.disable[t]=new Set),e.#e.disable[t].add(n)}static onDestroy(t,n){e.#e.destroy.hasOwnProperty(t)||(e.#e.destroy[t]=new Set),e.#e.destroy[t].add(n)}static _register(t,n){e.keyGameObjects[t]=new e(t,n)}static _receiveLifeCycleEvent(t,n){const s=e.keyGameObjects[t];if(!s)return;const a=e.#e[n][t];if(a)for(const e of a)e(s);"destroy"===n&&(s.transform=null,delete e.keyGameObjects[t])}constructor(e,t){this.key=e,this.name=t.name,this.transform=t.transform,this.hierarchyPath=t.hasOwnProperty("hierarchyPath")?t.hierarchyPath:""}SetActive(e){this?.#t("gameObject.setActive",e)}InvokeMethod(e,t="",n=""){t=Unity.types[t]||t,this?.#t("gameObject.invokeMethod",{methodName:e,parameterType:t,parameterValue:n})}GetChild(t){const n="string"==typeof t?"gameObject.findChild":"gameObject.getChild",s=this?.#t(n,t);if(null!==s){const t=""===this.hierarchyPath?this.key:this.hierarchyPath;return s.hierarchyPath=t+"/"+s.name,new e(this.key,s)}return null}Translate(e,t,n){this?.#t("transform.translate",{x:e,y:t,z:n})}Rotate(e,t,n){this?.#t("transform.rotate",{x:e,y:t,z:n})}SetLocalScale(e,t,n){this?.#t("transform.setLocalScale",{x:e,y:t,z:n})}SetLocalPosition(e,t,n){this?.#t("transform.setLocalPosition",{x:e,y:t,z:n})}SetText(e){this?.#t("text.setText",e)}Destroy(){this?.#t("gameObject.destroy","")}#t(e,t){if(!this.transform)return null;let n=t;"object"==typeof t?n=JSON.stringify(t):"string"!=typeof t&&(n=t.toString());const s={eventName:e,hierarchyPath:this.hierarchyPath,payloadJson:n,listenDisabled:!0},a=Unity.InvokeEvent(`GOEvent:${this.key}`,JSON.stringify(s));if(Unity.internalLogs&&console.log(`Invoked Event: GOEvent:${this.key}`,s),null===a||!a.hasOwnProperty("ok"))return console.error(`Invalid JSON response from GameObject event callback: ${a}`),null;if(a.ok){let e=a.responseJson;try{e=JSON.parse(a.responseJson)}catch{}return e}return console.error(`Error invoking GameObject event: ${e}`,a.error),null}}return class t{static GameObject=e;static internalLogs=!1;static types={int:"System.Int32",float:"System.Single",double:"System.Double",bool:"System.Boolean",string:"System.String",char:"System.Char",byte:"System.Byte",long:"System.Int64",short:"System.Int16",decimal:"System.Decimal",object:"System.Object",customClass:(e,t="",n="Assembly-CSharp")=>`${""===t?e:`${t}.${e}`}, ${n}.dll`};static#n;static#s=!1;static#a=new Set;static#r={};static LoadInstance(e,n){t.#s=!1;const s=new XMLHttpRequest;s.open("GET",e+"/index.html",!0),s.onreadystatechange=function(){if(4!==s.readyState||200!==s.status)return;document.querySelector(`#${n}`).innerHTML=s.responseText;const t=document.createElement("link");t.rel="stylesheet",t.type="text/css",t.href=e+"/TemplateData/style.css",document.head.appendChild(t);const a=document.createElement("script");a.src=e+"/index.js",document.body.appendChild(a)},s.send()}static GetBuildVersion(){return t.InvokeEvent("InstanceEvent:GetBuildVersion")}static InvokeEvent(e,n=void 0){const s=t.#o(e,n);try{const n=JSON.parse(s);return n.hasOwnProperty("promiseId")&&(console.warn(`Event '${e}' returned a promise. Consider using InvokeEventAsync instead.`),t.onEvent(`PromiseResolvedEvent:${n.promiseId}`,e=>{delete t.#r[`PromiseResolvedEvent:${n.promiseId}`]})),n}catch{return s}}static async InvokeEventAsync(e,n=void 0){return new Promise(s=>{const a=t.#o(e,n);try{const e=JSON.parse(a);e.hasOwnProperty("promiseId")?t.onEvent(`PromiseResolvedEvent:${e.promiseId}`,n=>{s(n),delete t.#r[`PromiseResolvedEvent:${e.promiseId}`]}):s(e)}catch{s(a)}})}static async WaitForEndOfFrameAsync(){return new Promise(e=>{const n=crypto.randomUUID().toString(),s=`EndOfFrameEvent:${n}`;t.onEvent(s,()=>{e(),delete t.#r[s]}),t.InvokeEvent("InstanceEvent:WaitForEndOfFrame",n)})}static async LoadBundleAsync(e){await t.InvokeEventAsync("InstanceEvent:LoadBundle",e)}static async InstantiatePrefabFromBundleAsync(e,n,s=""){await t.InvokeEventAsync("InstanceEvent:InstantiatePrefabFromBundle",{bundleUrl:e,prefabName:n,parentKey:s})}static onInstanceReady(e){t.#s?e():t.#a.add(e)}static onEvent(e,n){t.#r.hasOwnProperty(e)||(t.#r[e]=new Set),t.#r[e].add(n)}static offEvent(e,n){t.#r.hasOwnProperty(e)&&t.#r[e].delete(n)}static#o(e,n){null==n&&(n="");let s=n;"object"==typeof n?s=JSON.stringify(n):"string"!=typeof n&&(s=n.toString());const a=t.#n(e,s);return t.#r[e]?.forEach(e=>e(s)),a}static _instanceReady(){t.#s=!0,t.#a.forEach(e=>e())}static _registerClientListener(e){t.#n=e}static _receiveEvent(e,n){let s=n;try{s=JSON.parse(n)}catch{}t.InvokeEvent(e,s)}static _logFromUnity(e,n){("internal"!==e||t.internalLogs)&&("error"===e?console.error(`[Unity] ${n}`):"warning"===e?console.warn(`[Unity] ${n}`):console.log(`[Unity] ${n}`))}}});
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Unity=t()}(this,function(){"use strict";class e{constructor(e){this.gameObject=e}get position(){return this.#e("transform.getPosition","")}set position(e){this.#t(e),this.#e("transform.setPosition",e)}get localPosition(){return this.#e("transform.getLocalPosition","")}set localPosition(e){this.#t(e),this.#e("transform.setLocalPosition",e)}get rotation(){return this.#e("transform.getRotation","")}set rotation(e){this.#n(e),this.#e("transform.setRotation",e)}get eulerAngles(){return this.#e("transform.getEulerAngles","")}set eulerAngles(e){console.warn("[Unity] eulerAngles is read-only.")}get localScale(){return this.#e("transform.getLocalScale","")}set localScale(e){this.#t(e),this.#e("transform.setLocalScale",e)}get lossyScale(){return this.#e("transform.getLossyScale","")}set lossyScale(e){console.warn("[Unity] lossyScale is read-only.")}Translate(e,t,n){this.#e("transform.translate",{x:e,y:t,z:n})}Rotate(e,t,n){this.#e("transform.rotate",{x:e,y:t,z:n})}#e(e,t){return this.gameObject||console.error("[Unity] The GameObject associated with this Transform is null"),this.gameObject._invokeGameObjectEvent(e,t)}#t(e){if("object"!=typeof e||null===e||"number"!=typeof e.x||"number"!=typeof e.y||"number"!=typeof e.z)throw new Error(`[Unity] Invalid Vector3: ${JSON.stringify(e)}`)}#n(e){if("object"!=typeof e||null===e||"number"!=typeof e.x||"number"!=typeof e.y||"number"!=typeof e.z||"number"!=typeof e.w)throw new Error(`[Unity] Invalid Quaternion: ${JSON.stringify(e)}`)}}class t{constructor(e){this.gameObject=e}get mass(){return this.#e("physics.getMass","")}get useGravity(){return this.#e("physics.getUseGravity","")}get isKinematic(){return this.#e("physics.getIsKinematic","")}get linearDamping(){return this.#e("physics.getLinearDamping","")}get angularDamping(){return this.#e("physics.getAngularDamping","")}AddForce(e,t,n){this.#e("physics.addForce",{x:e,y:t,z:n})}AddTorque(e,t,n){this.#e("physics.addTorque",{x:e,y:t,z:n})}SetVelocity(e,t,n){this.#e("physics.setVelocity",{x:e,y:t,z:n})}GetVelocity(){return this.#e("physics.getVelocity","")}SetAngularVelocity(e,t,n){this.#e("physics.setAngularVelocity",{x:e,y:t,z:n})}GetAngularVelocity(){return this.#e("physics.getAngularVelocity","")}SetUseGravity(e){this.#e("physics.setUseGravity",e)}SetIsKinematic(e){this.#e("physics.setIsKinematic",e)}SetMass(e){this.#e("physics.setMass",e)}SetLinearDamping(e){this.#e("physics.setLinearDamping",e)}#e(e,t){return this.gameObject?this.gameObject._invokeGameObjectEvent(e,t):(console.error("[Unity] The GameObject associated with this RigidBody is null"),null)}}class n{#s=null;#a=null;static keyGameObjects={};static#i={awake:{},start:{},update:{},enable:{},disable:{},destroy:{}};static GetKeyGameObject(e){return n.keyGameObjects.hasOwnProperty(e)?n.keyGameObjects[e]:(console.error(`GameObject with key '${e}' not found`),null)}static Instantiate(t,s={x:0,y:0,z:0},a={x:0,y:0,z:0,w:1},i=null){if(null===i)Unity.InvokeEvent("InstanceEvent:InstantiateGameObject",{prefabPath:t,position:s,rotation:a});else{const r=i instanceof n?i:i instanceof e?i.gameObject:null;if(null===r)return;r.Instantiate(t,s,a)}}static onAwake(e,t){n.#i.awake.hasOwnProperty(e)||(n.#i.awake[e]=new Set),n.#i.awake[e].add(t)}static onStart(e,t){n.#i.start.hasOwnProperty(e)||(n.#i.start[e]=new Set),n.#i.start[e].add(t)}static onUpdate(e,t){n.#i.update.hasOwnProperty(e)||(n.#i.update[e]=new Set),n.#i.update[e].add(t)}static onEnable(e,t){n.#i.enable.hasOwnProperty(e)||(n.#i.enable[e]=new Set),n.#i.enable[e].add(t)}static onDisable(e,t){n.#i.disable.hasOwnProperty(e)||(n.#i.disable[e]=new Set),n.#i.disable[e].add(t)}static onDestroy(e,t){n.#i.destroy.hasOwnProperty(e)||(n.#i.destroy[e]=new Set),n.#i.destroy[e].add(t)}static _register(e,t){n.keyGameObjects[e]=new n(e,t)}static _receiveLifeCycleEvent(e,t){const s=n.keyGameObjects[e];if(!s)return;const a=n.#i[t][e];if(a)for(const e of a)e(s);"destroy"===t&&delete n.keyGameObjects[e]}constructor(n,s){this.key=n,this.name=s.name,this.#s=new e(this),s.hasRigidbody&&(this.#a=new t(this)),this.hierarchyPath=s.hasOwnProperty("hierarchyPath")?s.hierarchyPath:""}get transform(){return this.#s}get rigidbody(){return this.HasComponent("Rigidbody")?(this.#a=new t(this),this.#a):null}SetActive(e){this?._invokeGameObjectEvent("gameObject.setActive",e)}InvokeMethod(e,t="",n=""){t=Unity.types[t]||t,this?._invokeGameObjectEvent("gameObject.invokeMethod",{methodName:e,parameterType:t,parameterValue:n})}GetChild(e){const t="string"==typeof e?"gameObject.findChild":"gameObject.getChild",s=this?._invokeGameObjectEvent(t,e);if(null!==s){const e=""===this.hierarchyPath?this.key:this.hierarchyPath;return s.hierarchyPath=e+"/"+s.name,new n(this.key,s)}return null}SetText(e){this?._invokeGameObjectEvent("text.setText",e)}Destroy(){this?._invokeGameObjectEvent("gameObject.destroy","")}Instantiate(e,t={x:0,y:0,z:0},n={x:0,y:0,z:0,w:1}){this?._invokeGameObjectEvent("gameObject.instantiate",{prefabPath:e,position:t,rotation:n})}HasComponent(e){return this?._invokeGameObjectEvent("gameObject.hasComponent",e)}GetComponent(e){return this?._invokeGameObjectEvent("gameObject.getComponent",e)}AddComponent(e){return this?._invokeGameObjectEvent("gameObject.addComponent",e)}_invokeGameObjectEvent(e,t){let n=t;"object"==typeof t?n=JSON.stringify(t):"string"!=typeof t&&(n=t.toString());const s={eventName:e,hierarchyPath:this.hierarchyPath,payloadJson:n,listenDisabled:!0},a=Unity.InvokeEvent(`GOEvent:${this.key}`,JSON.stringify(s));if(Unity.internalLogs&&console.log(`Invoked Event: GOEvent:${this.key}`,s),null===a||!a.hasOwnProperty("ok"))return console.error(`Invalid JSON response from GameObject event callback: ${a}`),null;if(a.ok){let e=a.responseJson;try{e=JSON.parse(a.responseJson)}catch{}return e}return console.error(`Error invoking GameObject event: ${e}`,a.error),null}}class s{static get time(){return Unity.InvokeEvent("InstanceEvent:GetTime")}static get deltaTime(){return Unity.InvokeEvent("InstanceEvent:GetDeltaTime")}static get fixedDeltaTime(){return Unity.InvokeEvent("InstanceEvent:GetFixedDeltaTime")}static get unscaledDeltaTime(){return Unity.InvokeEvent("InstanceEvent:GetUnscaledDeltaTime")}static get realtimeSinceStartup(){return Unity.InvokeEvent("InstanceEvent:GetRealtimeSinceStartup")}static get timeScale(){return Unity.InvokeEvent("InstanceEvent:GetTimeScale")}static set timeScale(e){Unity.InvokeEvent("InstanceEvent:SetTimeScale",e)}}return class e{static GameObject=n;static Time=s;static internalLogs=!1;static types={int:"System.Int32",float:"System.Single",double:"System.Double",bool:"System.Boolean",string:"System.String",char:"System.Char",byte:"System.Byte",long:"System.Int64",short:"System.Int16",decimal:"System.Decimal",object:"System.Object",customClass:(e,t="",n="Assembly-CSharp")=>`${""===t?e:`${t}.${e}`}, ${n}.dll`};static#r;static#o=!1;static#c=new Set;static#l={};static LoadInstance(t,n){e.#o=!1;const s=new XMLHttpRequest;s.open("GET",t+"/index.html",!0),s.onreadystatechange=function(){if(4!==s.readyState||200!==s.status)return;document.querySelector(`#${n}`).innerHTML=s.responseText;const e=document.createElement("link");e.rel="stylesheet",e.type="text/css",e.href=t+"/TemplateData/style.css",document.head.appendChild(e);const a=document.createElement("script");a.src=t+"/index.js",document.body.appendChild(a)},s.send()}static GetVersion(){return e.InvokeEvent("InstanceEvent:GetUnityVersion")}static GetBuildVersion(){return e.InvokeEvent("InstanceEvent:GetBuildVersion")}static InvokeEvent(t,n=void 0){const s=e.#y(t,n);try{const n=JSON.parse(s);return n.hasOwnProperty("promiseId")&&(console.warn(`Event '${t}' returned a promise. Consider using InvokeEventAsync instead.`),e.onEvent(`PromiseResolvedEvent:${n.promiseId}`,t=>{delete e.#l[`PromiseResolvedEvent:${n.promiseId}`]})),n}catch{return s}}static async InvokeEventAsync(t,n=void 0){return new Promise(s=>{const a=e.#y(t,n);try{const t=JSON.parse(a);t.hasOwnProperty("promiseId")?e.onEvent(`PromiseResolvedEvent:${t.promiseId}`,n=>{s(n),delete e.#l[`PromiseResolvedEvent:${t.promiseId}`]}):s(t)}catch{s(a)}})}static async WaitForEndOfFrameAsync(){return new Promise(t=>{const n=crypto.randomUUID().toString(),s=`EndOfFrameEvent:${n}`;e.onEvent(s,()=>{t(),delete e.#l[s]}),e.InvokeEvent("InstanceEvent:WaitForEndOfFrame",n)})}static async LoadSceneAsync(t){return new Promise(n=>{const s=`SceneLoadedEvent:${t}`;e.onEvent(s,()=>{n(),delete e.#l[s]}),e.InvokeEvent("InstanceEvent:LoadScene",t)})}static IsSceneLoading(){return e.InvokeEvent("InstanceEvent:IsSceneLoading")}static GetSceneLoadProgress(){return e.InvokeEvent("InstanceEvent:GetSceneLoadProgress")}static async LoadBundleAsync(t){await e.InvokeEventAsync("InstanceEvent:LoadBundle",t)}static async InstantiatePrefabFromBundleAsync(t,n,s=""){await e.InvokeEventAsync("InstanceEvent:InstantiatePrefabFromBundle",{bundleUrl:t,prefabName:n,parentKey:s})}static onInstanceReady(t){e.#o?t():e.#c.add(t)}static onEvent(t,n){e.#l.hasOwnProperty(t)||(e.#l[t]=new Set),e.#l[t].add(n)}static offEvent(t,n){e.#l.hasOwnProperty(t)&&e.#l[t].delete(n)}static#y(t,n){null==n&&(n="");let s=n;"object"==typeof n?s=JSON.stringify(n):"string"!=typeof n&&(s=n.toString());const a=e.#r(t,s);return e.#l[t]?.forEach(e=>e(s)),a}static _instanceReady(){e.#o=!0,e.#c.forEach(e=>e())}static _registerClientListener(t){e.#r=t}static _receiveEvent(t,n){let s=n;try{s=JSON.parse(n)}catch{}e.InvokeEvent(t,s)}static _logFromUnity(t,n){("internal"!==t||e.internalLogs)&&("error"===t?console.error(`[Unity] ${n}`):"warning"===t?console.warn(`[Unity] ${n}`):console.log(`[Unity] ${n}`))}}});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pizzapopcorn/unijs",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "A seamless interop layer to control Unity WebGL builds from the browser's JavaScript context.",
   "license": "MIT",
   "keywords": [