hytopia 0.4.4 → 0.5.0-dev1

package/boilerplate/index.ts

@@ -26,7 +26,7 @@
 import {
   startServer,
   Audio,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
 } from 'hytopia';
 
@@ -77,12 +77,9 @@ startServer(world => {
    * here: https://dev.hytopia.com/sdk-guides/events
    */
   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/docs/server.collider.md

@@ -469,7 +469,7 @@ Creates a collider options object from a block's half extents.
 </td></tr>
 <tr><td>
 
-[optionsFromModelUri(modelUri, scale)](./server.collider.optionsfrommodeluri.md)
+[optionsFromModelUri(modelUri, scale, preferredShape)](./server.collider.optionsfrommodeluri.md)
 
 
 </td><td>

package/docs/server.collider.optionsfrommodeluri.md

@@ -9,7 +9,7 @@ Creates a collider options object from a modelUri with best approximate shape an
 **Signature:**
 
 ```typescript
-static optionsFromModelUri(modelUri: string, scale?: number): ColliderOptions;
+static optionsFromModelUri(modelUri: string, scale?: number, preferredShape?: ColliderShape): ColliderOptions;
 ```
 
 ## Parameters
@@ -58,7 +58,23 @@ number
 
 </td><td>
 
-_(Optional)_
+_(Optional)_ The scale of the model.
+
+
+</td></tr>
+<tr><td>
+
+preferredShape
+
+
+</td><td>
+
+[ColliderShape](./server.collidershape.md)
+
+
+</td><td>
+
+_(Optional)_ The preferred shape to use for the collider.
 
 
 </td></tr>

package/docs/server.collideroptions.md

@@ -9,7 +9,7 @@ The options for a collider.
 **Signature:**
 
 ```typescript
-export type ColliderOptions = BallColliderOptions | BlockColliderOptions | CapsuleColliderOptions | ConeColliderOptions | CylinderColliderOptions | RoundCylinderColliderOptions | TrimeshColliderOptions | NoneColliderOptions;
+export type ColliderOptions = BallColliderOptions | BlockColliderOptions | CapsuleColliderOptions | ConeColliderOptions | CylinderColliderOptions | RoundCylinderColliderOptions | TrimeshColliderOptions | WedgeColliderOptions | NoneColliderOptions;
 ```
-**References:** [BallColliderOptions](./server.ballcollideroptions.md)<!-- -->, [BlockColliderOptions](./server.blockcollideroptions.md)<!-- -->, [CapsuleColliderOptions](./server.capsulecollideroptions.md)<!-- -->, [ConeColliderOptions](./server.conecollideroptions.md)<!-- -->, [CylinderColliderOptions](./server.cylindercollideroptions.md)<!-- -->, [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md)<!-- -->, [TrimeshColliderOptions](./server.trimeshcollideroptions.md)<!-- -->, [NoneColliderOptions](./server.nonecollideroptions.md)
+**References:** [BallColliderOptions](./server.ballcollideroptions.md)<!-- -->, [BlockColliderOptions](./server.blockcollideroptions.md)<!-- -->, [CapsuleColliderOptions](./server.capsulecollideroptions.md)<!-- -->, [ConeColliderOptions](./server.conecollideroptions.md)<!-- -->, [CylinderColliderOptions](./server.cylindercollideroptions.md)<!-- -->, [RoundCylinderColliderOptions](./server.roundcylindercollideroptions.md)<!-- -->, [TrimeshColliderOptions](./server.trimeshcollideroptions.md)<!-- -->, [WedgeColliderOptions](./server.wedgecollideroptions.md)<!-- -->, [NoneColliderOptions](./server.nonecollideroptions.md)
 

package/docs/server.collidershape.md

@@ -141,5 +141,19 @@ TRIMESH
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+WEDGE
+
+
+</td><td>
+
+`"wedge"`
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>

package/docs/server.defaultplayerentity._constructor_.md

@@ -0,0 +1,47 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntity](./server.defaultplayerentity.md) &gt; [(constructor)](./server.defaultplayerentity._constructor_.md)
+
+## DefaultPlayerEntity.(constructor)
+
+Constructs a new instance of the `DefaultPlayerEntity` class
+
+**Signature:**
+
+```typescript
+constructor(options: DefaultPlayerEntityOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[DefaultPlayerEntityOptions](./server.defaultplayerentityoptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.defaultplayerentity.md

@@ -0,0 +1,61 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntity](./server.defaultplayerentity.md)
+
+## DefaultPlayerEntity class
+
+Represents the default player model entity.
+
+**Signature:**
+
+```typescript
+export default class DefaultPlayerEntity extends PlayerEntity 
+```
+**Extends:** [PlayerEntity](./server.playerentity.md)
+
+## Remarks
+
+The default player entity extends the [PlayerEntity](./server.playerentity.md) class, uses the default player model, and assigns a DefaultPlayerEntityController. This entity is the most commonly used player controlled entity in games. It automatically handles things like managing player visual customizations and cosmetics, and more. If you want to change the default model used, you can override all of the defaults, including the modelUri, but you must ensure that the model used has the same animation names and anchor points as the default player model in order to prevent unexpected behavior.
+
+## Example
+
+
+```typescript
+const playerEntity = new DefaultPlayerEntity({ player });
+
+playerEntity.spawn(world, { x: 0, y: 10, z: 0 });
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./server.defaultplayerentity._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `DefaultPlayerEntity` class
+
+
+</td></tr>
+</tbody></table>

package/docs/server.defaultplayerentitycontroller._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [(constructor)](./server.defaultplayerentitycontroller._constructor_.md)
+
+## DefaultPlayerEntityController.(constructor)
+
+Constructs a new instance of the `DefaultPlayerEntityController` class
+
+**Signature:**
+
+```typescript
+constructor(options?: DefaultPlayerEntityControllerOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[DefaultPlayerEntityControllerOptions](./server.defaultplayerentitycontrolleroptions.md)
+
+
+</td><td>
+
+_(Optional)_ Options for the controller.
+
+
+</td></tr>
+</tbody></table>

package/docs/{server.playerentitycontroller.attach.md → server.defaultplayerentitycontroller.attach.md}

@@ -1,8 +1,8 @@
 <!-- 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; [attach](./server.playerentitycontroller.attach.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [attach](./server.defaultplayerentitycontroller.attach.md)
 
-## PlayerEntityController.attach() method
+## DefaultPlayerEntityController.attach() method
 
 Called when the controller is attached to an entity.
 

package/docs/server.defaultplayerentitycontroller.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [autoCancelMouseLeftClick](./server.defaultplayerentitycontroller.autocancelmouseleftclick.md)
+
+## DefaultPlayerEntityController.autoCancelMouseLeftClick property
+
+Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+**Signature:**
+
+```typescript
+autoCancelMouseLeftClick: boolean;
+```

package/docs/server.defaultplayerentitycontroller.canjump.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [canJump](./server.defaultplayerentitycontroller.canjump.md)
+
+## DefaultPlayerEntityController.canJump property
+
+A function allowing custom logic to determine if the entity can jump.
+
+**Signature:**
+
+```typescript
+canJump: (controller: DefaultPlayerEntityController) => boolean;
+```

package/docs/server.defaultplayerentitycontroller.canrun.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [canRun](./server.defaultplayerentitycontroller.canrun.md)
+
+## DefaultPlayerEntityController.canRun property
+
+A function allowing custom logic to determine if the entity can run.
+
+**Signature:**
+
+```typescript
+canRun: (controller: DefaultPlayerEntityController) => boolean;
+```

package/docs/server.defaultplayerentitycontroller.canwalk.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [canWalk](./server.defaultplayerentitycontroller.canwalk.md)
+
+## DefaultPlayerEntityController.canWalk property
+
+A function allowing custom logic to determine if the entity can walk.
+
+**Signature:**
+
+```typescript
+canWalk: (controller: DefaultPlayerEntityController) => boolean;
+```

package/docs/server.defaultplayerentitycontroller.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [idleLoopedAnimations](./server.defaultplayerentitycontroller.idleloopedanimations.md)
+
+## DefaultPlayerEntityController.idleLoopedAnimations property
+
+The looped animation(s) that will play when the entity is idle.
+
+**Signature:**
+
+```typescript
+idleLoopedAnimations: string[];
+```

package/docs/server.defaultplayerentitycontroller.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [interactOneshotAnimations](./server.defaultplayerentitycontroller.interactoneshotanimations.md)
+
+## DefaultPlayerEntityController.interactOneshotAnimations property
+
+The oneshot animation(s) that will play when the entity interacts (left click)
+
+**Signature:**
+
+```typescript
+interactOneshotAnimations: string[];
+```

package/docs/server.defaultplayerentitycontroller.isgrounded.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [isGrounded](./server.defaultplayerentitycontroller.isgrounded.md)
+
+## DefaultPlayerEntityController.isGrounded property
+
+Whether the entity is grounded.
+
+**Signature:**
+
+```typescript
+get isGrounded(): boolean;
+```

package/docs/server.defaultplayerentitycontroller.isonplatform.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [isOnPlatform](./server.defaultplayerentitycontroller.isonplatform.md)
+
+## DefaultPlayerEntityController.isOnPlatform property
+
+Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
+
+**Signature:**
+
+```typescript
+get isOnPlatform(): boolean;
+```

package/docs/server.defaultplayerentitycontroller.isswimming.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [isSwimming](./server.defaultplayerentitycontroller.isswimming.md)
+
+## DefaultPlayerEntityController.isSwimming property
+
+Whether the entity is swimming, this is determined by if the entity is in a liquid block.
+
+**Signature:**
+
+```typescript
+get isSwimming(): boolean;
+```

package/docs/server.defaultplayerentitycontroller.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [jumpOneshotAnimations](./server.defaultplayerentitycontroller.jumponeshotanimations.md)
+
+## DefaultPlayerEntityController.jumpOneshotAnimations property
+
+The oneshot animation(s) that will play when the entity is jumping.
+
+**Signature:**
+
+```typescript
+jumpOneshotAnimations: string[];
+```

package/docs/server.defaultplayerentitycontroller.jumpvelocity.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; [DefaultPlayerEntityController](./server.defaultplayerentitycontroller.md) &gt; [jumpVelocity](./server.defaultplayerentitycontroller.jumpvelocity.md)
+
+## DefaultPlayerEntityController.jumpVelocity property
+
+The upward velocity applied to the entity when it jumps.
+
+**Signature:**
+
+```typescript
+jumpVelocity: number;
+```