hytopia 0.7.7 → 0.7.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.7.7",
+  "version": "0.7.9",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "type": "module",
   "main": "./node-server.mjs",

package/server.api.json

@@ -2139,7 +2139,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!AudioManager#getAllAudios:member(1)",
-              "docComment": "/**\n * Retrieves all loaded audio instances for the world.\n *\n * @param tickAllocated - Whether to use the tick allocator to allocate the returned array of Audio instances. The allocated array will be collected and released at the end of the current tick if true. Only use this if you know what you're doing.\n *\n * @returns An array of audio instances.\n */\n",
+              "docComment": "/**\n * Retrieves all loaded audio instances for the world.\n *\n * @param tickAllocated - If true, uses the tick allocator and frees the allocated array at the end of the current tick. false by default.\n *\n * @returns An array of audio instances.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2192,7 +2192,7 @@
             {
               "kind": "Method",
               "canonicalReference": "server!AudioManager#getAllEntityAttachedAudios:member(1)",
-              "docComment": "/**\n * Retrieves all loaded audio instances attached to a specific entity.\n *\n * @param entity - The entity to get attached audio instances for.\n *\n * @returns An array of audio instances.\n */\n",
+              "docComment": "/**\n * Retrieves all loaded audio instances attached to a specific entity.\n *\n * @param entity - The entity to get attached audio instances for.\n *\n * @param tickAllocated - If true, uses the tick allocator and frees the allocated array at the end of the current tick. false by default.\n *\n * @returns An array of audio instances.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2203,6 +2203,14 @@
                   "text": "Entity",
                   "canonicalReference": "server!Entity:class"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", tickAllocated?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -2223,8 +2231,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 5
+                "startIndex": 5,
+                "endIndex": 7
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -2237,6 +2245,14 @@
                     "endIndex": 2
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "tickAllocated",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -2246,11 +2262,19 @@
             {
               "kind": "Method",
               "canonicalReference": "server!AudioManager#getAllLoopedAudios:member(1)",
-              "docComment": "/**\n * Retrieves all looped audio instances for the world.\n *\n * @returns An array of audio instances.\n */\n",
+              "docComment": "/**\n * Retrieves all looped audio instances for the world.\n *\n * @param tickAllocated - If true, uses the tick allocator and frees the allocated array at the end of the current tick. false by default.\n *\n * @returns An array of audio instances.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "getAllLoopedAudios(): "
+                  "text": "getAllLoopedAudios(tickAllocated?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
                 },
                 {
                   "kind": "Reference",
@@ -2268,13 +2292,22 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
+                "startIndex": 3,
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [],
+              "parameters": [
+                {
+                  "parameterName": "tickAllocated",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
               "isOptional": false,
               "isAbstract": false,
               "name": "getAllLoopedAudios"
@@ -2282,11 +2315,19 @@
             {
               "kind": "Method",
               "canonicalReference": "server!AudioManager#getAllOneshotAudios:member(1)",
-              "docComment": "/**\n * Retrieves all oneshot (non-looped) audio instances for the world.\n *\n * @returns An array of audio instances.\n */\n",
+              "docComment": "/**\n * Retrieves all oneshot (non-looped) audio instances for the world.\n *\n * @param tickAllocated - If true, uses the tick allocator and frees the allocated array at the end of the current tick. false by default.\n *\n * @returns An array of audio instances.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "getAllOneshotAudios(): "
+                  "text": "getAllOneshotAudios(tickAllocated?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
                 },
                 {
                   "kind": "Reference",
@@ -2304,13 +2345,22 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 3
+                "startIndex": 3,
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
-              "parameters": [],
+              "parameters": [
+                {
+                  "parameterName": "tickAllocated",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
               "isOptional": false,
               "isAbstract": false,
               "name": "getAllOneshotAudios"
@@ -29068,6 +29118,54 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ParticleEmitter#burst:member(1)",
+              "docComment": "/**\n * Creates a burst of particles, regardless of pause state.\n *\n * @param count - The number of particles to burst.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "burst(count: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "count",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "burst"
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!ParticleEmitter#colorEnd:member",
@@ -31547,6 +31645,27 @@
           "name": "ParticleEmitterEvent",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!ParticleEmitterEvent.BURST:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "BURST = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"PARTICLE_EMITTER.BURST\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "BURST"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!ParticleEmitterEvent.DESPAWN:member",
@@ -32215,6 +32334,51 @@
           "name": "ParticleEmitterEventPayloads",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!ParticleEmitterEventPayloads#\"PARTICLE_EMITTER.BURST\":member",
+              "docComment": "/**\n * Emitted when a ParticleEmitter bursts the specified number of particles.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ParticleEmitterEvent.BURST",
+                  "canonicalReference": "server!ParticleEmitterEvent.BURST:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        particleEmitter: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ParticleEmitter",
+                  "canonicalReference": "server!ParticleEmitter:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        count: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"PARTICLE_EMITTER.BURST\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!ParticleEmitterEventPayloads#\"PARTICLE_EMITTER.DESPAWN\":member",
@@ -49649,6 +49813,83 @@
           "name": "TickAllocator",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "server!TickAllocator#filter:member(1)",
+              "docComment": "/**\n * Filters an array using a callback function.\n *\n * @param array - The array to filter.\n *\n * @param callback - The callback function to filter the array.\n *\n * @typeParam T - The type of the array.\n *\n * @returns A new array with the filtered values.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "filter<T>(array: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", callback: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(value: T, index: number, array: T[]) => boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "T[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "typeParameters": [
+                {
+                  "typeParameterName": "T",
+                  "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": "array",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "callback",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "filter"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!TickAllocator#getArray:member(1)",

package/server.d.ts

@@ -279,10 +279,8 @@ export declare class AudioManager {
     /**
      * Retrieves all loaded audio instances for the world.
      *
-     * @param tickAllocated - Whether to use the tick allocator to allocate the
-     * returned array of Audio instances. The allocated array will be collected
-     * and released at the end of the current tick if true. Only use this if
-     * you know what you're doing.
+     * @param tickAllocated - If true, uses the tick allocator and frees
+     * the allocated array at the end of the current tick. false by default.
      *
      * @returns An array of audio instances.
      */
@@ -291,21 +289,30 @@ export declare class AudioManager {
      * Retrieves all loaded audio instances attached to a specific entity.
      *
      * @param entity - The entity to get attached audio instances for.
+     * @param tickAllocated - If true, uses the tick allocator and frees
+     * the allocated array at the end of the current tick. false by default.
+
      * @returns An array of audio instances.
      */
-    getAllEntityAttachedAudios(entity: Entity): Audio[];
+    getAllEntityAttachedAudios(entity: Entity, tickAllocated?: boolean): Audio[];
     /**
      * Retrieves all looped audio instances for the world.
      *
+     * @param tickAllocated - If true, uses the tick allocator and frees
+     * the allocated array at the end of the current tick. false by default.
+     *
      * @returns An array of audio instances.
      */
-    getAllLoopedAudios(): Audio[];
+    getAllLoopedAudios(tickAllocated?: boolean): Audio[];
     /**
      * Retrieves all oneshot (non-looped) audio instances for the world.
      *
+     * @param tickAllocated - If true, uses the tick allocator and frees
+     * the allocated array at the end of the current tick. false by default.
+     *
      * @returns An array of audio instances.
      */
-    getAllOneshotAudios(): Audio[];
+    getAllOneshotAudios(tickAllocated?: boolean): Audio[];
 
     /**
      * Unregisters and stops an audio instance from the audio manager.
@@ -3910,6 +3917,12 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
      * @param velocityVariance - The velocity variance of an emitted particle.
      */
     setVelocityVariance(velocityVariance: Vector3Like): void;
+    /**
+     * Creates a burst of particles, regardless of pause state.
+     *
+     * @param count - The number of particles to burst.
+     */
+    burst(count: number): void;
     /**
      * Despawns the ParticleEmitter from the world.
      */
@@ -3933,6 +3946,7 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
 
 /** Event types a ParticleEmitter instance can emit. See {@link ParticleEmitterEventPayloads} @public */
 export declare enum ParticleEmitterEvent {
+    BURST = "PARTICLE_EMITTER.BURST",
     DESPAWN = "PARTICLE_EMITTER.DESPAWN",
     SET_ALPHA_TEST = "PARTICLE_EMITTER.SET_ALPHA_TEST",
     SET_ATTACHED_TO_ENTITY = "PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY",
@@ -3968,6 +3982,11 @@ export declare enum ParticleEmitterEvent {
 
 /** Event payloads for ParticleEmitter emitted events. @public */
 export declare interface ParticleEmitterEventPayloads {
+    /** Emitted when a ParticleEmitter bursts the specified number of particles. */
+    [ParticleEmitterEvent.BURST]: {
+        particleEmitter: ParticleEmitter;
+        count: number;
+    };
     /** Emitted when a ParticleEmitter is despawned. */
     [ParticleEmitterEvent.DESPAWN]: {
         particleEmitter: ParticleEmitter;
@@ -6288,6 +6307,14 @@ export declare class TickAllocator {
 
 
 
+    /**
+     * Filters an array using a callback function.
+     * @typeParam T - The type of the array.
+     * @param array - The array to filter.
+     * @param callback - The callback function to filter the array.
+     * @returns A new array with the filtered values.
+     */
+    filter<T>(array: T[], callback: (value: T, index: number, array: T[]) => boolean): T[];
     /**
      * Gets a generic array from the pool.
      * Array is reset to empty state and ready for use.