hytopia 0.6.31 → 0.6.33

package/docs/server.particleemittermanager.md

@@ -0,0 +1,113 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ParticleEmitterManager](./server.particleemittermanager.md)
+
+## ParticleEmitterManager class
+
+Manages ParticleEmitter instances in a world.
+
+**Signature:**
+
+```typescript
+export default class ParticleEmitterManager 
+```
+
+## Remarks
+
+The ParticleEmitterManager is created internally as a singleton for each [World](./server.world.md) instance in a game server. It allows retrieval of all loaded ParticleEmitter instances, entity attached ParticleEmitter instances, and more.
+
+The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `ParticleEmitterManager` class.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[world](./server.particleemittermanager.world.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world the ParticleEmitterManager is for.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getAllEntityAttachedParticleEmitters(entity)](./server.particleemittermanager.getallentityattachedparticleemitters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves all spawned ParticleEmitter instances attached to a specific entity.
+
+
+</td></tr>
+<tr><td>
+
+[getAllParticleEmitters()](./server.particleemittermanager.getallparticleemitters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves all spawned ParticleEmitter instances for the world.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.particleemittermanager.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; [ParticleEmitterManager](./server.particleemittermanager.md) &gt; [world](./server.particleemittermanager.world.md)
+
+## ParticleEmitterManager.world property
+
+The world the ParticleEmitterManager is for.
+
+**Signature:**
+
+```typescript
+get world(): World;
+```

package/docs/server.particleemitteroptions.alphatest.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; [alphaTest](./server.particleemitteroptions.alphatest.md)
+
+## ParticleEmitterOptions.alphaTest property
+
+The alpha test value, discards particle texture pixels with alpha opacity less than this value. Defaults to 0.5.
+
+**Signature:**
+
+```typescript
+alphaTest?: number;
+```

package/docs/server.particleemitteroptions.attachedtoentity.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; [attachedToEntity](./server.particleemitteroptions.attachedtoentity.md)
+
+## ParticleEmitterOptions.attachedToEntity property
+
+If set, the ParticleEmitter will be attached to this entity.
+
+**Signature:**
+
+```typescript
+attachedToEntity?: Entity;
+```

package/docs/server.particleemitteroptions.attachedtoentitynodename.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; [attachedToEntityNodeName](./server.particleemitteroptions.attachedtoentitynodename.md)
+
+## ParticleEmitterOptions.attachedToEntityNodeName property
+
+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
+attachedToEntityNodeName?: string;
+```

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

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

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

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

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

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

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

package/docs/server.particleemitteroptions.maxparticles.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; [maxParticles](./server.particleemitteroptions.maxparticles.md)
+
+## ParticleEmitterOptions.maxParticles property
+
+The maximum number of live particles.
+
+**Signature:**
+
+```typescript
+maxParticles?: number;
+```