hytopia 0.6.31 → 0.6.33

package/docs/server.eventpayloads.md

@@ -9,7 +9,7 @@ The payloads for all events in the game server.
 **Signature:**
 
 ```typescript
-export interface EventPayloads extends AudioEventPayloads, BaseEntityControllerEventPayloads, BlockTypeEventPayloads, BlockTypeRegistryEventPayloads, ChatEventPayloads, ChunkEventPayloads, ConnectionEventPayloads, EntityEventPayloads, GameServerEventPayloads, PlayerCameraEventPayloads, PlayerEventPayloads, PlayerManagerEventPayloads, PlayerUIEventPayloads, SceneUIEventPayloads, SimulationEventPayloads, SocketEventPayloads, LightEventPayloads, WebServerEventPayloads, WorldEventPayloads, WorldLoopEventPayloads, WorldManagerEventPayloads 
+export interface EventPayloads extends AudioEventPayloads, BaseEntityControllerEventPayloads, BlockTypeEventPayloads, BlockTypeRegistryEventPayloads, ChatEventPayloads, ChunkEventPayloads, ConnectionEventPayloads, EntityEventPayloads, GameServerEventPayloads, ParticleEmitterEventPayloads, PlayerCameraEventPayloads, PlayerEventPayloads, PlayerManagerEventPayloads, PlayerUIEventPayloads, SceneUIEventPayloads, SimulationEventPayloads, SocketEventPayloads, LightEventPayloads, WebServerEventPayloads, WorldEventPayloads, WorldLoopEventPayloads, WorldManagerEventPayloads 
 ```
-**Extends:** [AudioEventPayloads](./server.audioeventpayloads.md)<!-- -->, [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md)<!-- -->, [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md)<!-- -->, [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md)<!-- -->, [ChatEventPayloads](./server.chateventpayloads.md)<!-- -->, [ChunkEventPayloads](./server.chunkeventpayloads.md)<!-- -->, ConnectionEventPayloads, [EntityEventPayloads](./server.entityeventpayloads.md)<!-- -->, [GameServerEventPayloads](./server.gameservereventpayloads.md)<!-- -->, [PlayerCameraEventPayloads](./server.playercameraeventpayloads.md)<!-- -->, [PlayerEventPayloads](./server.playereventpayloads.md)<!-- -->, [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)<!-- -->, [PlayerUIEventPayloads](./server.playeruieventpayloads.md)<!-- -->, [SceneUIEventPayloads](./server.sceneuieventpayloads.md)<!-- -->, [SimulationEventPayloads](./server.simulationeventpayloads.md)<!-- -->, SocketEventPayloads, [LightEventPayloads](./server.lighteventpayloads.md)<!-- -->, WebServerEventPayloads, [WorldEventPayloads](./server.worldeventpayloads.md)<!-- -->, [WorldLoopEventPayloads](./server.worldloopeventpayloads.md)<!-- -->, [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md)
+**Extends:** [AudioEventPayloads](./server.audioeventpayloads.md)<!-- -->, [BaseEntityControllerEventPayloads](./server.baseentitycontrollereventpayloads.md)<!-- -->, [BlockTypeEventPayloads](./server.blocktypeeventpayloads.md)<!-- -->, [BlockTypeRegistryEventPayloads](./server.blocktyperegistryeventpayloads.md)<!-- -->, [ChatEventPayloads](./server.chateventpayloads.md)<!-- -->, [ChunkEventPayloads](./server.chunkeventpayloads.md)<!-- -->, ConnectionEventPayloads, [EntityEventPayloads](./server.entityeventpayloads.md)<!-- -->, [GameServerEventPayloads](./server.gameservereventpayloads.md)<!-- -->, [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)<!-- -->, [PlayerCameraEventPayloads](./server.playercameraeventpayloads.md)<!-- -->, [PlayerEventPayloads](./server.playereventpayloads.md)<!-- -->, [PlayerManagerEventPayloads](./server.playermanagereventpayloads.md)<!-- -->, [PlayerUIEventPayloads](./server.playeruieventpayloads.md)<!-- -->, [SceneUIEventPayloads](./server.sceneuieventpayloads.md)<!-- -->, [SimulationEventPayloads](./server.simulationeventpayloads.md)<!-- -->, SocketEventPayloads, [LightEventPayloads](./server.lighteventpayloads.md)<!-- -->, WebServerEventPayloads, [WorldEventPayloads](./server.worldeventpayloads.md)<!-- -->, [WorldLoopEventPayloads](./server.worldloopeventpayloads.md)<!-- -->, [WorldManagerEventPayloads](./server.worldmanagereventpayloads.md)
 

package/docs/server.light.md

@@ -572,7 +572,7 @@ Sets the position the spotlight will constantly point at if the light type is sp
 
 </td><td>
 
