hytopia 0.2.10 → 0.3.0-dev.2

package/docs/server.eventrouter.emitwithworld_1.md

@@ -0,0 +1,77 @@
+<!-- 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_1.md)
+
+## EventRouter.emitWithWorld() method
+
+**Signature:**
+
+```typescript
+emitWithWorld<TEventType extends string, TPayload = any>(world: World, 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>
+
+world
+
+
+</td><td>
+
+[World](./server.world.md)
+
+
+</td><td>
+
+
+</td></tr>
+<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.prependon.md → server.eventrouter.final_1.md}

@@ -1,15 +1,13 @@
 <!-- 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; [prependOn](./server.eventrouter.prependon.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventRouter](./server.eventrouter.md) &gt; [final](./server.eventrouter.final_1.md)
 
-## EventRouter.prependOn() method
-
-Register a listener for a specific event type that will be invoked before all other existing listeners.
+## EventRouter.final() method
 
 **Signature:**
 
 ```typescript
-prependOn<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+final<TEventType extends string, TPayload = any>(eventType: TEventType & Exclude<TEventType, keyof EventPayloads>, listener: (payload: TPayload) => void): void;
 ```
 
 ## Parameters
@@ -37,13 +35,11 @@ eventType
 
 </td><td>
 
-string
+TEventType &amp; Exclude&lt;TEventType, keyof [EventPayloads](./server.eventpayloads.md)<!-- -->&gt;
 
 
 </td><td>
 
-The type of event to listen for.
-
 
 </td></tr>
 <tr><td>
@@ -58,8 +54,6 @@ listener
 
 </td><td>
 
-The listener function to invoke when the event is emitted.
-
 
 </td></tr>
 </tbody></table>

package/docs/server.eventrouter.haslisteners.md

@@ -0,0 +1,55 @@
+<!-- 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; [hasListeners](./server.eventrouter.haslisteners.md)
+
+## EventRouter.hasListeners() method
+
+Check if there are listeners for a specific event type.
+
+**Signature:**
+
+```typescript
+hasListeners(eventType: keyof EventPayloads): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+keyof [EventPayloads](./server.eventpayloads.md)
+
+
+</td><td>
+
+The type of event to check for listeners.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+`true` if listeners are found, `false` otherwise.
+

package/docs/server.eventrouter.listenercount.md

@@ -0,0 +1,55 @@
+<!-- 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; [listenerCount](./server.eventrouter.listenercount.md)
+
+## EventRouter.listenerCount() method
+
+Get the number of listeners for a specific event type.
+
+**Signature:**
+
+```typescript
+listenerCount(eventType: keyof EventPayloads): number;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+keyof [EventPayloads](./server.eventpayloads.md)
+
+
+</td><td>
+
+The type of event to get the listener count for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+number
+
+The number of listeners for the event type.
+

package/docs/server.eventrouter.listeners.md

@@ -0,0 +1,55 @@
+<!-- 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; [listeners](./server.eventrouter.listeners.md)
+
+## EventRouter.listeners() method
+
+Get all listeners for a specific event type.
+
+**Signature:**
+
+```typescript
+listeners(eventType: keyof EventPayloads): EventEmitter.EventListener<any, string>[];
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+eventType
+
+
+</td><td>
+
+keyof [EventPayloads](./server.eventpayloads.md)
+
+
+</td><td>
+
+The type of event to get listeners for.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+EventEmitter.EventListener&lt;any, string&gt;\[\]
+
+All listeners for the event type.
+

package/docs/server.eventrouter.md

