hytopia 0.2.10 → 0.3.0-dev.2

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>

package/examples/ai-agents/index.ts

@@ -26,10 +26,10 @@
 import {
 	startServer,
 	Audio,
-	GameServer,
-	PlayerEntity,
-	World,
+	ChatEvent,
 	Player,
+	PlayerEntity,
+	PlayerEvent,
 	Vector3,
 } from "hytopia";
 
@@ -93,7 +93,7 @@ startServer((world) => {
 	 * their inputs to control their in-game entity and
 	 * internally uses our player entity controller.
 	 */
-	world.onPlayerJoin = (player) => {
+	world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
 		const playerEntity = new PlayerEntity({
 			player,
 			name: "Player",
@@ -126,7 +126,7 @@ startServer((world) => {
 				lastThought: agent.getLastMonologue() || "Idle",
 			})),
 		});
-	};
+	});
 
 	/**
 	 * Handle player leaving the game. The onPlayerLeave
@@ -139,11 +139,11 @@ startServer((world) => {
 	 * the player who left by using our world's EntityManager
 	 * instance.
 	 */
-	world.onPlayerLeave = (player) => {
+	world.on(PlayerEvent.LEFT_WORLD, ({ player }) => {
 		world.entityManager
 			.getPlayerEntitiesByPlayer(player)
 			.forEach((entity) => entity.despawn());
-	};
+	});
 
 	/**
 	 * Play some peaceful ambient music to
@@ -289,11 +289,7 @@ startServer((world) => {
 	 * Instead of a chat command, we can override the chat message broadcast
 	 * to automatically respond to the player.
 	 */
-	world.chatManager.onBroadcastMessage = (
-		player: Player | undefined,
-		message: string,
-		color?: string
-	) => {
+	world.chatManager.on(ChatEvent.BROADCAST_MESSAGE, ({ player, message }) => {
 		const agents = world.entityManager
 			.getAllEntities()
 			.filter((entity) => entity instanceof BaseAgent) as BaseAgent[];
@@ -346,5 +342,5 @@ startServer((world) => {
 				});
 			}
 		});
-	};
+	});
 });

package/examples/ai-agents/src/BaseAgent.ts

@@ -3,6 +3,7 @@
  */
 import {
 	Entity,
+	EntityEvent,
 	Player,
 	Vector3,
 	World,
@@ -79,7 +80,7 @@ export class BaseAgent extends Entity {
 		super({
 			name: options.name || "BaseAgent",
 			modelUri: "models/players/player.gltf",
-			modelLoopedAnimations: ["idle"],
+			modelLoopedAnimations: ["idle_upper", "idle_lower"],
 			modelScale: 0.5,
 			controller: new SimpleEntityController(),
 			rigidBodyOptions: {
@@ -88,7 +89,8 @@ export class BaseAgent extends Entity {
 			},
 		});
 
-		this.onTick = this.onTickBehavior;
+		this.on(EntityEvent.TICK, this.onTickBehavior);
+
 		this.systemPrompt = options.systemPrompt;
 		this.openai = new OpenAI({
 			apiKey: process.env.OPENAI_API_KEY,

package/examples/ai-agents/src/behaviors/FishingBehavior.ts

@@ -89,8 +89,8 @@ export class FishingBehavior implements AgentBehavior {
 			this.isFishing = true;
 
 			// Start fishing animation if available
-			agent.stopModelAnimations(["walk", "run"]);
-			agent.startModelLoopedAnimations(["idle"]); // Could be replaced with a fishing animation
+			agent.stopModelAnimations(["walk_upper", "walk_lower", "run_upper", "run_lower"]);
+			agent.startModelLoopedAnimations(["idle_upper", "idle_lower"]); // Could be replaced with a fishing animation
 
 			// Simulate fishing time
 			setTimeout(() => {

package/examples/ai-agents/src/behaviors/FollowBehavior.ts

@@ -80,7 +80,7 @@ export class FollowBehavior implements AgentBehavior {
 
 		if (Math.abs(distance - this.followDistance) > 0.5) {
 			const isRunning = distance > this.runThreshold;
-			agent.startModelLoopedAnimations([isRunning ? "run" : "walk"]);
+			agent.startModelLoopedAnimations([isRunning ? "run_upper" : "walk_upper", isRunning ? "run_lower" : "walk_lower"]);
 
 			const angle = Math.atan2(dz, dx);
 			const targetPos = new Vector3(
@@ -115,8 +115,8 @@ export class FollowBehavior implements AgentBehavior {
 			);
 			agent.controller.face(targetEntity.position, this.speed * 2);
 		} else {
-			agent.stopModelAnimations(["walk", "run"]);
-			agent.startModelLoopedAnimations(["idle"]);
+			agent.stopModelAnimations(["walk_upper", "walk_lower", "run_upper", "run_lower"]);
+			agent.startModelLoopedAnimations(["idle_upper", "idle_lower"]);
 			this.isJumping = false; // Reset jump state when we're close enough
 		}
 	}