hytopia 0.1.27 → 0.1.30

package/bin/scripts.js

@@ -51,6 +51,7 @@ const path = require('path');
     // Done, lfg!
     console.log('🚀 Hytopia project initialized successfully!');
     console.log('💡 Start your development server with `bun --watch index.ts`!');
+    console.log('🎮 After you start your development server, play by opening your browser and visiting: https://play.hytopia.com/?join=localhost:8080')
     return;
   }
   

package/docs/server.basecharactercontroller.md

@@ -96,7 +96,7 @@ The entity the controller is for.
 </td></tr>
 <tr><td>
 
-[onTickPathfindingMovement?](./server.basecharactercontroller.ontickpathfindingmovement.md)
+[onTick?](./server.basecharactercontroller.ontick.md)
 
 
 </td><td>
@@ -104,12 +104,12 @@ The entity the controller is for.
 
 </td><td>
 
-(destination: [Vector3](./server.vector3.md)<!-- -->, deltaTimeMs: number) =&gt; void
+(deltaTimeMs: number) =&gt; void
 
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks pathfinding movement.
+_(Optional)_ A callback function for when the controller ticks.
 
 
 </td></tr>
@@ -168,7 +168,7 @@ Override this method to create sensor colliders to be attached to the controlled
 </td></tr>
 <tr><td>
 
-[tickPathfindingMovement(destination, deltaTimeMs)](./server.basecharactercontroller.tickpathfindingmovement.md)
+[tick(deltaTimeMs)](./server.basecharactercontroller.tick.md)
 
 
 </td><td>
@@ -176,7 +176,7 @@ Override this method to create sensor colliders to be attached to the controlled
 
 </td><td>
 
-Override this method to implement pathfinding movement logic for your character controller. NOTE: This method is not fully supported yet.
+Override this method to handle entity movements based on your character controller.
 
 
 </td></tr>

package/docs/server.basecharactercontroller.ontick.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [onTick](./server.basecharactercontroller.ontick.md)
+
+## BaseCharacterController.onTick property
+
+A callback function for when the controller ticks.
+
+**Signature:**
+
+```typescript
+onTick?: (deltaTimeMs: number) => void;
+```

package/docs/server.basecharactercontroller.tick.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; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [tick](./server.basecharactercontroller.tick.md)
+
+## BaseCharacterController.tick() method
+
+Override this method to handle entity movements based on your character controller.
+
+**Signature:**
+
+```typescript
+tick(deltaTimeMs: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+deltaTimeMs
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The delta time in milliseconds since the last tick.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.blocktype.md

@@ -183,7 +183,7 @@ The name of the block type.
 
 </td><td>
 
-(this: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -202,7 +202,7 @@ _(Optional)_ A callback function that is invoked when an entity collides with bl
 
 </td><td>
 
-(this: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>

package/docs/server.blocktype.onentitycollision.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity collides with blocks of this
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: BlockType, entity: Entity, started: boolean) => void;
+onEntityCollision?: (blockType: BlockType, entity: Entity, started: boolean) => void;
 ```

