hytopia 0.6.31 → 0.6.33

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

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

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

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

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

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

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

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

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

package/docs/server.particleemitter.restart.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; [restart](./server.particleemitter.restart.md)
+
+## ParticleEmitter.restart() method
+
+Restarts the particle emission if it was previously stopped. Internally, this sets the rate to the value it was before being stopped.
+
+**Signature:**
+
+```typescript
+restart(): void;
+```
+**Returns:**
+
+void
+

package/docs/server.particleemitter.setalphatest.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; [setAlphaTest](./server.particleemitter.setalphatest.md)
+
+## ParticleEmitter.setAlphaTest() method
+
+Sets the alpha test value, discards particle texture pixels with alpha opacity less than this value.
+
+**Signature:**
+
+```typescript
+setAlphaTest(alphaTest: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+alphaTest
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The alpha test value, discards particle texture pixels with alpha opacity less than this value.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.setattachedtoentity.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; [setAttachedToEntity](./server.particleemitter.setattachedtoentity.md)
+
+## ParticleEmitter.setAttachedToEntity() method
+
+Sets the entity to which the ParticleEmitter is attached.
+
+**Signature:**
+
+```typescript
+setAttachedToEntity(entity: Entity): void;
+```
+
+## 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 attach the ParticleEmitter to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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.particleemitter.setcolorend.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; [setColorEnd](./server.particleemitter.setcolorend.md)
+
+## ParticleEmitter.setColorEnd() method
+
+Sets the color of an emitted particle at the end of its lifetime.
+
+**Signature:**
+
+```typescript
+setColorEnd(colorEnd: RgbColor): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colorEnd
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color of an emitted particle at the end of its lifetime.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.setcolorendvariance.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; [setColorEndVariance](./server.particleemitter.setcolorendvariance.md)
+
+## ParticleEmitter.setColorEndVariance() method
+
+Sets the color variance of an emitted particle at the end of its lifetime.
+
+**Signature:**
+
+```typescript
+setColorEndVariance(colorEndVariance: RgbColor): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colorEndVariance
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color variance of an emitted particle at the end of its lifetime.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.setcolorstart.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; [setColorStart](./server.particleemitter.setcolorstart.md)
+
+## ParticleEmitter.setColorStart() method
+
+Sets the color of an emitted particle at the start of its lifetime.
+
+**Signature:**
+
+```typescript
+setColorStart(colorStart: RgbColor): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colorStart
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color of an emitted particle at the start of its lifetime.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.particleemitter.setcolorstartvariance.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; [setColorStartVariance](./server.particleemitter.setcolorstartvariance.md)
+
+## ParticleEmitter.setColorStartVariance() method
+
+Sets the color variance of an emitted particle at the start of its lifetime.
+
+**Signature:**
+
+```typescript
+setColorStartVariance(colorStartVariance: RgbColor): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+colorStartVariance
+
+
+</td><td>
+
+[RgbColor](./server.rgbcolor.md)
+
+
+</td><td>
+
+The color variance of an emitted particle at the start of its lifetime.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

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

package/docs/server.particleemitter.setlifetimevariance.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; [setLifetimeVariance](./server.particleemitter.setlifetimevariance.md)
+
+## ParticleEmitter.setLifetimeVariance() method
+
+Sets the lifetime variance of an emitted particle in seconds.
+
+**Signature:**
+
+```typescript
+setLifetimeVariance(lifetimeVariance: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+lifetimeVariance
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The lifetime variance of an emitted particle in seconds.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+