hytopia 0.6.31 → 0.6.33

package/docs/server.particleemitterevent.md

@@ -0,0 +1,425 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterEvent](./server.particleemitterevent.md)
+
+## ParticleEmitterEvent enum
+
+Event types a ParticleEmitter instance can emit. See [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)
+
+**Signature:**
+
+```typescript
+export declare enum ParticleEmitterEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+DESPAWN
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.DESPAWN"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_ALPHA\_TEST
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_ALPHA_TEST"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_ATTACHED\_TO\_ENTITY
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.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>
+
+SET\_COLOR\_END
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_COLOR_END"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_COLOR\_END\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_COLOR_END_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_COLOR\_START
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_COLOR_START"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_COLOR\_START\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_COLOR_START_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_GRAVITY
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_GRAVITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_LIFETIME
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_LIFETIME"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_LIFETIME\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_LIFETIME_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_MAX\_PARTICLES
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_MAX_PARTICLES"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_OFFSET
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_OFFSET"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_OPACITY\_END
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_OPACITY_END"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_OPACITY\_END\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_OPACITY_END_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_OPACITY\_START
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_OPACITY_START"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_OPACITY\_START\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_OPACITY_START_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_POSITION
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_POSITION"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_POSITION\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_POSITION_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_RATE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_RATE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_RATE\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_RATE_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_SIZE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_SIZE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_SIZE\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_SIZE_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_TEXTURE\_URI
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_TEXTURE_URI"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_TRANSPARENT
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_TRANSPARENT"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_VELOCITY
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_VELOCITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_VELOCITY\_VARIANCE
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SET_VELOCITY_VARIANCE"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SPAWN
+
+
+</td><td>
+
+`"PARTICLE_EMITTER.SPAWN"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,15 @@
+<!-- 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.DESPAWN"](./server.particleemittereventpayloads._particle_emitter.despawn_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.DESPAWN" property
+
+Emitted when a ParticleEmitter is despawned.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.DESPAWN]: {
+        particleEmitter: ParticleEmitter;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_alpha_test_.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\_ALPHA\_TEST"](./server.particleemittereventpayloads._particle_emitter.set_alpha_test_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_ALPHA\_TEST" property
+
+Emitted when the alpha test value is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_ALPHA_TEST]: {
+        particleEmitter: ParticleEmitter;
+        alphaTest: number;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_attached_to_entity_.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"](./server.particleemittereventpayloads._particle_emitter.set_attached_to_entity_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_ATTACHED\_TO\_ENTITY" property
+
+Emitted when the ParticleEmitter is attached to an entity.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_ATTACHED_TO_ENTITY]: {
+        particleEmitter: ParticleEmitter;
+        entity: Entity;
+    };
+```

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._particle_emitter.set_color_end_.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\_COLOR\_END"](./server.particleemittereventpayloads._particle_emitter.set_color_end_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_COLOR\_END" property
+
+Emitted when the color of an emitted particle at the end of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_COLOR_END]: {
+        particleEmitter: ParticleEmitter;
+        colorEnd: RgbColor;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_color_end_variance_.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\_COLOR\_END\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_color_end_variance_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_COLOR\_END\_VARIANCE" property
+
+Emitted when the color variance of an emitted particle at the end of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_COLOR_END_VARIANCE]: {
+        particleEmitter: ParticleEmitter;
+        colorEndVariance: RgbColor;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_color_start_.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\_COLOR\_START"](./server.particleemittereventpayloads._particle_emitter.set_color_start_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_COLOR\_START" property
+
+Emitted when the color of an emitted particle at the start of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_COLOR_START]: {
+        particleEmitter: ParticleEmitter;
+        colorStart: RgbColor;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_color_start_variance_.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\_COLOR\_START\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_color_start_variance_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_COLOR\_START\_VARIANCE" property
+
+Emitted when the color variance of an emitted particle at the start of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_COLOR_START_VARIANCE]: {
+        particleEmitter: ParticleEmitter;
+        colorStartVariance: RgbColor;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_gravity_.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\_GRAVITY"](./server.particleemittereventpayloads._particle_emitter.set_gravity_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_GRAVITY" property
+
+Emitted when the gravity vector for an emitted particle is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_GRAVITY]: {
+        particleEmitter: ParticleEmitter;
+        gravity: Vector3Like;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_lifetime_.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\_LIFETIME"](./server.particleemittereventpayloads._particle_emitter.set_lifetime_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_LIFETIME" property
+
+Emitted when the lifetime of an emitted particle is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_LIFETIME]: {
+        particleEmitter: ParticleEmitter;
+        lifetime: number;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_lifetime_variance_.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\_LIFETIME\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_lifetime_variance_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_LIFETIME\_VARIANCE" property
+
+Emitted when the lifetime variance of an emitted particle is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_LIFETIME_VARIANCE]: {
+        particleEmitter: ParticleEmitter;
+        lifetimeVariance: number;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_max_particles_.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\_MAX\_PARTICLES"](./server.particleemittereventpayloads._particle_emitter.set_max_particles_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_MAX\_PARTICLES" property
+
+Emitted when the maximum number of live particles is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_MAX_PARTICLES]: {
+        particleEmitter: ParticleEmitter;
+        maxParticles: number;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_offset_.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\_OFFSET"](./server.particleemittereventpayloads._particle_emitter.set_offset_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_OFFSET" property
+
+Emitted when the offset of the particle emitter is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_OFFSET]: {
+        particleEmitter: ParticleEmitter;
+        offset: Vector3Like;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_opacity_end_.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\_OPACITY\_END"](./server.particleemittereventpayloads._particle_emitter.set_opacity_end_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_OPACITY\_END" property
+
+Emitted when the opacity of an emitted particle at the end of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_OPACITY_END]: {
+        particleEmitter: ParticleEmitter;
+        opacityEnd: number;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_opacity_end_variance_.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\_OPACITY\_END\_VARIANCE"](./server.particleemittereventpayloads._particle_emitter.set_opacity_end_variance_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_OPACITY\_END\_VARIANCE" property
+
+Emitted when the opacity variance of an emitted particle at the end of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_OPACITY_END_VARIANCE]: {
+        particleEmitter: ParticleEmitter;
+        opacityEndVariance: number;
+    };
+```

package/docs/server.particleemittereventpayloads._particle_emitter.set_opacity_start_.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\_OPACITY\_START"](./server.particleemittereventpayloads._particle_emitter.set_opacity_start_.md)
+
+## ParticleEmitterEventPayloads."PARTICLE\_EMITTER.SET\_OPACITY\_START" property
+
+Emitted when the opacity of an emitted particle at the start of its lifetime is set.
+
+**Signature:**
+
+```typescript
+[ParticleEmitterEvent.SET_OPACITY_START]: {
+        particleEmitter: ParticleEmitter;
+        opacityStart: number;
+    };
+```