hytopia 0.6.32 → 0.6.33

package/docs/server.md

@@ -288,11 +288,7 @@ Manages model data for all known models of the game.
 
 </td><td>
 
-Represents a particle emitter in the world. Particle emitters emit 2D particles in a world that always face the camera.
-
-<h2>Events</h2>
-
-This class is an EventRouter, and instance of it emit events with payloads listed under [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)<!-- -->.
+Represents a particle emitter in the world. Emit 2D particles that always face the camera.
 
 
 </td></tr>
@@ -303,6 +299,8 @@ This class is an EventRouter, and instance of it emit events with payloads liste
 
 </td><td>
 
+Manages ParticleEmitter instances in a world.
+
 
 </td></tr>
 <tr><td>

package/docs/server.particleemitter.attachedtoentitynodename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitter](./server.particleemitter.md) &gt; [attachedToEntityNodeName](./server.particleemitter.attachedtoentitynodename.md)
+
+## ParticleEmitter.attachedToEntityNodeName property
+
+The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+**Signature:**
+
+```typescript
+get attachedToEntityNodeName(): string | undefined;
+```

package/docs/server.particleemitter.md

@@ -4,11 +4,7 @@
 
 ## ParticleEmitter class
 
-Represents a particle emitter in the world. Particle emitters emit 2D particles in a world that always face the camera.
-
-<h2>Events</h2>
-
-This class is an EventRouter, and instance of it emit events with payloads listed under [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)<!-- -->.
+Represents a particle emitter in the world. Emit 2D particles that always face the camera.
 
 **Signature:**
 
@@ -19,6 +15,14 @@ export default class ParticleEmitter extends EventRouter implements protocol.Ser
 
 **Implements:** protocol.Serializable
 
+## Remarks
+
+Particle emitters are created directly as instances. They support a variety of configuration options through the [ParticleEmitterOptions](./server.particleemitteroptions.md) constructor argument.
+
+<h2>Events</h2>
+
+This class is an EventRouter, and instance of it emit events with payloads listed under [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)<!-- -->.
+
 ## Example
 
 
@@ -128,6 +132,27 @@ The alpha test value, discards particle texture pixels with alpha opacity less t
 The entity to which the ParticleEmitter is attached if explicitly set.
 
 
+</td></tr>
+<tr><td>
+
+[attachedToEntityNodeName](./server.particleemitter.attachedtoentitynodename.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+
 </td></tr>
 <tr><td>
 
@@ -771,6 +796,20 @@ Sets the alpha test value, discards particle texture pixels with alpha opacity l
 Sets the entity to which the ParticleEmitter is attached.
 
 
+</td></tr>
+<tr><td>
+
+[setAttachedToEntityNodeName(attachedToEntityNodeName)](./server.particleemitter.setattachedtoentitynodename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.particleemitter.setattachedtoentitynodename.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitter](./server.particleemitter.md) &gt; [setAttachedToEntityNodeName](./server.particleemitter.setattachedtoentitynodename.md)
+
+## ParticleEmitter.setAttachedToEntityNodeName() method
+
+Sets the name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+**Signature:**
+
+```typescript
+setAttachedToEntityNodeName(attachedToEntityNodeName: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+attachedToEntityNodeName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitterevent.md

@@ -71,6 +71,20 @@ SET\_ATTACHED\_TO\_ENTITY
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_ATTACHED\_TO\_ENTITY\_NODE\_NAME
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_ATTACHED_TO_ENTITY_NODE_NAME"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.particleemittereventpayloads._particle_emitter.set_attached_to_entity_node_name_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md) &gt; ["PARTICLE\_EMITTER.SET\_ATTACHED\_TO\_ENTITY\_NODE\_NAME"](./server.particleemittereventpayloads._particle_emitter.set_attached_to_entity_node_name_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_ATTACHED\_TO\_ENTITY\_NODE\_NAME" property
+
+Emitted when the name of the node of the attached entity the particle emitter is attached to is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_ATTACHED_TO_ENTITY_NODE_NAME]: {
+        particleEmitter: ParticleEmitter;
+        attachedToEntityNodeName: string;
+    };
+```

package/docs/server.particleemittereventpayloads.md

@@ -72,6 +72,25 @@ Emitted when a ParticleEmitter is despawned.
 Emitted when the alpha test value is set.
 
 
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_ATTACHED\_TO\_ENTITY\_NODE\_NAME"](./server.particleemittereventpayloads._particle_emitter.set_attached_to_entity_node_name_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; attachedToEntityNodeName: string; }
+
+
+</td><td>
+
+Emitted when the name of the node of the attached entity the particle emitter is attached to is set.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.particleemittermanager.md

@@ -4,6 +4,8 @@
 
 ## ParticleEmitterManager class
 
+Manages ParticleEmitter instances in a world.
+
 **Signature:**
 
 ```typescript
@@ -12,6 +14,8 @@ export default class ParticleEmitterManager
 
 ## Remarks
 
+The ParticleEmitterManager is created internally as a singleton for each [World](./server.world.md) instance in a game server. It allows retrieval of all loaded ParticleEmitter instances, entity attached ParticleEmitter instances, and more.
+
 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.
 
 ## Properties

package/docs/server.particleemitteroptions.attachedtoentitynodename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterOptions](./server.particleemitteroptions.md) &gt; [attachedToEntityNodeName](./server.particleemitteroptions.attachedtoentitynodename.md)
+
+## ParticleEmitterOptions.attachedToEntityNodeName property
+
+The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+**Signature:**
+
+```typescript
+attachedToEntityNodeName?: string;
+```

package/docs/server.particleemitteroptions.md

@@ -70,6 +70,25 @@ _(Optional)_ The alpha test value, discards particle texture pixels with alpha o
 _(Optional)_ If set, the ParticleEmitter will be attached to this entity.
 
 
+</td></tr>
+<tr><td>
+
+[attachedToEntityNodeName?](./server.particleemitteroptions.attachedtoentitynodename.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The name of the node of the attached entity (if the attached entity is a model entity) to attach the particle emitter to.
+
+
 </td></tr>
 <tr><td>