hytopia 0.6.30 → 0.6.32

package/docs/server.particleemitter.setvelocity.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; [setVelocity](./server.particleemitter.setvelocity.md)
+
+## ParticleEmitter.setVelocity() method
+
+Sets the velocity of an emitted particle.
+
+**Signature:**
+
+```typescript
+setVelocity(velocity: Vector3Like): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+velocity
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The velocity of an emitted particle.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.setvelocityvariance.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; [setVelocityVariance](./server.particleemitter.setvelocityvariance.md)
+
+## ParticleEmitter.setVelocityVariance() method
+
+Sets the velocity variance of an emitted particle.
+
+**Signature:**
+
+```typescript
+setVelocityVariance(velocityVariance: Vector3Like): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+velocityVariance
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The velocity variance of an emitted particle.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.size.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; [size](./server.particleemitter.size.md)
+
+## ParticleEmitter.size property
+
+The size of an emitted particle.
+
+**Signature:**
+
+```typescript
+get size(): number | undefined;
+```

package/docs/server.particleemitter.sizevariance.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; [sizeVariance](./server.particleemitter.sizevariance.md)
+
+## ParticleEmitter.sizeVariance property
+
+The size variance of an emitted particle.
+
+**Signature:**
+
+```typescript
+get sizeVariance(): number | undefined;
+```

package/docs/server.particleemitter.spawn.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; [spawn](./server.particleemitter.spawn.md)
+
+## ParticleEmitter.spawn() method
+
+Spawns the ParticleEmitter in the world.
+
+**Signature:**
+
+```typescript
+spawn(world: World): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+world
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world to spawn the ParticleEmitter in.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.stop.md

@@ -0,0 +1,17 @@
+<!-- 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; [stop](./server.particleemitter.stop.md)
+
+## ParticleEmitter.stop() method
+
+Stops the particle emission if it was previously started. Internally, this sets the rate to 0.
+
+**Signature:**
+
+```typescript
+stop(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.particleemitter.textureuri.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; [textureUri](./server.particleemitter.textureuri.md)
+
+## ParticleEmitter.textureUri property
+
+The URI or path to the texture to be used for the particles.
+
+**Signature:**
+
+```typescript
+get textureUri(): string;
+```

package/docs/server.particleemitter.transparent.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; [transparent](./server.particleemitter.transparent.md)
+
+## ParticleEmitter.transparent property
+
+Whether an emitted particle is transparent, resulting in smoother transparency blending.
+
+**Signature:**
+
+```typescript
+get transparent(): boolean | undefined;
+```

package/docs/server.particleemitter.velocity.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; [velocity](./server.particleemitter.velocity.md)
+
+## ParticleEmitter.velocity property
+
+The velocity of an emitted particle.
+
+**Signature:**
+
+```typescript
+get velocity(): Vector3Like | undefined;
+```

package/docs/server.particleemitter.velocityvariance.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; [velocityVariance](./server.particleemitter.velocityvariance.md)
+
+## ParticleEmitter.velocityVariance property
+
+The velocity variance of an emitted particle.
+
+**Signature:**
+
+```typescript
+get velocityVariance(): Vector3Like | undefined;
+```

package/docs/server.particleemitter.world.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; [world](./server.particleemitter.world.md)
+
+## ParticleEmitter.world property
+
+The world the ParticleEmitter is in.
+
+**Signature:**
+
+```typescript
+get world(): World | undefined;
+```

package/docs/server.particleemitterevent.md

@@ -0,0 +1,411 @@
+<!-- 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\_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;
+    };
+```