@@ -12,15 +12,11 @@ Manages event emission and assigned listener callbacks.
 export default class EventRouter 
 ```
 
-## Remarks
-
-This class is used as a singleton for global server events via [EventRouter.serverInstance](./server.eventrouter.serverinstance.md)<!-- -->. For individual worlds, an internal EventRouter instance is instantiated per world. EventRouters only have visibility of events emitted and subscribed to relative to their unique instances.
-
-## Constructors
+## Methods
 
 <table><thead><tr><th>
 
-Constructor
+Method
 
 
 </th><th>
@@ -36,7 +32,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[(constructor)(tag)](./server.eventrouter._constructor_.md)
+[emit(eventType, payload)](./server.eventrouter.emit.md)
 
 
 </td><td>
@@ -44,57 +40,51 @@ Description
 
 </td><td>
 
-Constructs a new instance of the `EventRouter` class
+Emit an event, invoking all registered listeners for the event type.
 
 
 </td></tr>
-</tbody></table>
+<tr><td>
 
-## Properties
+[emit(eventType, payload)](./server.eventrouter.emit_1.md)
 
-<table><thead><tr><th>
 
-Property
+</td><td>
 
 
-</th><th>
-
-Modifiers
+</td><td>
 
 
-</th><th>
+</td></tr>
+<tr><td>
 
-Type
+[emitWithGlobal(eventType, payload)](./server.eventrouter.emitwithglobal.md)
 
 
-</th><th>
+</td><td>
 
-Description
 
+</td><td>
 
-</th></tr></thead>
-<tbody><tr><td>
+Emits an event to the local and global server instance event routers.
 
-[logAllEvents](./server.eventrouter.logallevents.md)
 
+</td></tr>
+<tr><td>
 
-</td><td>
+[emitWithGlobal(eventType, payload)](./server.eventrouter.emitwithglobal_1.md)
 
 
 </td><td>
 
-boolean
-
 
 </td><td>
 
-Enable logging of all events. Default: false
-
 
 </td></tr>
 <tr><td>
 
-[logEventsPayloads](./server.eventrouter.logeventspayloads.md)
+[emitWithWorld(world, eventType, payload)](./server.eventrouter.emitwithworld.md)
 
 
 </td><td>
@@ -102,18 +92,13 @@ Enable logging of all events. Default: false
 
 </td><td>
 
-boolean
-
-
-</td><td>
-
-Enable logging of event payloads. Default: false
+Emits an event to local and provided world event routers.
 
 
 </td></tr>
 <tr><td>
 
-[logIgnoreEventPrefixes](./server.eventrouter.logignoreeventprefixes.md)
+[emitWithWorld(world, eventType, payload)](./server.eventrouter.emitwithworld_1.md)
 
 
 </td><td>
@@ -121,18 +106,11 @@ Enable logging of event payloads. Default: false
 
 </td><td>
 
-string\[\]
-
-
-</td><td>
-
-Array of event prefixes to exclude from logging
-
 
 </td></tr>
 <tr><td>
 
-[logIgnoreEvents](./server.eventrouter.logignoreevents.md)
+[final(eventType, listener)](./server.eventrouter.final_1.md)
 
 
 </td><td>
@@ -140,18 +118,11 @@ Array of event prefixes to exclude from logging
 
 </td><td>
 
-string\[\]
-
-
-</td><td>
-
-Array of events to exclude from logging
-
 
 </td></tr>
 <tr><td>
 
-[logUnlistenedEvents](./server.eventrouter.logunlistenedevents.md)
+[hasListeners(eventType)](./server.eventrouter.haslisteners.md)
 
 
 </td><td>
@@ -159,61 +130,41 @@ Array of events to exclude from logging
 
 </td><td>
 
-boolean
-
-
-</td><td>
-
-Enable logging of events with no listeners. Default: false
+Check if there are listeners for a specific event type.
 
 
 </td></tr>
 <tr><td>
 
-[serverInstance](./server.eventrouter.serverinstance.md)
+[listenerCount(eventType)](./server.eventrouter.listenercount.md)
 
 
 </td><td>
 
-`static`
-
-`readonly`
-
 
 </td><td>
 
-[EventRouter](./server.eventrouter.md)
-
-
-</td><td>
-
-The singleton instance for global server events.
+Get the number of listeners for a specific event type.
 
 
 </td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
+<tr><td>
 
+[listeners(eventType)](./server.eventrouter.listeners.md)
 
-</th><th>
 
-Modifiers
+</td><td>
 
 
-</th><th>
+</td><td>
 
-Description
+Get all listeners for a specific event type.
 
 
-</th></tr></thead>
-<tbody><tr><td>
+</td></tr>
+<tr><td>
 
-[emit(eventType, payload)](./server.eventrouter.emit.md)
+[off(eventType, listener)](./server.eventrouter.off.md)
 
 
 </td><td>
@@ -221,13 +172,13 @@ Description
 
 </td><td>
 
-Emit an event, invoking all registered listeners for the event type.
+Remove a listener for a specific event type.
 
 
 </td></tr>
 <tr><td>
 
-[off(eventType, listener)](./server.eventrouter.off.md)
+[off(eventType, listener)](./server.eventrouter.off_1.md)
 
 
 </td><td>
@@ -235,8 +186,6 @@ Emit an event, invoking all registered listeners for the event type.
 
 </td><td>
 
-Remove a listener for a specific event type.
-
 
 </td></tr>
 <tr><td>
@@ -249,7 +198,7 @@ Remove a listener for a specific event type.
 
 </td><td>
 
-Remove all listeners for a specific event type.
+Remove all listeners or all listeners for a provided event type.
 
 
 </td></tr>
@@ -269,7 +218,7 @@ Register a listener for a specific event type.
 </td></tr>
 <tr><td>
 
-[once(eventType, listener)](./server.eventrouter.once.md)
+[on(eventType, listener)](./server.eventrouter.on_1.md)
 
 
 </td><td>
@@ -277,13 +226,11 @@ Register a listener for a specific event type.
 
 </td><td>
 
-Register a listener for a specific event type that will be invoked once.
-
 
 </td></tr>
 <tr><td>
 
-[prependOn(eventType, listener)](./server.eventrouter.prependon.md)
+[once(eventType, listener)](./server.eventrouter.once.md)
 
 
 </td><td>
@@ -291,13 +238,13 @@ Register a listener for a specific event type that will be invoked once.
 
 </td><td>
 
-Register a listener for a specific event type that will be invoked before all other existing listeners.
+Register a listener for a specific event type that will be invoked once.
 
 
 </td></tr>
 <tr><td>
 
-[prependOnce(eventType, listener)](./server.eventrouter.prependonce.md)
+[once(eventType, listener)](./server.eventrouter.once_1.md)
 
 
 </td><td>
@@ -305,8 +252,6 @@ Register a listener for a specific event type that will be invoked before all ot
 
 </td><td>
 
-Register a listener for a specific event type that will be invoked once before all other existing listeners.
-
 
 </td></tr>
 </tbody></table>

package/docs/server.eventrouter.off.md

@@ -9,7 +9,7 @@ Remove a listener for a specific event type.
 **Signature:**
 
 ```typescript
