hytopia 0.2.11 → 0.3.0-dev.3

package/docs/server.worldevent.md

@@ -0,0 +1,131 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldEvent](./server.worldevent.md)
+
+## WorldEvent enum
+
+Event types a World instance can emit. See [WorldEventPayloads](./server.worldeventpayloads.md) for the payloads.
+
+**Signature:**
+
+```typescript
+export declare enum WorldEvent 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+SET\_AMBIENT\_LIGHT\_COLOR
+
+
+</td><td>
+
+`"WORLD.SET_AMBIENT_LIGHT_COLOR"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_AMBIENT\_LIGHT\_INTENSITY
+
+
+</td><td>
+
+`"WORLD.SET_AMBIENT_LIGHT_INTENSITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_DIRECTIONAL\_LIGHT\_COLOR
+
+
+</td><td>
+
+`"WORLD.SET_DIRECTIONAL_LIGHT_COLOR"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_DIRECTIONAL\_LIGHT\_INTENSITY
+
+
+</td><td>
+
+`"WORLD.SET_DIRECTIONAL_LIGHT_INTENSITY"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+SET\_DIRECTIONAL\_LIGHT\_POSITION
+
+
+</td><td>
+
+`"WORLD.SET_DIRECTIONAL_LIGHT_POSITION"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+START
+
+
+</td><td>
+
+`"WORLD.START"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+STOP
+
+
+</td><td>
+
+`"WORLD.STOP"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldeventpayloads._world.set_ambient_light_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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_AMBIENT\_LIGHT\_COLOR"](./server.worldeventpayloads._world.set_ambient_light_color_.md)
+
+## WorldEventPayloads."WORLD.SET\_AMBIENT\_LIGHT\_COLOR" property
+
+Emitted when the color of the world's ambient light is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_AMBIENT_LIGHT_COLOR]: {
+        world: World;
+        color: RgbColor;
+    };
+```

package/docs/server.worldeventpayloads._world.set_ambient_light_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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_AMBIENT\_LIGHT\_INTENSITY"](./server.worldeventpayloads._world.set_ambient_light_intensity_.md)
+
+## WorldEventPayloads."WORLD.SET\_AMBIENT\_LIGHT\_INTENSITY" property
+
+Emitted when the intensity of the world's ambient light is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_AMBIENT_LIGHT_INTENSITY]: {
+        world: World;
+        intensity: number;
+    };
+```

package/docs/server.worldeventpayloads._world.set_directional_light_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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_DIRECTIONAL\_LIGHT\_COLOR"](./server.worldeventpayloads._world.set_directional_light_color_.md)
+
+## WorldEventPayloads."WORLD.SET\_DIRECTIONAL\_LIGHT\_COLOR" property
+
+Emitted when the color of the world's directional light is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_DIRECTIONAL_LIGHT_COLOR]: {
+        world: World;
+        color: RgbColor;
+    };
+```

package/docs/server.worldeventpayloads._world.set_directional_light_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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_DIRECTIONAL\_LIGHT\_INTENSITY"](./server.worldeventpayloads._world.set_directional_light_intensity_.md)
+
+## WorldEventPayloads."WORLD.SET\_DIRECTIONAL\_LIGHT\_INTENSITY" property
+
+Emitted when the intensity of the world's directional light is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_DIRECTIONAL_LIGHT_INTENSITY]: {
+        world: World;
+        intensity: number;
+    };
+```

package/docs/server.worldeventpayloads._world.set_directional_light_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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.SET\_DIRECTIONAL\_LIGHT\_POSITION"](./server.worldeventpayloads._world.set_directional_light_position_.md)
+
+## WorldEventPayloads."WORLD.SET\_DIRECTIONAL\_LIGHT\_POSITION" property
+
+Emitted when the position of the world's directional light is set.
+
+**Signature:**
+
+```typescript
+[WorldEvent.SET_DIRECTIONAL_LIGHT_POSITION]: {
+        world: World;
+        position: Vector3Like;
+    };
+```