-Spawns the Light into the world.
+Spawns the Light in the world.
 
 
 </td></tr>

package/docs/server.light.spawn.md

@@ -4,7 +4,7 @@
 
 ## Light.spawn() method
 
-Spawns the Light into the world.
+Spawns the Light in the world.
 
 **Signature:**
 
@@ -42,7 +42,7 @@ world
 
 </td><td>
 
-The world to spawn the Light into.
+The world to spawn the Light in.
 
 
 </td></tr>

package/docs/server.md

@@ -280,6 +280,28 @@ Represents a 4x4 matrix.
 Manages model data for all known models of the game.
 
 
+</td></tr>
+<tr><td>
+
+[ParticleEmitter](./server.particleemitter.md)
+
+
+</td><td>
+
+Represents a particle emitter in the world. Emit 2D particles that always face the camera.
+
+
+</td></tr>
+<tr><td>
+
+[ParticleEmitterManager](./server.particleemittermanager.md)
+
+
+</td><td>
+
+Manages ParticleEmitter instances in a world.
+
+
 </td></tr>
 <tr><td>
 
@@ -662,6 +684,17 @@ Event types a Light instance can emit. See [LightEventPayloads](./server.lightev
 The types a Light can be.
 
 
+</td></tr>
+<tr><td>
+
+[ParticleEmitterEvent](./server.particleemitterevent.md)
+
+
+</td><td>
+
+Event types a ParticleEmitter instance can emit. See [ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)
+
+
 </td></tr>
 <tr><td>
 
@@ -1143,6 +1176,26 @@ The options for creating a model entity.
 The options for an error type "none" collider.
 
 
+</td></tr>
+<tr><td>
+
+[ParticleEmitterEventPayloads](./server.particleemittereventpayloads.md)
+
+
+</td><td>
+
+Event payloads for ParticleEmitter emitted events.
+
+
+</td></tr>
+<tr><td>
+
+[ParticleEmitterOptions](./server.particleemitteroptions.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.particleemitter._constructor_.md

@@ -0,0 +1,47 @@
+<!-- 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; [(constructor)](./server.particleemitter._constructor_.md)
+
+## ParticleEmitter.(constructor)
+
+Constructs a new instance of the `ParticleEmitter` class
+
+**Signature:**
+
+```typescript
+constructor(options: ParticleEmitterOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[ParticleEmitterOptions](./server.particleemitteroptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.particleemitter.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; [ParticleEmitter](./server.particleemitter.md) &gt; [alphaTest](./server.particleemitter.alphatest.md)
+
+## ParticleEmitter.alphaTest property
+
+The alpha test value, discards particle texture pixels with alpha opacity less than this value.
+
+**Signature:**
+
+```typescript
+get alphaTest(): number | undefined;
+```

package/docs/server.particleemitter.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; [ParticleEmitter](./server.particleemitter.md) &gt; [attachedToEntity](./server.particleemitter.attachedtoentity.md)
+
+## ParticleEmitter.attachedToEntity property
+
+The entity to which the ParticleEmitter is attached if explicitly set.
+
+**Signature:**
+
+```typescript
+get attachedToEntity(): Entity | undefined;
+```

package/docs/server.particleemitter.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; [ParticleEmitter](./server.particleemitter.md) &gt; [attachedToEntityNodeName](./server.particleemitter.attachedtoentitynodename.md)
+
+## ParticleEmitter.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
+get attachedToEntityNodeName(): string | undefined;
+```

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

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

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

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

package/docs/server.particleemitter.despawn.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; [despawn](./server.particleemitter.despawn.md)
+
+## ParticleEmitter.despawn() method
+
+Despawns the ParticleEmitter from the world.
+
+**Signature:**
+
+```typescript
+despawn(): void;
+```
+**Returns:**
+
+void
+

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

package/docs/server.particleemitter.id.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; [id](./server.particleemitter.id.md)
+
+## ParticleEmitter.id property
+
+The unique identifier for the ParticlEmitter.
+
+**Signature:**
+
+```typescript
+get id(): number | undefined;
+```

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

package/docs/server.particleemitter.isstopped.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; [isStopped](./server.particleemitter.isstopped.md)
+
+## ParticleEmitter.isStopped property
+
+Whether the ParticleEmitter is stopped.
+
+**Signature:**
+
+```typescript
+get isStopped(): boolean;
+```

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

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

package/docs/server.particleemitter.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; [ParticleEmitter](./server.particleemitter.md) &gt; [maxParticles](./server.particleemitter.maxparticles.md)
+
+## ParticleEmitter.maxParticles property
+
+The maximum number of live particles.
+
+**Signature:**
+
+```typescript
+get maxParticles(): number | undefined;
+```