hytopia 0.2.10 → 0.3.0-dev.2

package/docs/server.entityeventpayloads.md

@@ -0,0 +1,361 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayloads](./server.entityeventpayloads.md)
+
+## EntityEventPayloads interface
+
+Event payloads for Entity emitted events.
+
+**Signature:**
+
+```typescript
+export interface EntityEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["ENTITY.BLOCK\_COLLISION"](./server.entityeventpayloads._entity.block_collision_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; blockType: [BlockType](./server.blocktype.md)<!-- -->; started: boolean; colliderHandleA: number; colliderHandleB: number; }
+
+
+</td><td>
+
+Emitted when an entity collides with a block type.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.BLOCK\_CONTACT\_FORCE"](./server.entityeventpayloads._entity.block_contact_force_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; blockType: [BlockType](./server.blocktype.md)<!-- -->; contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity's contact force is applied to a block type.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.DESPAWN"](./server.entityeventpayloads._entity.despawn_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity is despawned.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.ENTITY\_COLLISION"](./server.entityeventpayloads._entity.entity_collision_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; otherEntity: [Entity](./server.entity.md)<!-- -->; started: boolean; colliderHandleA: number; colliderHandleB: number; }
+
+
+</td><td>
+
+Emitted when an entity collides with another entity.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.ENTITY\_CONTACT\_FORCE"](./server.entityeventpayloads._entity.entity_contact_force_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; otherEntity: [Entity](./server.entity.md)<!-- -->; contactForceData: [ContactForceData](./server.contactforcedata.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when an entity's contact force is applied to another entity.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_MODEL\_ANIMATIONS\_PLAYBACK\_RATE"](./server.entityeventpayloads._entity.set_model_animations_playback_rate_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; playbackRate: number; }
+
+
+</td><td>
+
+Emitted when the playback rate of the entity's model animations is set.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_MODEL\_HIDDEN\_NODES"](./server.entityeventpayloads._entity.set_model_hidden_nodes_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; modelHiddenNodes: Set&lt;string&gt;; }
+
+
+</td><td>
+
+Emitted when the nodes of the entity's model are set to be hidden.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_OPACITY"](./server.entityeventpayloads._entity.set_opacity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; opacity: number; }
+
+
+</td><td>
+
+Emitted when the opacity of the entity is set.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_PARENT"](./server.entityeventpayloads._entity.set_parent_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; parent: [Entity](./server.entity.md) \| undefined; parentNodeName: string \| undefined; }
+
+
+</td><td>
+
+Emitted when the parent of the entity is set.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.SET\_TINT\_COLOR"](./server.entityeventpayloads._entity.set_tint_color_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; tintColor: [RgbColor](./server.rgbcolor.md) \| undefined; }
+
+
+</td><td>
+
+Emitted when the tint color of the entity is set.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.SPAWN"](./server.entityeventpayloads._entity.spawn_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the entity is spawned.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.START\_MODEL\_LOOPED\_ANIMATIONS"](./server.entityeventpayloads._entity.start_model_looped_animations_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; animations: Set&lt;string&gt;; }
+
+
+</td><td>
+
+Emitted when the looped animations of the entity's model are started.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.START\_MODEL\_ONESHOT\_ANIMATIONS"](./server.entityeventpayloads._entity.start_model_oneshot_animations_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; animations: Set&lt;string&gt;; }
+
+
+</td><td>
+
+Emitted when the oneshot animations of the entity's model are started.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.STOP\_MODEL\_ANIMATIONS"](./server.entityeventpayloads._entity.stop_model_animations_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; animations: Set&lt;string&gt;; }
+
+
+</td><td>
+
+Emitted when the model animations of the entity are stopped.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.TICK"](./server.entityeventpayloads._entity.tick_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; tickDeltaMs: number; }
+
+
+</td><td>
+
+Emitted when the entity is ticked.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.UPDATE\_POSITION"](./server.entityeventpayloads._entity.update_position_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; position: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the position of the entity is updated at the end of the tick, either directly or by physics.
+
+
+</td></tr>
+<tr><td>
+
+["ENTITY.UPDATE\_ROTATION"](./server.entityeventpayloads._entity.update_rotation_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ entity: [Entity](./server.entity.md)<!-- -->; rotation: [QuaternionLike](./server.quaternionlike.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the rotation of the entity is updated at the end of the tick, either directly or by physics.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.eventpayloads.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventPayloads](./server.eventpayloads.md)
+
+## EventPayloads interface
+
+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 
+```
+**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)
+