package/docs/server.worldeventpayloads._world.start_.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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.START"](./server.worldeventpayloads._world.start_.md)
+
+## WorldEventPayloads."WORLD.START" property
+
+Emitted when the world starts.
+
+**Signature:**
+
+```typescript
+[WorldEvent.START]: {
+        world: World;
+        startedAtMs: number;
+    };
+```

package/docs/server.worldeventpayloads._world.stop_.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; [WorldEventPayloads](./server.worldeventpayloads.md) &gt; ["WORLD.STOP"](./server.worldeventpayloads._world.stop_.md)
+
+## WorldEventPayloads."WORLD.STOP" property
+
+Emitted when the world stops.
+
+**Signature:**
+
+```typescript
+[WorldEvent.STOP]: {
+        world: World;
+        stoppedAtMs: number;
+    };
+```

package/docs/server.worldeventpayloads.md

@@ -0,0 +1,171 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldEventPayloads](./server.worldeventpayloads.md)
+
+## WorldEventPayloads interface
+
+Event payloads for World emitted events.
+
+**Signature:**
+
+```typescript
+export interface WorldEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["WORLD.SET\_AMBIENT\_LIGHT\_COLOR"](./server.worldeventpayloads._world.set_ambient_light_color_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; color: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color of the world's ambient light is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_AMBIENT\_LIGHT\_INTENSITY"](./server.worldeventpayloads._world.set_ambient_light_intensity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; intensity: number; }
+
+
+</td><td>
+
+Emitted when the intensity of the world's ambient light is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_DIRECTIONAL\_LIGHT\_COLOR"](./server.worldeventpayloads._world.set_directional_light_color_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; color: [RgbColor](./server.rgbcolor.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the color of the world's directional light is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_DIRECTIONAL\_LIGHT\_INTENSITY"](./server.worldeventpayloads._world.set_directional_light_intensity_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; intensity: number; }
+
+
+</td><td>
+
+Emitted when the intensity of the world's directional light is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.SET\_DIRECTIONAL\_LIGHT\_POSITION"](./server.worldeventpayloads._world.set_directional_light_position_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; position: [Vector3Like](./server.vector3like.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the position of the world's directional light is set.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.START"](./server.worldeventpayloads._world.start_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; startedAtMs: number; }
+
+
+</td><td>
+
+Emitted when the world starts.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD.STOP"](./server.worldeventpayloads._world.stop_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ world: [World](./server.world.md)<!-- -->; stoppedAtMs: number; }
+
+
+</td><td>
+
+Emitted when the world stops.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldloop.md

@@ -9,8 +9,9 @@ Manages the tick loop for a world.
 **Signature:**
 
 ```typescript
-export default class WorldLoop 
+export default class WorldLoop extends EventRouter 
 ```
+**Extends:** [EventRouter](./server.eventrouter.md)
 
 ## Remarks
 
@@ -28,6 +29,10 @@ The internal order of tick operations is as follows:
 
 5. Synchronize network packets with player clients
 
+<h2>Events</h2>
+
+This class is an EventRouter, and instances of it emit events with payloads listed under [WorldLoopEventPayloads](./server.worldloopeventpayloads.md)
+
 The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `WorldLoop` class.
 
 ## Properties

package/docs/{server.worldloopeventtype.md → server.worldloopevent.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; [WorldLoopEventType](./server.worldloopeventtype.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEvent](./server.worldloopevent.md)
 
-## WorldLoopEventType enum
+## WorldLoopEvent enum
 
-Event types a WorldLoop instance can emit.
+Event types a WorldLoop instance can emit. See [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) for the payloads.
 
 **Signature:**
 
 ```typescript
