hytopia 0.4.3 → 0.5.0-dev

package/docs/server.defaultplayerentitycontrolleroptions.swimgravity.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [swimGravity](./server.defaultplayerentitycontrolleroptions.swimgravity.md)
+
+## DefaultPlayerEntityControllerOptions.swimGravity property
+
+The gravity modifier applied to the entity when swimming.
+
+**Signature:**
+
+```typescript
+swimGravity?: number;
+```

package/docs/server.defaultplayerentitycontrolleroptions.swimloopedanimations.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [swimLoopedAnimations](./server.defaultplayerentitycontrolleroptions.swimloopedanimations.md)
+
+## DefaultPlayerEntityControllerOptions.swimLoopedAnimations property
+
+The looped animation(s) that will play when the entity is swimming.
+
+**Signature:**
+
+```typescript
+swimLoopedAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [swimMaxGravityVelocity](./server.defaultplayerentitycontrolleroptions.swimmaxgravityvelocity.md)
+
+## DefaultPlayerEntityControllerOptions.swimMaxGravityVelocity property
+
+The maximum downward velocity that the entity can reach when affected by gravity while swimming.
+
+**Signature:**
+
+```typescript
+swimMaxGravityVelocity?: number;
+```

package/docs/server.defaultplayerentitycontrolleroptions.swimslowvelocity.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [swimSlowVelocity](./server.defaultplayerentitycontrolleroptions.swimslowvelocity.md)
+
+## DefaultPlayerEntityControllerOptions.swimSlowVelocity property
+
+The normalized horizontal velocity applied to the entity when it swims slowly (equivalent to walking).
+
+**Signature:**
+
+```typescript
+swimSlowVelocity?: number;
+```

package/docs/server.defaultplayerentitycontrolleroptions.swimupwardvelocity.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [swimUpwardVelocity](./server.defaultplayerentitycontrolleroptions.swimupwardvelocity.md)
+
+## DefaultPlayerEntityControllerOptions.swimUpwardVelocity property
+
+The upward velocity applied to the entity when swimming.
+
+**Signature:**
+
+```typescript
+swimUpwardVelocity?: number;
+```

package/docs/server.defaultplayerentitycontrolleroptions.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [walkLoopedAnimations](./server.defaultplayerentitycontrolleroptions.walkloopedanimations.md)
+
+## DefaultPlayerEntityControllerOptions.walkLoopedAnimations property
+
+Overrides the animation(s) that will play when the entity is walking.
+
+**Signature:**
+
+```typescript
+walkLoopedAnimations?: string[];
+```

package/docs/server.defaultplayerentitycontrolleroptions.walkvelocity.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; [DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md) &gt; [walkVelocity](./server.defaultplayerentitycontrolleroptions.walkvelocity.md)
+
+## DefaultPlayerEntityControllerOptions.walkVelocity property
+
+The normalized horizontal velocity applied to the entity when it walks.
+
+**Signature:**
+
+```typescript
+walkVelocity?: number;
+```

package/docs/server.defaultplayerentityoptions.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; [DefaultPlayerEntityOptions](./server.defaultplayerentityoptions.md)
+
+## DefaultPlayerEntityOptions type
+
+Options for creating a DefaultPlayerEntity instance.
+
+**Signature:**
+
+```typescript
+export type DefaultPlayerEntityOptions = {} & PlayerEntityOptions;
+```
+**References:** [PlayerEntityOptions](./server.playerentityoptions.md)
+

package/docs/server.entity.md

@@ -336,6 +336,27 @@ ReadonlySet<string>
 The looped animations to start when the entity is spawned.
 
 
+</td></tr>
+<tr><td>
+
+[modelPreferredShape](./server.entity.modelpreferredshape.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[ColliderShape](./server.collidershape.md) \| undefined
+
+
+</td><td>
+
+The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.entity.modelpreferredshape.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; [Entity](./server.entity.md) &gt; [modelPreferredShape](./server.entity.modelpreferredshape.md)
+
+## Entity.modelPreferredShape property
+
+The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
+
+**Signature:**
+
+```typescript
+get modelPreferredShape(): ColliderShape | undefined;
+```

package/docs/server.md

@@ -126,6 +126,28 @@ Represents a collider in a world's physics simulation.
 A helper class for building and decoding collision groups.
 
 
+</td></tr>
+<tr><td>
+
+[DefaultPlayerEntity](./server.defaultplayerentity.md)
+
+
+</td><td>
+
+Represents the default player model entity.
+
+
+</td></tr>
+<tr><td>
+
+[DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md)
+
+
+</td><td>
+
+The player entity controller implementation.
+
+
 </td></tr>
 <tr><td>
 
@@ -302,17 +324,6 @@ The camera for a Player.
 Represents an entity controlled by a player in a world.
 
 
-</td></tr>
-<tr><td>
-
-[PlayerEntityController](./server.playerentitycontroller.md)
-
-
-</td><td>
-
-The player entity controller implementation.
-
-
 </td></tr>
 <tr><td>
 
@@ -956,6 +967,17 @@ The options for a cone collider.
 The options for a cylinder collider.
 
 
+</td></tr>
+<tr><td>
+
+[DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md)
+
+
+</td><td>
+
+Options for creating a DefaultPlayerEntityController instance.
+
+
 </td></tr>
 <tr><td>
 
@@ -1088,17 +1110,6 @@ The options for an error type "none" collider.
 Event payloads for PlayerCamera emitted events.
 
 
-</td></tr>
-<tr><td>
-
-[PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
-
-
-</td><td>
-
-Options for creating a PlayerEntityController instance.
-
-
 </td></tr>
 <tr><td>
 
@@ -1264,6 +1275,17 @@ A 3-dimensional vector of boolean values.
 A 3-dimensional vector.
 
 
+</td></tr>
+<tr><td>
+
+[WedgeColliderOptions](./server.wedgecollideroptions.md)
+
+
+</td><td>
+
+The options for a wedge collider.
+
+
 </td></tr>
 <tr><td>
 
@@ -1448,6 +1470,17 @@ A contact manifold.
 A decoded set of collision groups represented as their string equivalents.
 
 
+</td></tr>
+<tr><td>
+
+[DefaultPlayerEntityOptions](./server.defaultplayerentityoptions.md)
+
+
+</td><td>
+
+Options for creating a DefaultPlayerEntity instance.
+
+
 </td></tr>
 <tr><td>
 
@@ -1492,6 +1525,28 @@ A callback function called when the entity associated with the SimpleEntityContr
 Options for the [SimpleEntityController.face()](./server.simpleentitycontroller.face.md) method.
 
 
+</td></tr>
+<tr><td>
+
+[ModelBoundingBox](./server.modelboundingbox.md)
+
+
+</td><td>
+
+A bounding box for a model.
+
+
+</td></tr>
+<tr><td>
+
+[ModelTrimesh](./server.modeltrimesh.md)
+
+
+</td><td>
+
+A trimesh for a model.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelboundingbox.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelBoundingBox](./server.modelboundingbox.md)
+
+## ModelBoundingBox type
+
+A bounding box for a model.
+
+**Signature:**
+
+```typescript
+export type ModelBoundingBox = {
+    min: Vector3Like;
+    max: Vector3Like;
+};
+```
+**References:** [Vector3Like](./server.vector3like.md)
+

package/docs/server.modelentityoptions.md

@@ -92,6 +92,25 @@ string\[\]
 _(Optional)_ The looped animations to start when the entity is spawned.
 
 
+</td></tr>
+<tr><td>
+
+[modelPreferredShape?](./server.modelentityoptions.modelpreferredshape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape](./server.collidershape.md)
+
+
+</td><td>
+
+_(Optional)_ The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modelentityoptions.modelpreferredshape.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; [ModelEntityOptions](./server.modelentityoptions.md) &gt; [modelPreferredShape](./server.modelentityoptions.modelpreferredshape.md)
+
+## ModelEntityOptions.modelPreferredShape property
+
+The preferred shape of the entity's model when automatically generating its collider when no explicit colliders are provided.
+
+**Signature:**
+
+```typescript
+modelPreferredShape?: ColliderShape;
+```

package/docs/server.modelregistry.getboundingbox.md

@@ -49,7 +49,7 @@ The URI of the model to retrieve the bounding box for.
 </tbody></table>
 **Returns:**
 
-ModelBoundingBox
+[ModelBoundingBox](./server.modelboundingbox.md)
 
 The bounding box of the model.
 

package/docs/server.modelregistry.gettrimesh.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ModelRegistry](./server.modelregistry.md) &gt; [getTrimesh](./server.modelregistry.gettrimesh.md)
+
+## ModelRegistry.getTrimesh() method
+
+Retrieves the trimesh of a model.
+
+**Signature:**
+
+```typescript
+getTrimesh(modelUri: string, scale?: number): ModelTrimesh | undefined;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+modelUri
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The URI of the model to retrieve the trimesh for.
+
+
+</td></tr>
+<tr><td>
+
+scale
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ Optional uniform scaling to apply to the trimesh. Defaults to 1, which is no scaling.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+[ModelTrimesh](./server.modeltrimesh.md) \| undefined
+
+The trimesh of the model.
+

