hytopia 0.1.72 → 0.1.74

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.72",
+  "version": "0.1.74",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {

package/server.api.json

@@ -12714,91 +12714,6 @@
           ],
           "extendsTokenRanges": []
         },
-        {
-          "kind": "Interface",
-          "canonicalReference": "server!Event_2:interface",
-          "docComment": "/**\n * An EventRouter event.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export interface Event<TPayload> "
-            }
-          ],
-          "fileUrlPath": "src/events/EventRouter.ts",
-          "releaseTag": "Public",
-          "typeParameters": [
-            {
-              "typeParameterName": "TPayload",
-              "constraintTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              },
-              "defaultTypeTokenRange": {
-                "startIndex": 0,
-                "endIndex": 0
-              }
-            }
-          ],
-          "name": "Event_2",
-          "preserveMemberOrder": false,
-          "members": [
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "server!Event_2#payload:member",
-              "docComment": "/**\n * The payload of the event, passed to listeners\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "payload: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "TPayload"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "payload",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "server!Event_2#type:member",
-              "docComment": "/**\n * The type of event\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "type: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "type",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            }
-          ],
-          "extendsTokenRanges": []
-        },
         {
           "kind": "Class",
           "canonicalReference": "server!EventRouter:class",
@@ -12850,20 +12765,23 @@
             {
               "kind": "Method",
               "canonicalReference": "server!EventRouter#emit:member(1)",
-              "docComment": "/**\n * Emit an event, invoking all registered listeners for the event type.\n *\n * @param event - The event to emit.\n *\n * @returns `true` if listeners were found and invoked, `false` otherwise.\n */\n",
+              "docComment": "/**\n * Emit an event, invoking all registered listeners for the event type.\n *\n * @param eventType - The type of event to emit.\n *\n * @param payload - The payload to emit.\n *\n * @returns `true` if listeners were found and invoked, `false` otherwise.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "emit<TPayload>(event: "
+                  "text": "emit<TPayload>(eventType: "
                 },
                 {
-                  "kind": "Reference",
-                  "text": "Event",
-                  "canonicalReference": "server!Event_2:interface"
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", payload: "
                 },
                 {
                   "kind": "Content",
-                  "text": "<TPayload>"
+                  "text": "TPayload"
                 },
                 {
                   "kind": "Content",
@@ -12893,18 +12811,26 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 4,
-                "endIndex": 5
+                "startIndex": 5,
+                "endIndex": 6
               },
               "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "event",
+                  "parameterName": "eventType",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
-                    "endIndex": 3
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "payload",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
                   },
                   "isOptional": false
                 }
@@ -13191,7 +13117,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!EventRouter#on:member(1)",
-              "docComment": "/**\n * Register a listener for a specific event type.\n *\n * @remarks\n *\n * When the same event router instance used to register a listener emits an event a listener was registered for, the listener will be invoked with the event payload. Listeners are called in the order they are registered.\n *\n * @param eventType - The type of event to listen for.\n *\n * @param listener - The listener function to invoke when the event is emitted.\n */\n",
+              "docComment": "/**\n * Register a listener for a specific event type.\n *\n * @remarks\n *\n * Listeners are invoked in the order they are registered.\n *\n * @param eventType - The type of event to listen for.\n *\n * @param listener - The listener function to invoke when the event is emitted.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -13265,6 +13191,237 @@
               "isAbstract": false,
               "name": "on"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!EventRouter#once:member(1)",
