hytopia 0.2.11 → 0.3.0-dev.3

package/docs/server.eventrouter.on.md

@@ -9,7 +9,7 @@ Register a listener for a specific event type.
 **Signature:**
 
 ```typescript
-on<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+on<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.on_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; [on](./server.eventrouter.on_1.md)
+
+## EventRouter.on() method
+
+**Signature:**
+
+```typescript
+on<TEventType extends string, TPayload = any>(eventType: TEventType & Exclude<TEventType, keyof EventPayloads>, listener: (payload: TPayload) => void): 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>
+
+listener
+
+
+</td><td>
+
+(payload: TPayload) =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.eventrouter.once.md

@@ -9,7 +9,7 @@ Register a listener for a specific event type that will be invoked once.
 **Signature:**
 
 ```typescript
-once<TPayload>(eventType: string, listener: (payload: TPayload) => void): void;
+once<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.once_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; [once](./server.eventrouter.once_1.md)
+
+## EventRouter.once() method
+
+**Signature:**
+
+```typescript
+once<TEventType extends string, TPayload = any>(eventType: TEventType & Exclude<TEventType, keyof EventPayloads>, listener: (payload: TPayload) => void): 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>
+
+listener
+
+
+</td><td>
+
+(payload: TPayload) =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/{server.gameservereventtype.md → server.gameserverevent.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [GameServerEventType](./server.gameservereventtype.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [GameServerEvent](./server.gameserverevent.md)
 
-## GameServerEventType enum
+## GameServerEvent enum
 
-Event types a GameServer instance can emit.
+Event types a GameServer instance can emit to the global event router. See [GameServerEventPayloads](./server.gameservereventpayloads.md) for the payloads.
 
 **Signature:**
 
 ```typescript
-export declare enum GameServerEventType 
+export declare enum GameServerEvent 
 ```
 
 ## Enumeration Members

package/docs/server.gameservereventpayloads._gameserver.start_.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; [GameServerEventPayloads](./server.gameservereventpayloads.md) &gt; ["GAMESERVER.START"](./server.gameservereventpayloads._gameserver.start_.md)
+
+## GameServerEventPayloads."GAMESERVER.START" property
+
+Emitted when the game server starts.
+
+**Signature:**
+
+```typescript
+[GameServerEvent.START]: {
+        startedAtMs: number;
+    };
+```

package/docs/server.gameservereventpayloads._gameserver.stop_.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; [GameServerEventPayloads](./server.gameservereventpayloads.md) &gt; ["GAMESERVER.STOP"](./server.gameservereventpayloads._gameserver.stop_.md)
+
+## GameServerEventPayloads."GAMESERVER.STOP" property
+
+Emitted when the game server stops.
+
+**Signature:**
+
+```typescript
+[GameServerEvent.STOP]: {
+        stoppedAtMs: number;
+    };
+```

package/docs/server.gameservereventpayloads.md

@@ -0,0 +1,76 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [GameServerEventPayloads](./server.gameservereventpayloads.md)
+
+## GameServerEventPayloads interface
+
+Event payloads for GameServer emitted events.
+
+**Signature:**
+
+```typescript
+export interface GameServerEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["GAMESERVER.START"](./server.gameservereventpayloads._gameserver.start_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ startedAtMs: number; }
+
+
+</td><td>
+
+Emitted when the game server starts.
+
+
+</td></tr>
+<tr><td>
+
+["GAMESERVER.STOP"](./server.gameservereventpayloads._gameserver.stop_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ stoppedAtMs: number; }
+
+
+</td><td>
+
+Emitted when the game server stops.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.light.md

@@ -9,14 +9,20 @@ Represents a light in a world. Lights can be point lights or spotlights.
 **Signature:**
 
 ```typescript
-export default class Light implements protocol.Serializable 
+export default class Light extends EventRouter implements protocol.Serializable 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
+
 **Implements:** protocol.Serializable
 
 ## Remarks
 
 Lights are created directly as instances. They support a variety of configuration options through the [LightOptions](./server.lightoptions.md) constructor argument.
 
+<h2>Events</h2>
+
+This class is an EventRouter, and instances of it emit events with payloads listed under [LightEventPayloads](./server.lighteventpayloads.md)
+
 ## Example
 
 

package/docs/{server.lighteventtype.md → server.lightevent.md}

@@ -1,15 +1,15 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventType](./server.lighteventtype.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEvent](./server.lightevent.md)
 
-## LightEventType enum
+## LightEvent enum
 
-Event types a Light instance can emit.
+Event types a Light instance can emit. See [LightEventPayloads](./server.lighteventpayloads.md) for the payloads.
 
 **Signature:**
 
 ```typescript
-export declare enum LightEventType 
+export declare enum LightEvent 
 ```
 
 ## Enumeration Members
@@ -183,20 +183,6 @@ SET\_TRACKED\_POSITION
 </td><td>
 
 
-</td></tr>
-<tr><td>
-
-SET\_TYPE
-
-
-</td><td>
-
-`"LIGHT.SET_TYPE"`
-
-
-</td><td>
-
-
 </td></tr>
 <tr><td>
 

package/docs/server.lighteventpayloads._light.despawn_.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; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.DESPAWN"](./server.lighteventpayloads._light.despawn_.md)
+
+## LightEventPayloads."LIGHT.DESPAWN" property
+
+Emitted when a light is despawned.
+
+**Signature:**
+
+```typescript
+[LightEvent.DESPAWN]: {
+        light: Light;
+    };
+```

package/docs/server.lighteventpayloads._light.set_angle_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_ANGLE"](./server.lighteventpayloads._light.set_angle_.md)
+
+## LightEventPayloads."LIGHT.SET\_ANGLE" property
+
+Emitted when the angle of the spotlight is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_ANGLE]: {
+        light: Light;
+        angle: number;
+    };
+```

package/docs/server.lighteventpayloads._light.set_attached_to_entity_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_ATTACHED\_TO\_ENTITY"](./server.lighteventpayloads._light.set_attached_to_entity_.md)
+
+## LightEventPayloads."LIGHT.SET\_ATTACHED\_TO\_ENTITY" property
+
+Emitted when the light is attached to an entity.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_ATTACHED_TO_ENTITY]: {
+        light: Light;
+        entity: Entity;
+    };
+```

