hytopia 0.6.31 → 0.6.33

package/docs/server.particleemittereventpayloads.md

@@ -0,0 +1,570 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)
+
+## ParticleEmitterEventPayloads interface
+
+Event payloads for ParticleEmitter emitted events.
+
+**Signature:**
+
+```typescript
+export interface ParticleEmitterEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["PARTICLE\_EMITTER.DESPAWN"](./server.particleemittereventpayloads._particle_emitter.despawn_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a ParticleEmitter is despawned.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_ALPHA\_TEST"](./server.particleemittereventpayloads._particle_emitter.set_alpha_test_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; alphaTest: number; }
+
+
+</td><td>
+
+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>
+
+["PARTICLE\_EMITTER.SET\_ATTACHED\_TO\_ENTITY"](./server.particleemittereventpayloads._particle_emitter.set_attached_to_entity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the ParticleEmitter is attached to an entity.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_COLOR\_END\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_color_end_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; colorEndVariance: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color variance of an emitted particle at the end of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_COLOR\_END"](./server.particleemittereventpayloads._particle_emitter.set_color_end_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; colorEnd: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color of an emitted particle at the end of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_COLOR\_START\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_color_start_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; colorStartVariance: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color variance of an emitted particle at the start of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_COLOR\_START"](./server.particleemittereventpayloads._particle_emitter.set_color_start_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; colorStart: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color of an emitted particle at the start of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_GRAVITY"](./server.particleemittereventpayloads._particle_emitter.set_gravity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; gravity: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the gravity vector for an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_LIFETIME\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_lifetime_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; lifetimeVariance: number; }
+
+
+</td><td>
+
+Emitted when the lifetime variance of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_LIFETIME"](./server.particleemittereventpayloads._particle_emitter.set_lifetime_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; lifetime: number; }
+
+
+</td><td>
+
+Emitted when the lifetime of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_MAX\_PARTICLES"](./server.particleemittereventpayloads._particle_emitter.set_max_particles_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; maxParticles: number; }
+
+
+</td><td>
+
+Emitted when the maximum number of live particles is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_OFFSET"](./server.particleemittereventpayloads._particle_emitter.set_offset_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; offset: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the offset of the particle emitter is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_OPACITY\_END\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_opacity_end_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; opacityEndVariance: number; }
+
+
+</td><td>
+
+Emitted when the opacity variance of an emitted particle at the end of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_OPACITY\_END"](./server.particleemittereventpayloads._particle_emitter.set_opacity_end_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; opacityEnd: number; }
+
+
+</td><td>
+
+Emitted when the opacity of an emitted particle at the end of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_OPACITY\_START\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_opacity_start_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; opacityStartVariance: number; }
+
+
+</td><td>
+
+Emitted when the opacity variance of an emitted particle at the start of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_OPACITY\_START"](./server.particleemittereventpayloads._particle_emitter.set_opacity_start_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; opacityStart: number; }
+
+
+</td><td>
+
+Emitted when the opacity of an emitted particle at the start of its lifetime is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_POSITION\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_position_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; positionVariance: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the position variance of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_POSITION"](./server.particleemittereventpayloads._particle_emitter.set_position_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; position: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the position of the particle emitter is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_RATE\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_rate_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; rateVariance: number; }
+
+
+</td><td>
+
+Emitted when the rate per second variance of the particle emission rate is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_RATE"](./server.particleemittereventpayloads._particle_emitter.set_rate_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; rate: number; }
+
+
+</td><td>
+
+Emitted when the rate per second at which particles are emitted is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_SIZE\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_size_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; sizeVariance: number; }
+
+
+</td><td>
+
+Emitted when the size variance of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_SIZE"](./server.particleemittereventpayloads._particle_emitter.set_size_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; size: number; }
+
+
+</td><td>
+
+Emitted when the size of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_TEXTURE\_URI"](./server.particleemittereventpayloads._particle_emitter.set_texture_uri_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; textureUri: string; }
+
+
+</td><td>
+
+Emitted when the texture URI is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_TRANSPARENT"](./server.particleemittereventpayloads._particle_emitter.set_transparent_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; transparent: boolean; }
+
+
+</td><td>
+
+Emitted when the transparency of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_VELOCITY\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_velocity_variance_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; velocityVariance: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the velocity variance of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SET\_VELOCITY"](./server.particleemittereventpayloads._particle_emitter.set_velocity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; velocity: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the velocity of an emitted particle is set.
+
+
+</td></tr>
+<tr><td>
+
+["PARTICLE\_EMITTER.SPAWN"](./server.particleemittereventpayloads._particle_emitter.spawn_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ particleEmitter: [ParticleEmitter](./server.particleemitter.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when a ParticleEmitter is spawned.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.particleemittermanager.getallentityattachedparticleemitters.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterManager](./server.particleemittermanager.md) &gt; [getAllEntityAttachedParticleEmitters](./server.particleemittermanager.getallentityattachedparticleemitters.md)
+
+## ParticleEmitterManager.getAllEntityAttachedParticleEmitters() method
+
+Retrieves all spawned ParticleEmitter instances attached to a specific entity.
+
+**Signature:**
+
+```typescript
+getAllEntityAttachedParticleEmitters(entity: Entity): ParticleEmitter[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+entity
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+The entity to get attached ParticleEmitter instances for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ParticleEmitter](./server.particleemitter.md)<!-- -->\[\]
+
+An array of ParticleEmitter instances.
+

package/docs/server.particleemittermanager.getallparticleemitters.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterManager](./server.particleemittermanager.md) &gt; [getAllParticleEmitters](./server.particleemittermanager.getallparticleemitters.md)
+
+## ParticleEmitterManager.getAllParticleEmitters() method
+
+Retrieves all spawned ParticleEmitter instances for the world.
+
+**Signature:**
+
+```typescript
+getAllParticleEmitters(): ParticleEmitter[];
+```
+**Returns:**
+
+[ParticleEmitter](./server.particleemitter.md)<!-- -->\[\]
+
+An array of ParticleEmitter instances.
+