hytopia 0.6.32 → 0.6.34

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.6.32",
+  "version": "0.6.34",
   "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

@@ -28627,7 +28627,7 @@
         {
           "kind": "Class",
           "canonicalReference": "server!ParticleEmitter:class",
-          "docComment": "/**\n * Represents a particle emitter in the world. Particle emitters emit 2D particles in a world that always face the camera.\n *\n * <h2>Events</h2>\n *\n * This class is an EventRouter, and instance of it emit events with payloads listed under {@link ParticleEmitterEventPayloads}.\n *\n * @example\n * ```typescript\n * const particleEmitter = new ParticleEmitter({\n *   textureUri: 'textures/particles/smoke.png',\n * });\n *\n * particleEmitter.spawn(world);\n * ```\n *\n * @public\n */\n",
+          "docComment": "/**\n * Represents a particle emitter in the world. Emit 2D particles that always face the camera.\n *\n * @remarks\n *\n * Particle emitters are created directly as instances. They support a variety of configuration options through the {@link ParticleEmitterOptions} constructor argument.\n *\n * <h2>Events</h2>\n *\n * This class is an EventRouter, and instance of it emit events with payloads listed under {@link ParticleEmitterEventPayloads}.\n *\n * @example\n * ```typescript\n * const particleEmitter = new ParticleEmitter({\n *   textureUri: 'textures/particles/smoke.png',\n * });\n *\n * particleEmitter.spawn(world);\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -28756,6 +28756,36 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!ParticleEmitter#attachedToEntityNodeName:member",
+              "docComment": "/**\n * The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get attachedToEntityNodeName(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "attachedToEntityNodeName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!ParticleEmitter#colorEnd:member",
@@ -29555,6 +29585,54 @@
               "isAbstract": false,
               "name": "setAttachedToEntity"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!ParticleEmitter#setAttachedToEntityNodeName:member(1)",
+              "docComment": "/**\n * Sets the name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.\n *\n * @param attachedToEntityNodeName - The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setAttachedToEntityNodeName(attachedToEntityNodeName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "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": "attachedToEntityNodeName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setAttachedToEntityNodeName"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!ParticleEmitter#setColorEnd:member(1)",
@@ -31064,6 +31142,27 @@
               "releaseTag": "Public",
               "name": "SET_ATTACHED_TO_ENTITY"
             },
