hytopia 0.1.55 → 0.1.57

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

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

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

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

package/docs/{server.defaultcharactercontrolleroptions.md → server.playerentitycontrolleroptions.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; [DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
 
-## DefaultCharacterControllerOptions interface
+## PlayerEntityControllerOptions interface
 
-Options for creating a DefaultCharacterController instance.
+Options for creating a PlayerEntityController instance.
 
 **Signature:**
 
 ```typescript
-export interface DefaultCharacterControllerOptions 
+export interface PlayerEntityControllerOptions 
 ```
 
 ## Properties
@@ -37,7 +37,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[canJump?](./server.defaultcharactercontrolleroptions.canjump.md)
+[canJump?](./server.playerentitycontrolleroptions.canjump.md)
 
 
 </td><td>
@@ -56,7 +56,7 @@ _(Optional)_ A function allowing custom logic to determine if the entity can jum
 </td></tr>
 <tr><td>
 
-[canRun?](./server.defaultcharactercontrolleroptions.canrun.md)
+[canRun?](./server.playerentitycontrolleroptions.canrun.md)
 
 
 </td><td>
@@ -75,7 +75,7 @@ _(Optional)_ A function allowing custom logic to determine if the entity can run
 </td></tr>
 <tr><td>
 
-[canWalk?](./server.defaultcharactercontrolleroptions.canwalk.md)
+[canWalk?](./server.playerentitycontrolleroptions.canwalk.md)
 
 
 </td><td>
@@ -94,7 +94,7 @@ _(Optional)_ A function allowing custom logic to determine if the entity can wal
 </td></tr>
 <tr><td>
 
-[jumpVelocity?](./server.defaultcharactercontrolleroptions.jumpvelocity.md)
+[jumpVelocity?](./server.playerentitycontrolleroptions.jumpvelocity.md)
 
 
 </td><td>
@@ -113,7 +113,7 @@ _(Optional)_ The upward velocity applied to the entity when it jumps.
 </td></tr>
 <tr><td>
 
-[runVelocity?](./server.defaultcharactercontrolleroptions.runvelocity.md)
+[runVelocity?](./server.playerentitycontrolleroptions.runvelocity.md)
 
 
 </td><td>
@@ -132,7 +132,7 @@ _(Optional)_ The normalized horizontal velocity applied to the entity when it ru
 </td></tr>
 <tr><td>
 
-[walkVelocity?](./server.defaultcharactercontrolleroptions.walkvelocity.md)
+[walkVelocity?](./server.playerentitycontrolleroptions.walkvelocity.md)
 
 
 </td><td>

package/docs/server.playerentitycontrolleroptions.runvelocity.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; [runVelocity](./server.playerentitycontrolleroptions.runvelocity.md)
+
+## PlayerEntityControllerOptions.runVelocity property
+
+The normalized horizontal velocity applied to the entity when it runs.
+
+**Signature:**
+
+```typescript
+runVelocity?: number;
+```

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

package/docs/server.playerui.lockpointer.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; [PlayerUI](./server.playerui.md) &gt; [lockPointer](./server.playerui.lockpointer.md)
+
+## PlayerUI.lockPointer() method
+
+Locks or unlocks the player's mouse pointer.
+
+**Signature:**
+
+```typescript
+lockPointer(lock: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+lock
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Set true to lock the pointer, false to unlock it.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.playerui.md

@@ -114,6 +114,20 @@ Description
 Loads client UI for the player.
 
 
+</td></tr>
+<tr><td>
+
+[lockPointer(lock)](./server.playerui.lockpointer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Locks or unlocks the player's mouse pointer.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playeruieventpayload.lockpointer.lock.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; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [LockPointer](./server.playeruieventpayload.lockpointer.md) &gt; [lock](./server.playeruieventpayload.lockpointer.lock.md)
+
+## PlayerUIEventPayload.LockPointer.lock property
+
+**Signature:**
+
+```typescript
+lock: boolean;
+```

package/docs/server.playeruieventpayload.lockpointer.md

@@ -0,0 +1,70 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [LockPointer](./server.playeruieventpayload.lockpointer.md)
+
+## PlayerUIEventPayload.LockPointer interface
+
+**Signature:**
+
+```typescript
+interface LockPointer 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[lock](./server.playeruieventpayload.lockpointer.lock.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[playerUI](./server.playeruieventpayload.lockpointer.playerui.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PlayerUI](./server.playerui.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.playeruieventpayload.lockpointer.playerui.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; [PlayerUIEventPayload](./server.playeruieventpayload.md) &gt; [LockPointer](./server.playeruieventpayload.lockpointer.md) &gt; [playerUI](./server.playeruieventpayload.lockpointer.playerui.md)
+
+## PlayerUIEventPayload.LockPointer.playerUI property
+
+**Signature:**
+
+```typescript
+playerUI: PlayerUI;
+```

package/docs/server.playeruieventpayload.md

@@ -33,6 +33,15 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[LockPointer](./server.playeruieventpayload.lockpointer.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.playeruieventtype.md

@@ -43,6 +43,20 @@ LOAD
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+LOCK\_POINTER
+
+
+</td><td>
+
+`"PLAYER_UI.LOCK_POINTER"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

package/docs/{server.simplecharactercontroller.face.md → server.simpleentitycontroller.face.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; [SimpleCharacterController](./server.simplecharactercontroller.md) &gt; [face](./server.simplecharactercontroller.face.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleEntityController](./server.simpleentitycontroller.md) &gt; [face](./server.simpleentitycontroller.face.md)
 
-## SimpleCharacterController.face() method
+## SimpleEntityController.face() method
 
 Rotates the entity at a given speed to face a target coordinate.
 

package/docs/{server.simplecharactercontroller.md → server.simpleentitycontroller.md}

@@ -1,30 +1,28 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleCharacterController](./server.simplecharactercontroller.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleEntityController](./server.simpleentitycontroller.md)
 
-## SimpleCharacterController class
+## SimpleEntityController class
 
-A simple character controller with basic movement functions.
+A simple entity controller with basic movement functions.
 
 **Signature:**
 
 ```typescript
-export default class SimpleCharacterController extends BaseCharacterController 
+export default class SimpleEntityController extends BaseEntityController 
 ```
-**Extends:** [BaseCharacterController](./server.basecharactercontroller.md)
+**Extends:** [BaseEntityController](./server.baseentitycontroller.md)
 
 ## Remarks
 
-This class implements simple movement methods that serve as a way to add realistic movement and rotational facing functionality to an entity. This is also a great base to extend for your own more complex character controller that implements things like pathfinding. Compatible with entities that have kinematic or dynamic rigid body types.
+This class implements simple movement methods that serve as a way to add realistic movement and rotational facing functionality to an entity. This is also a great base to extend for your own more complex entity controller that implements things like pathfinding. Compatible with entities that have kinematic or dynamic rigid body types.
 
 ## Example
 
 
 ```typescript
-// Create a custom character controller for myEntity, prior to spawning it.
-myEntity.createCustomCharacterController = () => {
-  return new SimpleCharacterController(myEntity);
-};
+// Create a custom entity controller for myEntity, prior to spawning it.
+myEntity.setController(new SimpleEntityController());
 
 // Spawn the entity in the world.
 myEntity.spawn(world, { x: 53, y: 10, z: 23 });
@@ -32,7 +30,7 @@ myEntity.spawn(world, { x: 53, y: 10, z: 23 });
 // Move the entity at a speed of 4 blocks
 // per second to the coordinate (10, 1, 10).
 // console.log when we reach the target.
-myEntity.characterController.move({ x: 10, y: 1, z: 10 }, 4, {
+myEntity.controller.move({ x: 10, y: 1, z: 10 }, 4, {
   moveCompleteCallback: endPosition => {
     console.log('Finished moving to', endPosition);
   },
@@ -59,7 +57,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[face(target, speed, options)](./server.simplecharactercontroller.face.md)
+[face(target, speed, options)](./server.simpleentitycontroller.face.md)
 
 
 </td><td>
@@ -73,7 +71,7 @@ Rotates the entity at a given speed to face a target coordinate.
 </td></tr>
 <tr><td>
 
-[move(target, speed, options)](./server.simplecharactercontroller.move.md)
+[move(target, speed, options)](./server.simpleentitycontroller.move.md)
 
 
 </td><td>

package/docs/{server.simplecharactercontroller.move.md → server.simpleentitycontroller.move.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; [SimpleCharacterController](./server.simplecharactercontroller.md) &gt; [move](./server.simplecharactercontroller.move.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleEntityController](./server.simpleentitycontroller.md) &gt; [move](./server.simpleentitycontroller.move.md)
 
-## SimpleCharacterController.move() method
+## SimpleEntityController.move() method
 
 Moves the entity at a given speed in a straight line to a target coordinate.
 

package/examples/block-entity/index.ts

@@ -5,7 +5,7 @@ import {
   Entity,
   RigidBodyType,
   GameServer,
-  SimpleCharacterController,
+  SimpleEntityController,
 } from 'hytopia';
 
 import worldMap from './assets/map.json';
@@ -140,9 +140,9 @@ startServer(world => {
   const blockPet = new Entity({
     blockTextureUri: 'textures/bricks.png',
     blockHalfExtents: { x: 0.5, y: 0.5, z: 0.5 },
-    // attach a simple character controller so we can pathfind,
-    // the character controller will be created and associated when we spawn the entity
-    createCustomCharacterController: entity => new SimpleCharacterController(entity), 
+    // attach a simple entity controller so we can pathfind,
+    // the entity controller will be created and associated when we spawn the entity
+    controller: new SimpleEntityController(), 
   });
 
   blockPet.spawn(world, { x: 0, y: 10, z: -6 });
@@ -167,10 +167,10 @@ startServer(world => {
       if (!targetPlayerEntity) { return; } // if the player doesn't have an entity, don't pathfind.
 
       // pathfind to the player's entity
-      const blockPetCharacterController = blockPet.characterController as SimpleCharacterController;
+      const blockPetEntityController = blockPet.controller as SimpleEntityController;
       const targetPosition = targetPlayerEntity.position;
-      blockPetCharacterController.move(targetPosition, 3);
-      blockPetCharacterController.face(targetPosition, 1);
+      blockPetEntityController.move(targetPosition, 3);
+      blockPetEntityController.face(targetPosition, 1);
     }
   };
 });

package/examples/custom-ui/index.ts

@@ -45,7 +45,7 @@ startServer(world => {
         const randomY = Math.random() * 13 + 2;  // Random between 2 and 15
         const randomZ = Math.random() * 40 - 20; // Random between -20 and 20
 
-        playerEntity.setTranslation({ x: randomX, y: randomY, z: randomZ });
+        playerEntity.setPosition({ x: randomX, y: randomY, z: randomZ });
       }
     };
   };