package/docs/server.blocktype.onentitycontactforce.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity contacts a block of this type
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (blockType: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.defaultcharactercontroller.canjump.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can jump.
 **Signature:**
 
 ```typescript
-canJump: (this: DefaultCharacterController) => boolean;
+canJump: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.defaultcharactercontroller.canrun.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can run.
 **Signature:**
 
 ```typescript
-canRun: (this: DefaultCharacterController) => boolean;
+canRun: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.defaultcharactercontroller.canwalk.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can walk.
 **Signature:**
 
 ```typescript
-canWalk: (this: DefaultCharacterController) => boolean;
+canWalk: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.defaultcharactercontroller.md

@@ -101,7 +101,7 @@ Description
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -120,7 +120,7 @@ A function allowing custom logic to determine if the entity can jump.
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -139,7 +139,7 @@ A function allowing custom logic to determine if the entity can run.
 
 </td><td>
 
-(this: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
+(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
 
 
 </td><td>
@@ -301,20 +301,6 @@ Description
 Creates the sensor colliders for the character controller, overriding the default implementation.
 
 
-</td></tr>
-<tr><td>
-
-[tickPathfindingMovement(destination, deltaTimeMs)](./server.defaultcharactercontroller.tickpathfindingmovement.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Ticks the pathfinding movement for the character controller, overriding the default implementation.
-
-
 </td></tr>
 <tr><td>
 

package/docs/server.entity.createcustomcharactercontroller.md

@@ -4,10 +4,10 @@
 
 ## Entity.createCustomCharacterController property
 
-A function that creates a custom character controller for the entity.
+A function that creates a custom character controller for the entity when it spawns.
 
 **Signature:**
 
 ```typescript
-createCustomCharacterController?: (this: Entity) => BaseCharacterController;
+createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
 ```

package/docs/server.entity.md

@@ -133,12 +133,12 @@ The character controller for the entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
 
 
 </td><td>
 
-_(Optional)_ A function that creates a custom character controller for the entity.
+_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
 
 
 </td></tr>
@@ -278,7 +278,7 @@ The name of the entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -297,7 +297,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, block: [BlockType](./server.blocktype.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>
@@ -316,7 +316,7 @@ _(Optional)_ A function that is called when the entity collides with a block.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -335,7 +335,7 @@ _(Optional)_ A function that is called when the entity is despawned.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -354,7 +354,7 @@ _(Optional)_ A function that is called when the entity collides with another ent
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, otherEntity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>
@@ -373,7 +373,7 @@ _(Optional)_ A function that is called when the entity contacts another entity.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
 
 
 </td><td>
@@ -392,7 +392,7 @@ _(Optional)_ A function that is called when the entity is spawned.
 
 </td><td>
 
-(this: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
+(entity: [Entity](./server.entity.md)<!-- -->, tickDeltaMs: number) =&gt; void
 
 
 </td><td>

package/docs/server.entity.onblockcollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockCollision?: (this: Entity, block: BlockType, started: boolean) => void;
+onBlockCollision?: (entity: Entity, block: BlockType, started: boolean) => void;
 ```

package/docs/server.entity.onblockcontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with a block.
 **Signature:**
 
 ```typescript
-onBlockContactForce?: (this: Entity, block: BlockType, contactForceData: ContactForceData) => void;
+onBlockContactForce?: (entity: Entity, block: BlockType, contactForceData: ContactForceData) => void;
 ```

package/docs/server.entity.ondespawn.md

@@ -9,5 +9,5 @@ A function that is called when the entity is despawned.
 **Signature:**
 
 ```typescript
-onDespawn?: (this: Entity) => void;
+onDespawn?: (entity: Entity) => void;
 ```

package/docs/server.entity.onentitycollision.md

@@ -9,5 +9,5 @@ A function that is called when the entity collides with another entity.
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: Entity, entity: Entity, started: boolean) => void;
+onEntityCollision?: (entity: Entity, otherEntity: Entity, started: boolean) => void;
 ```

package/docs/server.entity.onentitycontactforce.md

@@ -9,5 +9,5 @@ A function that is called when the entity contacts another entity.
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: Entity, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (entity: Entity, otherEntity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.entity.onspawn.md

@@ -9,5 +9,5 @@ A function that is called when the entity is spawned.
 **Signature:**
 
 ```typescript
-onSpawn?: (this: Entity) => void;
+onSpawn?: (entity: Entity) => void;
 ```

package/docs/server.entity.ontick.md

@@ -9,5 +9,5 @@ A function that is called every tick.
 **Signature:**
 
 ```typescript