package/docs/server.eventrouter.emit.md

@@ -9,7 +9,7 @@ Emit an event, invoking all registered listeners for the event type.
 **Signature:**
 
 ```typescript
-emit<TPayload>(eventType: string, payload: TPayload): boolean;
+emit<TEventType extends keyof EventPayloads>(eventType: TEventType, payload: EventPayloads[TEventType]): boolean;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ eventType
 
 </td><td>
 
-string
+TEventType
 
 
 </td><td>
@@ -53,7 +53,7 @@ payload
 
 </td><td>
 
-TPayload
+[EventPayloads](./server.eventpayloads.md)<!-- -->\[TEventType\]
 
 
 </td><td>
@@ -67,5 +67,5 @@ The payload to emit.
 
 boolean
 
-`true` if listeners were found and invoked, `false` otherwise.
+`true` if any listeners were found and invoked, `false` otherwise.
 

package/docs/server.eventrouter.emit_1.md

@@ -0,0 +1,63 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventRouter](./server.eventrouter.md) &gt; [emit](./server.eventrouter.emit_1.md)
+
+## EventRouter.emit() method
+
+**Signature:**
+
+```typescript
+emit<TEventType extends string, TPayload = any>(eventType: TEventType & Exclude<TEventType, keyof EventPayloads>, payload: TPayload): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+TEventType &amp; Exclude&lt;TEventType, keyof [EventPayloads](./server.eventpayloads.md)<!-- -->&gt;
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+payload
+
+
+</td><td>
+
+TPayload
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+

package/docs/server.eventrouter.emitwithglobal.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventRouter](./server.eventrouter.md) &gt; [emitWithGlobal](./server.eventrouter.emitwithglobal.md)
+
+## EventRouter.emitWithGlobal() method
+
+Emits an event to the local and global server instance event routers.
+
+**Signature:**
+
+```typescript
+emitWithGlobal<TEventType extends keyof EventPayloads>(eventType: TEventType, payload: EventPayloads[TEventType]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+TEventType
+
+
+</td><td>
+
+The type of event to emit.
+
+
+</td></tr>
+<tr><td>
+
+payload
+
+
+</td><td>
+
+[EventPayloads](./server.eventpayloads.md)<!-- -->\[TEventType\]
+
+
+</td><td>
+
+The payload to emit.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.eventrouter.emitwithglobal_1.md

@@ -0,0 +1,63 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventRouter](./server.eventrouter.md) &gt; [emitWithGlobal](./server.eventrouter.emitwithglobal_1.md)
+
+## EventRouter.emitWithGlobal() method
+
+**Signature:**
+
+```typescript
+emitWithGlobal<TEventType extends string, TPayload = any>(eventType: TEventType & Exclude<TEventType, keyof EventPayloads>, payload: TPayload): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+TEventType &amp; Exclude&lt;TEventType, keyof [EventPayloads](./server.eventpayloads.md)<!-- -->&gt;
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+payload
+
+
+</td><td>
+
+TPayload
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.eventrouter.emitwithworld.md

@@ -0,0 +1,85 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventRouter](./server.eventrouter.md) &gt; [emitWithWorld](./server.eventrouter.emitwithworld.md)
+
+## EventRouter.emitWithWorld() method
+
+Emits an event to local and provided world event routers.
+
+**Signature:**
+
+```typescript
+emitWithWorld<TEventType extends keyof EventPayloads>(world: World, eventType: TEventType, payload: EventPayloads[TEventType]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+world
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+The world to broadcast the event to.
+
+
+</td></tr>
+<tr><td>
+
+eventType
+
+
+</td><td>
+
+TEventType
+
+
+</td><td>
+
+The type of event to broadcast.
+
+
+</td></tr>
+<tr><td>
+
+payload
+
+
+</td><td>
+
+[EventPayloads](./server.eventpayloads.md)<!-- -->\[TEventType\]
+
+
+</td><td>
+
+The payload to broadcast.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+