hytopia 0.1.95 → 0.1.97

package/docs/server.playerentitycontroller.interactoneshotanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [interactOneshotAnimations](./server.playerentitycontroller.interactoneshotanimations.md)
+
+## PlayerEntityController.interactOneshotAnimations property
+
+The oneshot animation(s) that will play when the entity interacts (left click)
+
+**Signature:**
+
+```typescript
+interactOneshotAnimations: string[];
+```

package/docs/server.playerentitycontroller.jumponeshotanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [jumpOneshotAnimations](./server.playerentitycontroller.jumponeshotanimations.md)
+
+## PlayerEntityController.jumpOneshotAnimations property
+
+The oneshot animation(s) that will play when the entity is jumping.
+
+**Signature:**
+
+```typescript
+jumpOneshotAnimations: string[];
+```

package/docs/server.playerentitycontroller.md

@@ -91,6 +91,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[autoCancelMouseLeftClick](./server.playerentitycontroller.autocancelmouseleftclick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+
+</td></tr>
+<tr><td>
+
 [canJump](./server.playerentitycontroller.canjump.md)
 
 
@@ -145,6 +164,44 @@ A function allowing custom logic to determine if the entity can run.
 A function allowing custom logic to determine if the entity can walk.
 
 
+</td></tr>
+<tr><td>
+
+[idleLoopedAnimations](./server.playerentitycontroller.idleloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The looped animation(s) that will play when the entity is idle.
+
+
+</td></tr>
+<tr><td>
+
+[interactOneshotAnimations](./server.playerentitycontroller.interactoneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The oneshot animation(s) that will play when the entity interacts (left click)
+
+
 </td></tr>
 <tr><td>
 
@@ -187,6 +244,25 @@ boolean
 Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
 
 
+</td></tr>
+<tr><td>
+
+[jumpOneshotAnimations](./server.playerentitycontroller.jumponeshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The oneshot animation(s) that will play when the entity is jumping.
+
+
 </td></tr>
 <tr><td>
 
@@ -227,6 +303,25 @@ The upward velocity applied to the entity when it jumps.
 The platform the entity is on, if any.
 
 
+</td></tr>
+<tr><td>
+
+[runLoopedAnimations](./server.playerentitycontroller.runloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The looped animation(s) that will play when the entity is running.
+
+
 </td></tr>
 <tr><td>
 
@@ -265,6 +360,25 @@ boolean
 Whether the entity sticks to platforms.
 
 
+</td></tr>
+<tr><td>
+
+[walkLoopedAnimations](./server.playerentitycontroller.walkloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The looped animation(s) that will play when the entity is walking.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playerentitycontroller.runloopedanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [runLoopedAnimations](./server.playerentitycontroller.runloopedanimations.md)
+
+## PlayerEntityController.runLoopedAnimations property
+
+The looped animation(s) that will play when the entity is running.
+
+**Signature:**
+
+```typescript
+runLoopedAnimations: string[];
+```

package/docs/server.playerentitycontroller.walkloopedanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [walkLoopedAnimations](./server.playerentitycontroller.walkloopedanimations.md)
+
+## PlayerEntityController.walkLoopedAnimations property
+
+The looped animation(s) that will play when the entity is walking.
+
+**Signature:**
+
+```typescript
+walkLoopedAnimations: string[];
+```

package/docs/server.playerentitycontrolleroptions.autocancelmouseleftclick.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [autoCancelMouseLeftClick](./server.playerentitycontrolleroptions.autocancelmouseleftclick.md)
+
+## PlayerEntityControllerOptions.autoCancelMouseLeftClick property
+
+Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+**Signature:**
+
+```typescript
+autoCancelMouseLeftClick?: boolean;
+```

package/docs/server.playerentitycontrolleroptions.idleloopedanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [idleLoopedAnimations](./server.playerentitycontrolleroptions.idleloopedanimations.md)
+
+## PlayerEntityControllerOptions.idleLoopedAnimations property
+
+Overrides the animation(s) that will play when the entity is idle.
+
+**Signature:**
+
+```typescript
+idleLoopedAnimations?: string[];
+```

package/docs/server.playerentitycontrolleroptions.interactoneshotanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [interactOneshotAnimations](./server.playerentitycontrolleroptions.interactoneshotanimations.md)
+
+## PlayerEntityControllerOptions.interactOneshotAnimations property
+
+Overrides the animation(s) that will play when the entity interacts (left click)
+
+**Signature:**
+
+```typescript
+interactOneshotAnimations?: string[];
+```

package/docs/server.playerentitycontrolleroptions.jumponeshotanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [jumpOneshotAnimations](./server.playerentitycontrolleroptions.jumponeshotanimations.md)
+
+## PlayerEntityControllerOptions.jumpOneshotAnimations property
+
+Overrides the animation(s) that will play when the entity is jumping.
+
+**Signature:**
+
+```typescript
+jumpOneshotAnimations?: string[];
+```

package/docs/server.playerentitycontrolleroptions.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[autoCancelMouseLeftClick?](./server.playerentitycontrolleroptions.autocancelmouseleftclick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+
+</td></tr>
+<tr><td>
+
 [canJump?](./server.playerentitycontrolleroptions.canjump.md)
 
 
@@ -91,6 +110,63 @@ _(Optional)_ A function allowing custom logic to determine if the entity can run
 _(Optional)_ A function allowing custom logic to determine if the entity can walk.
 
 
+</td></tr>
+<tr><td>
+
+[idleLoopedAnimations?](./server.playerentitycontrolleroptions.idleloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity is idle.
+
+
+</td></tr>
+<tr><td>
+
+[interactOneshotAnimations?](./server.playerentitycontrolleroptions.interactoneshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity interacts (left click)
+
+
+</td></tr>
+<tr><td>
+
+[jumpOneshotAnimations?](./server.playerentitycontrolleroptions.jumponeshotanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity is jumping.
+
+
 </td></tr>
 <tr><td>
 
@@ -110,6 +186,25 @@ number
 _(Optional)_ The upward velocity applied to the entity when it jumps.
 
 
+</td></tr>
+<tr><td>
+
+[runLoopedAnimations?](./server.playerentitycontrolleroptions.runloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity is running.
+
+
 </td></tr>
 <tr><td>
 
@@ -148,6 +243,25 @@ boolean
 _(Optional)_ Whether the entity sticks to platforms, defaults to true.
 
 
+</td></tr>
+<tr><td>
+
+[walkLoopedAnimations?](./server.playerentitycontrolleroptions.walkloopedanimations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Overrides the animation(s) that will play when the entity is walking.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playerentitycontrolleroptions.runloopedanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [runLoopedAnimations](./server.playerentitycontrolleroptions.runloopedanimations.md)
+
+## PlayerEntityControllerOptions.runLoopedAnimations property
+
+Overrides the animation(s) that will play when the entity is running.
+
+**Signature:**
+
+```typescript
+runLoopedAnimations?: string[];
+```

package/docs/server.playerentitycontrolleroptions.walkloopedanimations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md) &gt; [walkLoopedAnimations](./server.playerentitycontrolleroptions.walkloopedanimations.md)
+
+## PlayerEntityControllerOptions.walkLoopedAnimations property
+
+Overrides the animation(s) that will play when the entity is walking.
+
+**Signature:**
+
+```typescript
+walkLoopedAnimations?: string[];
+```

package/docs/server.simpleentitycontroller.jump.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleEntityController](./server.simpleentitycontroller.md) &gt; [jump](./server.simpleentitycontroller.jump.md)
+
+## SimpleEntityController.jump() method
+
+Applies an upwards impulse to the entity to simulate a jump, only supported for entities with dynamic rigid body types.
+
+**Signature:**
+
+```typescript
+jump(height: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+height
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The height to jump to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.simpleentitycontroller.md

@@ -68,6 +68,20 @@ Description
 Rotates the entity at a given speed to face a target coordinate.
 
 
+</td></tr>
+<tr><td>
+
+[jump(height)](./server.simpleentitycontroller.jump.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Applies an upwards impulse to the entity to simulate a jump, only supported for entities with dynamic rigid body types.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.waypointmovecompletecallback.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; [WaypointMoveCompleteCallback](./server.waypointmovecompletecallback.md)
+
+## WaypointMoveCompleteCallback type
+
+A callback function called when the entity associated with the PathfindingEntityController finishes moving to a calculate waypoint of its current path.
+
+**Signature:**
+
+```typescript
+export type WaypointMoveCompleteCallback = (waypoint: Vector3Like, waypointIndex: number) => void;
+```
+**References:** [Vector3Like](./server.vector3like.md)
+

package/docs/server.waypointmoveskippedcallback.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; [WaypointMoveSkippedCallback](./server.waypointmoveskippedcallback.md)
+
+## WaypointMoveSkippedCallback type
+
+A callback function called when the entity associated with the PathfindingEntityController skips a waypoint because it took too long to reach.
+
+**Signature:**
+
+```typescript
+export type WaypointMoveSkippedCallback = (waypoint: Vector3Like, waypointIndex: number) => void;
+```
+**References:** [Vector3Like](./server.vector3like.md)
+

package/examples/ai-agents/.env.example

@@ -0,0 +1,2 @@
+# OpenAI API Key for agent inference
+OPENAI_API_KEY=your_openai_api_key_here 

package/examples/ai-agents/README.md

@@ -5,6 +5,23 @@ This demo codebase provides an example for building multi Agent AI systems in Hy
 - Chat bubbles for agent speech
 - Side bar UI for viewing Agent actions
 
+## Setup
+
+### Environment Variables
+This demo requires an OpenAI API key to function. Create a `.env` file in the ai-agents directory with the following variables:
+
+```env
+OPENAI_API_KEY=your_openai_api_key_here
+```
+
+You can copy the `.env.example` file and fill in your API key:
+```bash
+cd examples/ai-agents
+cp .env.example .env
+```
+
+The OpenAI API key is used for agent inference - the agents use GPT-4o to make decisions and respond to interactions. Make sure your OpenAI account has access to GPT-4o API.
+
 ## How do Agents work in Hytopia?
 Game Agents are driven by a combination of game-specific action logic, world state representation, and Large Language Models.
 

package/examples/child-entity/package-lock.json

@@ -0,0 +1,30 @@
+{
+  "name": "child-entity",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "child-entity",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "@hytopia.com/assets": "latest",
+        "hytopia": "latest"
+      }
+    },
+    "node_modules/@hytopia.com/assets": {
+      "version": "0.1.7",
+      "resolved": "https://registry.npmjs.org/@hytopia.com/assets/-/assets-0.1.7.tgz",
+      "integrity": "sha512-gC113cIIVKp97cDX3u9n3ats8qS1kuaKPStQXOf1wNxuRs36yBvHM8NJWArfzzk8SG3ilfSZtc7qMYHod2ngcg=="
+    },
+    "node_modules/hytopia": {
+      "version": "0.1.80",
+      "resolved": "https://registry.npmjs.org/hytopia/-/hytopia-0.1.80.tgz",
+      "integrity": "sha512-Teu+dfY/24k8AfkeZYBtNue4KxIPFJsQEKwiG2LPOlS/ecosedqidxiehmSGS4ujyKH+zJZy0MqJnqNNIA9R3A==",
+      "bin": {
+        "hytopia": "bin/scripts.js"
+      }
+    }
+  }
+}

package/examples/pathfinding/README.md

@@ -0,0 +1,3 @@
+# pathfinding
+
+A PathfindingEntityController example with zombies that chase the player and pathfind around complex terrain obstacles.