package/docs/server.modelregistry.md

@@ -173,6 +173,20 @@ Retrieves the Y-axis height of a model for a scale of 1.
 Retrieves the names of all nodes in a model.
 
 
+</td></tr>
+<tr><td>
+
+[getTrimesh(modelUri, scale)](./server.modelregistry.gettrimesh.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Retrieves the trimesh of a model.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.modeltrimesh.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; [ModelTrimesh](./server.modeltrimesh.md)
+
+## ModelTrimesh type
+
+A trimesh for a model.
+
+**Signature:**
+
+```typescript
+export type ModelTrimesh = {
+    vertices: Float32Array;
+    indices: Uint32Array;
+};
+```

package/docs/server.playerentity.md

@@ -15,7 +15,7 @@ export default class PlayerEntity extends Entity
 
 ## Remarks
 
-Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player when a player joins a world. PlayerEntity automatically handles mapping player inputs to the associated entity controller of the entity, calling the entity controller's onTickPlayerMovement method when player input has changed.
+Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player at anytime during gameplay, but most commonly when a player joins a world. PlayerEntity expects a controller to be set prior to spawning. Without setting a controller, the player entity will not respond to player inputs and throw an error.
 
 ## Example
 

package/docs/server.wedgecollideroptions.extents.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; [WedgeColliderOptions](./server.wedgecollideroptions.md) &gt; [extents](./server.wedgecollideroptions.extents.md)
+
+## WedgeColliderOptions.extents property
+
+The extents of the wedge collider, defining full width (x), height (y), and length (z).
+
+**Signature:**
+
+```typescript
+extents?: Vector3Like;
+```

package/docs/server.wedgecollideroptions.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WedgeColliderOptions](./server.wedgecollideroptions.md)
+
+## WedgeColliderOptions interface
+
+The options for a wedge collider.
+
+**Signature:**
+
+```typescript
+export interface WedgeColliderOptions extends BaseColliderOptions 
+```
+**Extends:** [BaseColliderOptions](./server.basecollideroptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[extents?](./server.wedgecollideroptions.extents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The extents of the wedge collider, defining full width (x), height (y), and length (z).
+
+
+</td></tr>
+<tr><td>
+
+[shape](./server.wedgecollideroptions.shape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape.WEDGE](./server.collidershape.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.wedgecollideroptions.shape.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WedgeColliderOptions](./server.wedgecollideroptions.md) &gt; [shape](./server.wedgecollideroptions.shape.md)
+
+## WedgeColliderOptions.shape property
+
+**Signature:**
+
+```typescript
+shape: ColliderShape.WEDGE;
+```

package/docs/server.world.loadmap.md

@@ -4,7 +4,7 @@
 
 ## World.loadMap() method
 
-Loads a map into the world.
+Loads a map into the world, clearing any prior map.
 
 **Signature:**
 

package/docs/server.world.md

@@ -478,7 +478,7 @@ Description
 
 </td><td>
 
-Loads a map into the world.
+Loads a map into the world, clearing any prior map.
 
 
 </td></tr>

package/examples/ai-agents/index.ts

@@ -27,8 +27,7 @@ import {
 	startServer,
 	Audio,
 	ChatEvent,
-	Player,
-	PlayerEntity,
+	DefaultPlayerEntity,
 	PlayerEvent,
 	Vector3,
 } from "hytopia";
@@ -94,12 +93,9 @@ startServer((world) => {
 	 * internally uses our player entity controller.
 	 */
 	world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
-		const playerEntity = new PlayerEntity({
+		const playerEntity = new DefaultPlayerEntity({
 			player,
 			name: "Player",
-			modelUri: "models/players/player.gltf",
-			modelLoopedAnimations: ["idle"],
-			modelScale: 0.5,
 		});
 
 		playerEntity.spawn(world, { x: 0, y: 10, z: 0 });

package/examples/big-world/index.ts

@@ -1,6 +1,6 @@
 import {
   startServer,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
 } from 'hytopia';
 
@@ -24,12 +24,9 @@ startServer(world => {
 
   // Spawn a player entity when a player joins the game.
   world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
-    const playerEntity = new PlayerEntity({
+    const playerEntity = new DefaultPlayerEntity({
       player,
       name: 'Player',
-      modelUri: 'models/players/player.gltf',
-      modelLoopedAnimations: [ 'idle' ],
-      modelScale: 0.5,
     });
   
     playerEntity.spawn(world, { x: 0, y: 10, z: 0 });