-export declare enum WorldLoopEventType 
+export declare enum WorldLoopEvent 
 ```
 
 ## Enumeration Members

package/docs/server.worldloopeventpayloads._world_loop.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; [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) &gt; ["WORLD\_LOOP.START"](./server.worldloopeventpayloads._world_loop.start_.md)
+
+## WorldLoopEventPayloads."WORLD\_LOOP.START" property
+
+Emitted when the world loop starts.
+
+**Signature:**
+
+```typescript
+[WorldLoopEvent.START]: {
+        worldLoop: WorldLoop;
+    };
+```

package/docs/server.worldloopeventpayloads._world_loop.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; [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) &gt; ["WORLD\_LOOP.STOP"](./server.worldloopeventpayloads._world_loop.stop_.md)
+
+## WorldLoopEventPayloads."WORLD\_LOOP.STOP" property
+
+Emitted when the world loop stops.
+
+**Signature:**
+
+```typescript
+[WorldLoopEvent.STOP]: {
+        worldLoop: WorldLoop;
+    };
+```

package/docs/server.worldloopeventpayloads._world_loop.tick_end_.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; [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) &gt; ["WORLD\_LOOP.TICK\_END"](./server.worldloopeventpayloads._world_loop.tick_end_.md)
+
+## WorldLoopEventPayloads."WORLD\_LOOP.TICK\_END" property
+
+Emitted when the world loop tick ends.
+
+**Signature:**
+
+```typescript
+[WorldLoopEvent.TICK_END]: {
+        worldLoop: WorldLoop;
+        tickDurationMs: number;
+    };
+```

package/docs/server.worldloopeventpayloads._world_loop.tick_error_.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; [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) &gt; ["WORLD\_LOOP.TICK\_ERROR"](./server.worldloopeventpayloads._world_loop.tick_error_.md)
+
+## WorldLoopEventPayloads."WORLD\_LOOP.TICK\_ERROR" property
+
+Emitted when an error occurs during a world loop tick.
+
+**Signature:**
+
+```typescript
+[WorldLoopEvent.TICK_ERROR]: {
+        worldLoop: WorldLoop;
+        error: Error;
+    };
+```

package/docs/server.worldloopeventpayloads._world_loop.tick_start_.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; [WorldLoopEventPayloads](./server.worldloopeventpayloads.md) &gt; ["WORLD\_LOOP.TICK\_START"](./server.worldloopeventpayloads._world_loop.tick_start_.md)
+
+## WorldLoopEventPayloads."WORLD\_LOOP.TICK\_START" property
+
+Emitted when the world loop tick starts.
+
+**Signature:**
+
+```typescript
+[WorldLoopEvent.TICK_START]: {
+        worldLoop: WorldLoop;
+        tickDeltaMs: number;
+    };
+```

package/docs/server.worldloopeventpayloads.md

@@ -0,0 +1,133 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayloads](./server.worldloopeventpayloads.md)
+
+## WorldLoopEventPayloads interface
+
+Event payloads for WorldLoop emitted events.
+
+**Signature:**
+
+```typescript
+export interface WorldLoopEventPayloads 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["WORLD\_LOOP.START"](./server.worldloopeventpayloads._world_loop.start_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ worldLoop: [WorldLoop](./server.worldloop.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the world loop starts.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD\_LOOP.STOP"](./server.worldloopeventpayloads._world_loop.stop_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ worldLoop: [WorldLoop](./server.worldloop.md)<!-- -->; }
+
+
+</td><td>
+
+Emitted when the world loop stops.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD\_LOOP.TICK\_END"](./server.worldloopeventpayloads._world_loop.tick_end_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ worldLoop: [WorldLoop](./server.worldloop.md)<!-- -->; tickDurationMs: number; }
+
+
+</td><td>
+
+Emitted when the world loop tick ends.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD\_LOOP.TICK\_ERROR"](./server.worldloopeventpayloads._world_loop.tick_error_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ worldLoop: [WorldLoop](./server.worldloop.md)<!-- -->; error: Error; }
+
+
+</td><td>
+
+Emitted when an error occurs during a world loop tick.
+
+
+</td></tr>
+<tr><td>
+
+["WORLD\_LOOP.TICK\_START"](./server.worldloopeventpayloads._world_loop.tick_start_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ worldLoop: [WorldLoop](./server.worldloop.md)<!-- -->; tickDeltaMs: number; }
+
+
+</td><td>
+
+Emitted when the world loop tick starts.
+
+
+</td></tr>
+</tbody></table>