+            {
+              "kind": "EnumMember",
+              "canonicalReference": "server!ParticleEmitterEvent.SET_ATTACHED_TO_ENTITY_NODE_NAME:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "SET_ATTACHED_TO_ENTITY_NODE_NAME = "
+                },
+                {
+                  "kind": "Content",
+                  "text": "\"PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY_NODE_NAME\""
+                }
+              ],
+              "initializerTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "name": "SET_ATTACHED_TO_ENTITY_NODE_NAME"
+            },
             {
               "kind": "EnumMember",
               "canonicalReference": "server!ParticleEmitterEvent.SET_COLOR_END:member",
@@ -31675,6 +31774,51 @@
                 "endIndex": 6
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!ParticleEmitterEventPayloads#\"PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY_NODE_NAME\":member",
+              "docComment": "/**\n * Emitted when the name of the node of the attached entity the particle emitter is attached to is set.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "["
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ParticleEmitterEvent.SET_ATTACHED_TO_ENTITY_NODE_NAME",
+                  "canonicalReference": "server!ParticleEmitterEvent.SET_ATTACHED_TO_ENTITY_NODE_NAME:member"
+                },
+                {
+                  "kind": "Content",
+                  "text": "]: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        particleEmitter: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ParticleEmitter",
+                  "canonicalReference": "server!ParticleEmitter:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n        attachedToEntityNodeName: string;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "\"PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY_NODE_NAME\"",
+              "propertyTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 6
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!ParticleEmitterEventPayloads#\"PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY\":member",
@@ -32905,7 +33049,7 @@
         {
           "kind": "Class",
           "canonicalReference": "server!ParticleEmitterManager:class",
-          "docComment": "/**\n * @remarks\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ParticleEmitterManager` class.\n */\n",
+          "docComment": "/**\n * Manages ParticleEmitter instances in a world.\n *\n * @remarks\n *\n * The ParticleEmitterManager is created internally as a singleton for each {@link World} instance in a game server. It allows retrieval of all loaded ParticleEmitter instances, entity attached ParticleEmitter instances, and more.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ParticleEmitterManager` class.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -33112,6 +33256,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!ParticleEmitterOptions#attachedToEntityNodeName:member",
+              "docComment": "/**\n * The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "attachedToEntityNodeName?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "attachedToEntityNodeName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!ParticleEmitterOptions#colorEnd:member",

package/server.d.ts

@@ -3593,8 +3593,13 @@ export declare interface NoneColliderOptions extends BaseColliderOptions {
 }
 
 /**
- * Represents a particle emitter in the world. Particle emitters emit 2D
- * particles in a world that always face the camera.
+ * Represents a particle emitter in the world. Emit 2D
+ * particles that always face the camera.
+ *
+ * @remarks
+ * Particle emitters are created directly as instances. They support a
+ * variety of configuration options through the {@link ParticleEmitterOptions}
+ * constructor argument.
  *
  * <h2>Events</h2>
  *
@@ -3639,6 +3644,7 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
 
 
 
+
 
 
     constructor(options: ParticleEmitterOptions);
@@ -3648,6 +3654,8 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
     get alphaTest(): number | undefined;
     /** The entity to which the ParticleEmitter is attached if explicitly set. */
     get attachedToEntity(): Entity | undefined;
+    /** The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to. */
+    get attachedToEntityNodeName(): string | undefined;
     /** The color of an emitted particle at the end of its lifetime. */
     get colorEnd(): RgbColor | undefined;
     /** The color variance of an emitted particle at the end of its lifetime. */
@@ -3712,6 +3720,12 @@ export declare class ParticleEmitter extends EventRouter implements protocol.Ser
      * @param entity - The entity to attach the ParticleEmitter to.
      */
     setAttachedToEntity(entity: Entity): void;
+    /**
+     * Sets the name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+     *
+     * @param attachedToEntityNodeName - The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+     */
+    setAttachedToEntityNodeName(attachedToEntityNodeName: string): void;
     /**
      * Sets the color of an emitted particle at the end of its lifetime.
      *
@@ -3878,6 +3892,7 @@ export declare enum ParticleEmitterEvent {
     DESPAWN = "PARTICLE_EMITTER.DESPAWN",
     SET_ALPHA_TEST = "PARTICLE_EMITTER.SET_ALPHA_TEST",
     SET_ATTACHED_TO_ENTITY = "PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY",
+    SET_ATTACHED_TO_ENTITY_NODE_NAME = "PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY_NODE_NAME",
     SET_COLOR_END = "PARTICLE_EMITTER.SET_COLOR_END",
     SET_COLOR_END_VARIANCE = "PARTICLE_EMITTER.SET_COLOR_END_VARIANCE",
     SET_COLOR_START = "PARTICLE_EMITTER.SET_COLOR_START",
@@ -3920,6 +3935,11 @@ export declare interface ParticleEmitterEventPayloads {
         particleEmitter: ParticleEmitter;
         entity: Entity;
     };
+    /** Emitted when the name of the node of the attached entity the particle emitter is attached to is set. */
+    [ParticleEmitterEvent.SET_ATTACHED_TO_ENTITY_NODE_NAME]: {
+        particleEmitter: ParticleEmitter;
+        attachedToEntityNodeName: string;
+    };
     /** Emitted when the color of an emitted particle at the end of its lifetime is set. */
     [ParticleEmitterEvent.SET_COLOR_END]: {
         particleEmitter: ParticleEmitter;
@@ -4041,6 +4061,17 @@ export declare interface ParticleEmitterEventPayloads {
     };
 }
 
+/**
+ * Manages ParticleEmitter instances in a world.
+ *
+ * @remarks
+ * The ParticleEmitterManager is created internally as a singleton
+ * for each {@link World} instance in a game server.
+ * It allows retrieval of all loaded ParticleEmitter instances,
+ * entity attached ParticleEmitter instances, and more.
+ *
+ * @public
+ */
 export declare class ParticleEmitterManager {
 
 
@@ -4073,6 +4104,8 @@ export declare interface ParticleEmitterOptions {
     alphaTest?: number;
     /** If set, the ParticleEmitter will be attached to this entity. */
     attachedToEntity?: Entity;
+    /** The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to. */
+    attachedToEntityNodeName?: string;
     /** The color of an emitted particle at the end of its lifetime. */
     colorEnd?: RgbColor;
     /** The color variance of an emitted particle at the end of its lifetime. */