hytopia 0.6.31 → 0.6.33

package/docs/server.particleemitteroptions.md

@@ -0,0 +1,530 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterOptions](./server.particleemitteroptions.md)
+
+## ParticleEmitterOptions interface
+
+**Signature:**
+
+```typescript
+export interface ParticleEmitterOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[alphaTest?](./server.particleemitteroptions.alphatest.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The alpha test value, discards particle texture pixels with alpha opacity less than this value. Defaults to 0.5.
+
+
+</td></tr>
+<tr><td>
+
+[attachedToEntity?](./server.particleemitteroptions.attachedtoentity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+_(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>
+
+[colorEnd?](./server.particleemitteroptions.colorend.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+_(Optional)_ The color of an emitted particle at the end of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[colorEndVariance?](./server.particleemitteroptions.colorendvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+_(Optional)_ The color variance of an emitted particle at the end of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[colorStart?](./server.particleemitteroptions.colorstart.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+_(Optional)_ The color of an emitted particle at the start of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[colorStartVariance?](./server.particleemitteroptions.colorstartvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+_(Optional)_ The color variance of an emitted particle at the start of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[gravity?](./server.particleemitteroptions.gravity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The gravity vector for an emitted particle.
+
+
+</td></tr>
+<tr><td>
+
+[lifetime?](./server.particleemitteroptions.lifetime.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The lifetime of an emitted particle in seconds.
+
+
+</td></tr>
+<tr><td>
+
+[lifetimeVariance?](./server.particleemitteroptions.lifetimevariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The lifetime variance of an emitted particle in seconds.
+
+
+</td></tr>
+<tr><td>
+
+[maxParticles?](./server.particleemitteroptions.maxparticles.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The maximum number of live particles.
+
+
+</td></tr>
+<tr><td>
+
+[offset?](./server.particleemitteroptions.offset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The offset of the particle emitter from the attached entity or position.
+
+
+</td></tr>
+<tr><td>
+
+[opacityEnd?](./server.particleemitteroptions.opacityend.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The opacity of an emitted particle at the end of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[opacityEndVariance?](./server.particleemitteroptions.opacityendvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The opacity variance of an emitted particle at the end of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[opacityStart?](./server.particleemitteroptions.opacitystart.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The opacity of an emitted particle at the start of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[opacityStartVariance?](./server.particleemitteroptions.opacitystartvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The opacity variance of an emitted particle at the start of its lifetime.
+
+
+</td></tr>
+<tr><td>
+
+[position?](./server.particleemitteroptions.position.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The position of the particle emitter in the world if explicitly set.
+
+
+</td></tr>
+<tr><td>
+
+[positionVariance?](./server.particleemitteroptions.positionvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The position variance of an emitted particle.
+
+
+</td></tr>
+<tr><td>
+
+[rate?](./server.particleemitteroptions.rate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The rate per second at which particles are emitted.
+
+
+</td></tr>
+<tr><td>
+
+[rateVariance?](./server.particleemitteroptions.ratevariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The rate per second variance of the particle emission rate.
+
+
+</td></tr>
+<tr><td>
+
+[size?](./server.particleemitteroptions.size.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The size of an emitted particle.
+
+
+</td></tr>
+<tr><td>
+
+[sizeVariance?](./server.particleemitteroptions.sizevariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The size variance of an emitted particle.
+
+
+</td></tr>
+<tr><td>
+
+[textureUri](./server.particleemitteroptions.textureuri.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI or path to the texture to be used for the particles.
+
+
+</td></tr>
+<tr><td>
+
+[transparent?](./server.particleemitteroptions.transparent.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether an emitted particle is transparent, resulting in smoother transparency blending.
+
+
+</td></tr>
+<tr><td>
+
+[velocity?](./server.particleemitteroptions.velocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The velocity of an emitted particle.
+
+
+</td></tr>
+<tr><td>
+
+[velocityVariance?](./server.particleemitteroptions.velocityvariance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The velocity variance of an emitted particle.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.particleemitteroptions.offset.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; [offset](./server.particleemitteroptions.offset.md)
+
+## ParticleEmitterOptions.offset property
+
+The offset of the particle emitter from the attached entity or position.
+
+**Signature:**
+
+```typescript
+offset?: Vector3Like;
+```

package/docs/server.particleemitteroptions.opacityend.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; [opacityEnd](./server.particleemitteroptions.opacityend.md)
+
+## ParticleEmitterOptions.opacityEnd property
+
+The opacity of an emitted particle at the end of its lifetime.
+
+**Signature:**
+
+```typescript
+opacityEnd?: number;
+```

package/docs/server.particleemitteroptions.opacityendvariance.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; [opacityEndVariance](./server.particleemitteroptions.opacityendvariance.md)
+
+## ParticleEmitterOptions.opacityEndVariance property
+
+The opacity variance of an emitted particle at the end of its lifetime.
+
+**Signature:**
+
+```typescript
+opacityEndVariance?: number;
+```

package/docs/server.particleemitteroptions.opacitystart.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; [opacityStart](./server.particleemitteroptions.opacitystart.md)
+
+## ParticleEmitterOptions.opacityStart property
+
+The opacity of an emitted particle at the start of its lifetime.
+
+**Signature:**
+
+```typescript
+opacityStart?: number;
+```

package/docs/server.particleemitteroptions.opacitystartvariance.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; [opacityStartVariance](./server.particleemitteroptions.opacitystartvariance.md)
+
+## ParticleEmitterOptions.opacityStartVariance property
+
+The opacity variance of an emitted particle at the start of its lifetime.
+
+**Signature:**
+
+```typescript
+opacityStartVariance?: number;
+```

package/docs/server.particleemitteroptions.position.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; [position](./server.particleemitteroptions.position.md)
+
+## ParticleEmitterOptions.position property
+
+The position of the particle emitter in the world if explicitly set.
+
+**Signature:**
+
+```typescript
+position?: Vector3Like;
+```

package/docs/server.particleemitteroptions.positionvariance.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; [positionVariance](./server.particleemitteroptions.positionvariance.md)
+
+## ParticleEmitterOptions.positionVariance property
+
+The position variance of an emitted particle.
+
+**Signature:**
+
+```typescript
+positionVariance?: Vector3Like;
+```

package/docs/server.particleemitteroptions.rate.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; [rate](./server.particleemitteroptions.rate.md)
+
+## ParticleEmitterOptions.rate property
+
+The rate per second at which particles are emitted.
+
+**Signature:**
+
+```typescript
+rate?: number;
+```

package/docs/server.particleemitteroptions.ratevariance.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; [rateVariance](./server.particleemitteroptions.ratevariance.md)
+
+## ParticleEmitterOptions.rateVariance property
+
+The rate per second variance of the particle emission rate.
+
+**Signature:**
+
+```typescript
+rateVariance?: number;
+```

package/docs/server.particleemitteroptions.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; [ParticleEmitterOptions](./server.particleemitteroptions.md) &gt; [size](./server.particleemitteroptions.size.md)
+
+## ParticleEmitterOptions.size property
+
+The size of an emitted particle.
+
+**Signature:**
+
+```typescript
+size?: number;
+```

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

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

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