hytopia
Version:
The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.
122 lines (56 loc) • 2.04 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [server](./server.md) > [ParticleEmitterManager](./server.particleemittermanager.md)
## ParticleEmitterManager class
Manages ParticleEmitter instances in a world.
When to use: querying or bulk-cleaning particle emitters for a world. Do NOT use for: configuring emitters; use `ParticleEmitter` instances directly.
**Signature:**
```typescript
export default class ParticleEmitterManager
```
## Remarks
The ParticleEmitterManager is created internally per `World` instance. Pattern: spawn emitters during gameplay and use this manager for cleanup on entity despawn.
\*\*Category:\*\* Particles
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.
\*\*Category:\*\* Particles
</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.
Use for: cleanup or inspection of entity-bound emitters.
</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>