-onTick?: (this: Entity, tickDeltaMs: number) => void;
+onTick?: (entity: Entity, tickDeltaMs: number) => void;
 ```

package/docs/server.entityoptions.createcustomcharactercontroller.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; [EntityOptions](./server.entityoptions.md) &gt; [createCustomCharacterController](./server.entityoptions.createcustomcharactercontroller.md)
+
+## EntityOptions.createCustomCharacterController property
+
+A function that creates a custom character controller for the entity when it spawns.
+
+**Signature:**
+
+```typescript
+createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
+```

package/docs/server.entityoptions.md

@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[createCustomCharacterController?](./server.entityoptions.createcustomcharactercontroller.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+
+
+</td><td>
+
+_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
+
+
+</td></tr>
+<tr><td>
+
 [modelLoopedAnimations?](./server.entityoptions.modelloopedanimations.md)
 
 

package/docs/server.facecallback.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; [FaceCallback](./server.facecallback.md)
+
+## FaceCallback type
+
+A callback function called when the entity associated with the SimpleCharacterController updates its rotation as it is attempting to face a target coordinate.
+
+**Signature:**
+
+```typescript
+export type FaceCallback = (currentRotation: Rotation, targetRotation: Rotation) => void;
+```
+**References:** [Rotation](./server.rotation.md)
+

package/docs/server.facecompletecallback.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; [FaceCompleteCallback](./server.facecompletecallback.md)
+
+## FaceCompleteCallback type
+
+A callback function called when the entity associated with the SimpleCharacterController finishes rotating and is now facing a target coordinate.
+
+**Signature:**
+
+```typescript
+export type FaceCompleteCallback = (endRotation: Rotation) => void;
+```
+**References:** [Rotation](./server.rotation.md)
+

package/docs/server.faceoptions.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; [FaceOptions](./server.faceoptions.md)
+
+## FaceOptions type
+
+Options for the [SimpleCharacterController.face()](./server.simplecharactercontroller.face.md) method.
+
+**Signature:**
+
+```typescript
+export type FaceOptions = {
+    faceCallback?: FaceCallback;
+    faceCompleteCallback?: FaceCompleteCallback;
+};
+```
+**References:** [FaceCallback](./server.facecallback.md)<!-- -->, [FaceCompleteCallback](./server.facecompletecallback.md)
+

package/docs/server.hytopia.basecharactercontroller.md

@@ -96,7 +96,7 @@ The entity the controller is for.
 </td></tr>
 <tr><td>
 
-[onTickPathfindingMovement?](./server.hytopia.basecharactercontroller.ontickpathfindingmovement.md)
+[onTick?](./server.hytopia.basecharactercontroller.ontick.md)
 
 
 </td><td>
@@ -104,12 +104,12 @@ The entity the controller is for.
 
 </td><td>
 
-(destination: [Vector3](./server.vector3.md)<!-- -->, deltaTimeMs: number) =&gt; void
+(deltaTimeMs: number) =&gt; void
 
 
 </td><td>
 
-_(Optional)_ A callback function for when the controller ticks pathfinding movement.
+_(Optional)_ A callback function for when the controller ticks.
 
 
 </td></tr>
@@ -168,7 +168,7 @@ Override this method to create sensor colliders to be attached to the controlled
 </td></tr>
 <tr><td>
 
-[tickPathfindingMovement(destination, deltaTimeMs)](./server.hytopia.basecharactercontroller.tickpathfindingmovement.md)
+[tick(deltaTimeMs)](./server.hytopia.basecharactercontroller.tick.md)
 
 
 </td><td>
@@ -176,7 +176,7 @@ Override this method to create sensor colliders to be attached to the controlled
 
 </td><td>
 
-Override this method to implement pathfinding movement logic for your character controller. NOTE: This method is not fully supported yet.
+Override this method to handle entity movements based on your character controller.
 
 
 </td></tr>

package/docs/server.hytopia.basecharactercontroller.ontick.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; [HYTOPIA](./server.hytopia.md) &gt; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [onTick](./server.hytopia.basecharactercontroller.ontick.md)
+
+## HYTOPIA.BaseCharacterController.onTick property
+
+A callback function for when the controller ticks.
+
+**Signature:**
+
+```typescript
+onTick?: (deltaTimeMs: number) => void;
+```

package/docs/server.hytopia.basecharactercontroller.tick.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; [HYTOPIA](./server.hytopia.md) &gt; [BaseCharacterController](./server.hytopia.basecharactercontroller.md) &gt; [tick](./server.hytopia.basecharactercontroller.tick.md)
+
+## HYTOPIA.BaseCharacterController.tick() method
+
+Override this method to handle entity movements based on your character controller.
+
+**Signature:**
+
+```typescript
+tick(deltaTimeMs: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+deltaTimeMs
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The delta time in milliseconds since the last tick.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.hytopia.blocktype.md

@@ -183,7 +183,7 @@ The name of the block type.
 
 </td><td>
 
-(this: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, started: boolean) =&gt; void
 
 
 </td><td>
@@ -202,7 +202,7 @@ _(Optional)_ A callback function that is invoked when an entity collides with bl
 
 </td><td>
 
-(this: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
+(blockType: [BlockType](./server.blocktype.md)<!-- -->, entity: [Entity](./server.entity.md)<!-- -->, contactForceData: ContactForceData) =&gt; void
 
 
 </td><td>

package/docs/server.hytopia.blocktype.onentitycollision.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity collides with blocks of this
 **Signature:**
 
 ```typescript
-onEntityCollision?: (this: BlockType, entity: Entity, started: boolean) => void;
+onEntityCollision?: (blockType: BlockType, entity: Entity, started: boolean) => void;
 ```

package/docs/server.hytopia.blocktype.onentitycontactforce.md

@@ -9,5 +9,5 @@ A callback function that is invoked when an entity contacts a block of this type
 **Signature:**
 
 ```typescript
-onEntityContactForce?: (this: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
+onEntityContactForce?: (blockType: BlockType, entity: Entity, contactForceData: ContactForceData) => void;
 ```

package/docs/server.hytopia.defaultcharactercontroller.canjump.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can jump.
 **Signature:**
 
 ```typescript
-canJump: (this: DefaultCharacterController) => boolean;
+canJump: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.hytopia.defaultcharactercontroller.canrun.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can run.
 **Signature:**
 
 ```typescript
-canRun: (this: DefaultCharacterController) => boolean;
+canRun: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```

package/docs/server.hytopia.defaultcharactercontroller.canwalk.md

@@ -9,5 +9,5 @@ A function allowing custom logic to determine if the entity can walk.
 **Signature:**
 
 ```typescript
-canWalk: (this: DefaultCharacterController) => boolean;
+canWalk: (defaultCharacterController: DefaultCharacterController) => boolean;
 ```