-off<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+off<TEventType extends keyof EventPayloads>(eventType: TEventType, listener: (payload: EventPayloads[TEventType]) => void): void;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ eventType
 
 </td><td>
 
-string
+TEventType
 
 
 </td><td>
@@ -53,7 +53,7 @@ listener
 
 </td><td>
 
-(payload: TPayload) =&gt; void
+(payload: [EventPayloads](./server.eventpayloads.md)<!-- -->\[TEventType\]) =&gt; void
 
 
 </td><td>

package/docs/{server.eventrouter.prependonce.md → server.eventrouter.off_1.md}

@@ -1,15 +1,13 @@
 <!-- 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; [prependOnce](./server.eventrouter.prependonce.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [EventRouter](./server.eventrouter.md) &gt; [off](./server.eventrouter.off_1.md)
 
-## EventRouter.prependOnce() method
-
-Register a listener for a specific event type that will be invoked once before all other existing listeners.
+## EventRouter.off() method
 
 **Signature:**
 
 ```typescript
-prependOnce<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+off<TEventType extends string, TPayload = any>(eventType: TEventType & Exclude<TEventType, keyof EventPayloads>, listener: (payload: TPayload) => void): void;
 ```
 
 ## Parameters
@@ -37,13 +35,11 @@ eventType
 
 </td><td>
 
-string
+TEventType &amp; Exclude&lt;TEventType, keyof [EventPayloads](./server.eventpayloads.md)<!-- -->&gt;
 
 
 </td><td>
 
-The type of event to listen for.
-
 
 </td></tr>
 <tr><td>
@@ -58,8 +54,6 @@ listener
 
 </td><td>
 
-The listener function to invoke when the event is emitted.
-
 
 </td></tr>
 </tbody></table>

package/docs/server.eventrouter.offall.md

@@ -4,12 +4,12 @@
 
 ## EventRouter.offAll() method
 
-Remove all listeners for a specific event type.
+Remove all listeners or all listeners for a provided event type.
 
 **Signature:**
 
 ```typescript
-offAll(eventType: string): void;
+offAll(eventType?: keyof EventPayloads): void;
 ```
 
 ## Parameters
@@ -37,12 +37,12 @@ eventType
 
 </td><td>
 
-string
+keyof [EventPayloads](./server.eventpayloads.md)
 
 
 </td><td>
 
-The type of event to remove all listeners from.
+_(Optional)_ The type of event to remove all listeners from.
 
 
 </td></tr>