+              "docComment": "/**\n * Register a listener for a specific event type that will be invoked once.\n *\n * @param eventType - The type of event to listen for.\n *\n * @param listener - The listener function to invoke when the event is emitted.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "once<TPayload>(eventType: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", listener: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(payload: TPayload) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "TPayload",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  }
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "eventType",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "listener",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "once"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!EventRouter#prependOn:member(1)",
+              "docComment": "/**\n * Register a listener for a specific event type that will be invoked before all other existing listeners.\n *\n * @param eventType - The type of event to listen for.\n *\n * @param listener - The listener function to invoke when the event is emitted.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "prependOn<TPayload>(eventType: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", listener: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(payload: TPayload) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "TPayload",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  }
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "eventType",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "listener",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "prependOn"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!EventRouter#prependOnce:member(1)",
+              "docComment": "/**\n * Register a listener for a specific event type that will be invoked once before all other existing listeners.\n *\n * @param eventType - The type of event to listen for.\n *\n * @param listener - The listener function to invoke when the event is emitted.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "prependOnce<TPayload>(eventType: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", listener: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(payload: TPayload) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "TPayload",
+                  "constraintTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  },
+                  "defaultTypeTokenRange": {
+                    "startIndex": 0,
+                    "endIndex": 0
+                  }
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 6
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "eventType",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "listener",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "prependOnce"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!EventRouter.serverInstance:member",
@@ -16835,24 +16992,11 @@
                   "kind": "Content",
                   "text": "get input(): "
                 },
-                {
-                  "kind": "Reference",
-                  "text": "Readonly",
-                  "canonicalReference": "!Readonly:type"
-                },
-                {
-                  "kind": "Content",
-                  "text": "<"
-                },
                 {
                   "kind": "Reference",
                   "text": "PlayerInput",
                   "canonicalReference": "server!PlayerInput:type"
                 },
-                {
-                  "kind": "Content",
-                  "text": ">"
-                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -16864,7 +17008,7 @@
               "name": "input",
               "propertyTypeTokenRange": {
                 "startIndex": 1,
-                "endIndex": 5
+                "endIndex": 2
               },
               "isStatic": false,
               "isProtected": false,
@@ -23866,22 +24010,18 @@
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!RigidBody#createAndAddChildCollidersToSimulation:member(1)",
-              "docComment": "/**\n * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.\n *\n * @param colliderOptions - The options for the child colliders to add to the rigid body.\n *\n * @returns The child colliders that were added to the rigid body.\n */\n",
+              "canonicalReference": "server!RigidBody#createAndAddChildCollider:member(1)",
+              "docComment": "/**\n * Creates and adds a child collider to the rigid body for the simulation it belongs to.\n *\n * @remarks\n *\n * If the rigid body is not simulated, the collider will be added to the rigid body as a pending child collider and also simulated when the rigid body is simulated.\n *\n * @param colliderOptions - The options for the child collider to add.\n *\n * @returns The child collider that was added to the rigid body.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "createAndAddChildCollidersToSimulation(colliderOptions: "
+                  "text": "createAndAddChildCollider(colliderOptions: "
                 },
                 {
                   "kind": "Reference",
                   "text": "ColliderOptions",
                   "canonicalReference": "server!ColliderOptions:interface"
                 },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -23891,10 +24031,6 @@
                   "text": "Collider",
                   "canonicalReference": "server!Collider:class"
                 },
-                {
-                  "kind": "Content",
-                  "text": "[]"
-                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -23902,8 +24038,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 4,
-                "endIndex": 6
+                "startIndex": 3,
+                "endIndex": 4
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -23913,29 +24049,33 @@
                   "parameterName": "colliderOptions",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
-                    "endIndex": 3
+                    "endIndex": 2
                   },
                   "isOptional": false
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "createAndAddChildCollidersToSimulation"
+              "name": "createAndAddChildCollider"
             },
             {
               "kind": "Method",
-              "canonicalReference": "server!RigidBody#createAndAddChildColliderToSimulation:member(1)",
-              "docComment": "/**\n * Creates and adds a child collider to the rigid body for the simulation it belongs to.\n *\n * @param colliderOptions - The options for the child collider to add.\n *\n * @returns The child collider that was added to the rigid body.\n */\n",
+              "canonicalReference": "server!RigidBody#createAndAddChildCollidersToSimulation:member(1)",
+              "docComment": "/**\n * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.\n *\n * @param colliderOptions - The options for the child colliders to add to the rigid body.\n *\n * @returns The child colliders that were added to the rigid body.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "createAndAddChildColliderToSimulation(colliderOptions: "
+                  "text": "createAndAddChildCollidersToSimulation(colliderOptions: "
                 },
                 {
                   "kind": "Reference",
                   "text": "ColliderOptions",
                   "canonicalReference": "server!ColliderOptions:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -23945,6 +24085,10 @@
                   "text": "Collider",
                   "canonicalReference": "server!Collider:class"
                 },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
                 {
                   "kind": "Content",
                   "text": ";"
@@ -23952,8 +24096,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
+                "startIndex": 4,
+                "endIndex": 6
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -23963,14 +24107,14 @@
                   "parameterName": "colliderOptions",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
-                    "endIndex": 2
+                    "endIndex": 3
                   },
                   "isOptional": false
                 }
               ],
               "isOptional": false,
               "isAbstract": false,