package/docs/server.lighteventpayloads._light.set_color_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_COLOR"](./server.lighteventpayloads._light.set_color_.md)
+
+## LightEventPayloads."LIGHT.SET\_COLOR" property
+
+Emitted when the color of the light is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_COLOR]: {
+        light: Light;
+        color: RgbColor;
+    };
+```

package/docs/server.lighteventpayloads._light.set_distance_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_DISTANCE"](./server.lighteventpayloads._light.set_distance_.md)
+
+## LightEventPayloads."LIGHT.SET\_DISTANCE" property
+
+Emitted when the maximum distance the light will illuminate is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_DISTANCE]: {
+        light: Light;
+        distance: number;
+    };
+```

package/docs/server.lighteventpayloads._light.set_intensity_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_INTENSITY"](./server.lighteventpayloads._light.set_intensity_.md)
+
+## LightEventPayloads."LIGHT.SET\_INTENSITY" property
+
+Emitted when the intensity of the light is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_INTENSITY]: {
+        light: Light;
+        intensity: number;
+    };
+```

package/docs/server.lighteventpayloads._light.set_offset_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_OFFSET"](./server.lighteventpayloads._light.set_offset_.md)
+
+## LightEventPayloads."LIGHT.SET\_OFFSET" property
+
+Emitted when the offset of the light is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_OFFSET]: {
+        light: Light;
+        offset: Vector3Like;
+    };
+```

package/docs/server.lighteventpayloads._light.set_penumbra_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_PENUMBRA"](./server.lighteventpayloads._light.set_penumbra_.md)
+
+## LightEventPayloads."LIGHT.SET\_PENUMBRA" property
+
+Emitted when the penumbra of the spotlight is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_PENUMBRA]: {
+        light: Light;
+        penumbra: number;
+    };
+```

package/docs/server.lighteventpayloads._light.set_position_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_POSITION"](./server.lighteventpayloads._light.set_position_.md)
+
+## LightEventPayloads."LIGHT.SET\_POSITION" property
+
+Emitted when the position of the light is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_POSITION]: {
+        light: Light;
+        position: Vector3Like;
+    };
+```

package/docs/server.lighteventpayloads._light.set_tracked_entity_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_TRACKED\_ENTITY"](./server.lighteventpayloads._light.set_tracked_entity_.md)
+
+## LightEventPayloads."LIGHT.SET\_TRACKED\_ENTITY" property
+
+Emitted when the tracked entity of the spotlight is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_TRACKED_ENTITY]: {
+        light: Light;
+        entity: Entity;
+    };
+```

package/docs/server.lighteventpayloads._light.set_tracked_position_.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SET\_TRACKED\_POSITION"](./server.lighteventpayloads._light.set_tracked_position_.md)
+
+## LightEventPayloads."LIGHT.SET\_TRACKED\_POSITION" property
+
+Emitted when the tracked position of the spotlight is set.
+
+**Signature:**
+
+```typescript
+[LightEvent.SET_TRACKED_POSITION]: {
+        light: Light;
+        position: Vector3Like;
+    };
+```

package/docs/server.lighteventpayloads._light.spawn_.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; [LightEventPayloads](./server.lighteventpayloads.md) &gt; ["LIGHT.SPAWN"](./server.lighteventpayloads._light.spawn_.md)
+
+## LightEventPayloads."LIGHT.SPAWN" property
+
+Emitted when a light is spawned.
+
+**Signature:**
+
+```typescript
+[LightEvent.SPAWN]: {
+        light: Light;
+    };
+```