-              "name": "createAndAddChildColliderToSimulation"
+              "name": "createAndAddChildCollidersToSimulation"
             },
             {
               "kind": "Property",

package/server.d.ts

@@ -1621,15 +1621,6 @@ export declare interface EntityOptions {
     tintColor?: RgbColor;
 }
 
-/** An EventRouter event. @public */
-declare interface Event_2<TPayload> {
-    /** The type of event */
-    type: string;
-    /** The payload of the event, passed to listeners */
-    payload: TPayload;
-}
-export { Event_2 as Event }
-
 /**
  * Manages event emission and assigned listener callbacks.
  *
@@ -1646,7 +1637,6 @@ export declare class EventRouter {
     /** The singleton instance for global server events. */
     static readonly serverInstance: EventRouter;
     private _emitter;
-    private _wrappedListenerMap;
     private _tag;
     /** Enable logging of all events. Default: false */
     logAllEvents: boolean;
@@ -1661,18 +1651,14 @@ export declare class EventRouter {
     /** @param tag - Tag for logging, used to identify EventRouter instances in logs. */
     constructor(tag: string);
     /**
-     * Register a listener for a specific event type.
+     * Emit an event, invoking all registered listeners for the event type.
      *
-     * @remarks
-     * When the same event router instance used to register a listener
-     * emits an event a listener was registered for, the listener will
-     * be invoked with the event payload. Listeners are called in the order
-     * they are registered.
+     * @param eventType - The type of event to emit.
+     * @param payload - The payload to emit.
      *
-     * @param eventType - The type of event to listen for.
-     * @param listener - The listener function to invoke when the event is emitted.
+     * @returns `true` if listeners were found and invoked, `false` otherwise.
      */
-    on<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+    emit<TPayload>(eventType: string, payload: TPayload): boolean;
     /**
      * Remove a listener for a specific event type.
      *
@@ -1687,12 +1673,36 @@ export declare class EventRouter {
      */
     offAll(eventType: string): void;
     /**
-     * Emit an event, invoking all registered listeners for the event type.
+     * Register a listener for a specific event type.
      *
-     * @param event - The event to emit.
-     * @returns `true` if listeners were found and invoked, `false` otherwise.
+     * @remarks
+     * Listeners are invoked in the order they are registered.
+     *
+     * @param eventType - The type of event to listen for.
+     * @param listener - The listener function to invoke when the event is emitted.
      */
-    emit<TPayload>(event: Event_2<TPayload>): boolean;
+    on<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+    /**
+     * Register a listener for a specific event type that will be invoked once.
+     *
+     * @param eventType - The type of event to listen for.
+     * @param listener - The listener function to invoke when the event is emitted.
+     */
+    once<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+    /**
+     * Register a listener for a specific event type that will be invoked before all other existing listeners.
+     *
+     * @param eventType - The type of event to listen for.
+     * @param listener - The listener function to invoke when the event is emitted.
+     */
+    prependOn<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+    /**
+     * Register a listener for a specific event type that will be invoked once before all other existing listeners.
+     *
+     * @param eventType - The type of event to listen for.
+     * @param listener - The listener function to invoke when the event is emitted.
+     */
+    prependOnce<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
 }
 
 /**
@@ -2160,7 +2170,7 @@ export declare class Player {
 
 
     /** The current {@link PlayerInput} of the player. */
-    get input(): Readonly<PlayerInput>;
+    get input(): PlayerInput;
     /** The current {@link World} the player is in. */
     get world(): World | undefined;
     /**
@@ -3184,10 +3194,15 @@ export declare class RigidBody {
     applyTorqueImpulse(impulse: Vector3Like): void;
     /**
      * Creates and adds a child collider to the rigid body for the simulation it belongs to.
+     *
+     * @remarks
+     * If the rigid body is not simulated, the collider will be added to the rigid body as a pending child collider
+     * and also simulated when the rigid body is simulated.
+     *
      * @param colliderOptions - The options for the child collider to add.
      * @returns The child collider that was added to the rigid body.
      */
-    createAndAddChildColliderToSimulation(colliderOptions: ColliderOptions): Collider;
+    createAndAddChildCollider(colliderOptions: ColliderOptions): Collider;
     /**
      * Creates and adds multiple child colliders to the rigid body for the simulation it belongs to.
      * @param colliderOptions - The options for the child colliders to add to the rigid body.