hytopia 0.1.56 → 0.1.57

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
-    characterController: new SimpleCharacterController(), 
+    // 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/{character-controller/MyCharacterController.ts → entity-controller/MyEntityController.ts}

@@ -1,6 +1,6 @@
 import {
   Audio,
-  BaseCharacterController,
+  BaseEntityController,
   ColliderShape,
   CoefficientCombineRule,
   CollisionGroup,
@@ -14,8 +14,8 @@ import type {
   PlayerCameraOrientation,
 } from 'hytopia';
 
-/** Options for creating a MyCharacterController instance. @public */
-export interface MyCharacterControllerOptions {
+/** Options for creating a MyEntityController instance. @public */
+export interface MyEntityControllerOptions {
   /** The upward velocity applied to the entity when it jumps. */
   jumpVelocity?: number;
 
@@ -36,16 +36,16 @@ export interface MyCharacterControllerOptions {
 }
 
 /**
- * A custom character controller implementation.
+ * A custom entity controller implementation.
  * 
  * @remarks
- * This class extends {@link BaseCharacterController}
+ * This class extends {@link BaseEntityController}
  * and implements the default movement logic for a
- * character entity. 
+ * entity. 
  * 
  * @public
  */
-export default class MyCharacterController extends BaseCharacterController {
+export default class MyEntityController extends BaseEntityController {
   /** The upward velocity applied to the entity when it jumps. */
   public jumpVelocity: number = 10;
 
@@ -57,24 +57,24 @@ export default class MyCharacterController extends BaseCharacterController {
 
   /**
    * A function allowing custom logic to determine if the entity can walk.
-   * @param myCharacterController - The character controller instance.
-   * @returns Whether the entity of the character controller can walk.
+   * @param myEntityController - The entity controller instance.
+   * @returns Whether the entity of the entity controller can walk.
    */
-  public canWalk: (myCharacterController: MyCharacterController) => boolean = () => true;
+  public canWalk: (myEntityController: MyEntityController) => boolean = () => true;
 
   /**
    * A function allowing custom logic to determine if the entity can run.
-   * @param myCharacterController - The character controller instance.
-   * @returns Whether the entity of the character controller can run.
+   * @param myEntityController - The entity controller instance.
+   * @returns Whether the entity of the entity controller can run.
    */
-  public canRun: (myCharacterController: MyCharacterController) => boolean = () => true;
+  public canRun: (myEntityController: MyEntityController) => boolean = () => true;
 
   /**
    * A function allowing custom logic to determine if the entity can jump.
-   * @param myCharacterController - The character controller instance.
-   * @returns Whether the entity of the character controller can jump.
+   * @param myEntityController - The entity controller instance.
+   * @returns Whether the entity of the entity controller can jump.
    */
-  public canJump: (myCharacterController: MyCharacterController) => boolean = () => true;
+  public canJump: (myEntityController: MyEntityController) => boolean = () => true;
 
   /** @internal */
   private _stepAudio: Audio | undefined;
@@ -88,7 +88,7 @@ export default class MyCharacterController extends BaseCharacterController {
   /**
    * @param options - Options for the controller.
    */
-  public constructor(options: MyCharacterControllerOptions = {}) {
+  public constructor(options: MyEntityControllerOptions = {}) {
     super();
 
     this.jumpVelocity = options.jumpVelocity ?? this.jumpVelocity;
@@ -125,13 +125,13 @@ export default class MyCharacterController extends BaseCharacterController {
 
   /**
    * Called when the controlled entity is spawned.
-   * In MyCharacterController, this function is used to create
+   * In MyEntityController, this function is used to create
    * the colliders for the entity for wall and ground detection.
    * @param entity - The entity that is spawned.
    */
   public spawn(entity: Entity) {
     if (!entity.isSpawned) {
-      throw new Error('CharacterController.createColliders(): Entity is not spawned!');
+      throw new Error('MyEntityController.createColliders(): Entity is not spawned!');
     }
 
     // Ground sensor
@@ -184,7 +184,7 @@ export default class MyCharacterController extends BaseCharacterController {
   };
 
   /**
-   * Ticks the player movement for the character controller,
+   * Ticks the player movement for the entity controller,
    * overriding the default implementation.
    * 
    * @param entity - The entity to tick.

package/examples/entity-controller/README.md

@@ -0,0 +1,4 @@
+# entity-controller
+
+This is a simple demonstration of how you can create your own entity controller. This demonstration
+uses much of the same code as the default entity controller that ships with the SDK.

package/examples/{character-controller → entity-controller}/index.ts

@@ -3,7 +3,7 @@ import {
   PlayerEntity,
 } from 'hytopia';
 
-import MyCharacterController from './MyCharacterController';
+import MyEntityController from './MyEntityController';
 
 import worldMap from './assets/map.json';
 
@@ -12,7 +12,7 @@ startServer(world => {
   // world.simulation.enableDebugRendering(true);
   
   // Visualize raycasts, like block breaking for our
-  // character controller.
+  // entity controller.
   world.simulation.enableDebugRaycasting(true);
 
   world.loadMap(worldMap);
@@ -24,7 +24,7 @@ startServer(world => {
       modelUri: 'models/player.gltf',
       modelLoopedAnimations: [ 'idle' ],
       modelScale: 0.5,
-      characterController: new MyCharacterController(), // attach our character controller
+      controller: new MyEntityController(), // attach our entity controller
     });
 
     playerEntity.spawn(world, { x: 0, y: 10, z: 0 });

package/examples/{character-controller → entity-controller}/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "character-controller",
+  "name": "entity-controller",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",

package/examples/payload-game/index.ts

@@ -1,7 +1,7 @@
 /**
  * payload-game is a simple game that encompasses a number of core HYTOPIA SDK systems.
  * This example utilizes entities, spawning, rigid body, colliders and sensors, 
- * collision groups, audio, character controller hooks, and more.
+ * collision groups, audio, entity controller hooks, and more.
  * 
  * This example is a quick and dirty implementation of an overwatch style push the payload
  * in a multiplayer PvE style. Players start the game around the payload and must stay near it
@@ -22,11 +22,11 @@ import {
   PlayerCameraMode,
   ColliderShape,
   CollisionGroup,
-  DefaultCharacterController,
+  PlayerEntityController,
   Entity,
   PlayerEntity,
   RigidBodyType,
-  SimpleCharacterController,
+  SimpleEntityController,
   Vector3,
   World,
   startServer,
@@ -120,7 +120,7 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     playerEntity.spawn(world, randomSpawnCoordinate);
 
     // We need to do some custom logic for player inputs, so let's assign custom onTick handler to the default player controller.
-    playerEntity.characterController!.onTickWithPlayerInput = onTickWithPlayerInput;
+    playerEntity.controller!.onTickWithPlayerInput = onTickWithPlayerInput;
 
     // Set custom collision groups for the player entity, this is so we can reference the PLAYER collision group
     // specifically in enemy collision sensors.
@@ -293,7 +293,7 @@ function spawnPayloadEntity(world: World) {
   }
 
   payloadEntity = new Entity({
-    characterController: new SimpleCharacterController(),
+    controller: new SimpleEntityController(),
     name: 'Payload',
     modelUri: 'models/payload.gltf',
     modelScale: 0.7,
@@ -350,7 +350,7 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
   const targetPlayers = new Set<PlayerEntity>();
 
   const spider = new Entity({
-    characterController: new SimpleCharacterController(),
+    controller: new SimpleEntityController(),
     name: 'Spider',
     modelUri: 'models/spider.gltf',
     modelLoopedAnimations: [ 'walk' ],
@@ -444,16 +444,16 @@ function onTickPathfindPayload(entity: Entity) { // Movement logic for the paylo
     return console.warn('Payload destination reached!! Game won!!');
   }
 
-  if (!(entity.characterController instanceof SimpleCharacterController)) { // type guard
-    return console.warn('Payload entity does not have a SimpleCharacterController!');
+  if (!(entity.controller instanceof SimpleEntityController)) { // type guard
+    return console.warn('Payload entity does not have a SimpleEntityController!');
   }
 
-  entity.characterController.move(targetWaypointCoordinate, speed, {
+  entity.controller.move(targetWaypointCoordinate, speed, {
     moveCompleteCallback: () => targetWaypointCoordinateIndex++,
     moveIgnoreAxes: { y: true },
   });
 
-  entity.characterController.face(targetWaypointCoordinate, speed / 2);
+  entity.controller.face(targetWaypointCoordinate, speed / 2);
 }
 
 function onTickPathfindEnemy(entity: Entity, targetPlayers: Set<PlayerEntity>, speed: number, _tickDeltaMs: number) {
@@ -483,19 +483,19 @@ function onTickPathfindEnemy(entity: Entity, targetPlayers: Set<PlayerEntity>, s
     }
 
     // Handle Movement
-    if (!(entity.characterController instanceof SimpleCharacterController)) {
-      return console.warn('Enemy entity does not have a SimpleCharacterController!');
+    if (!(entity.controller instanceof SimpleEntityController)) {
+      return console.warn('Enemy entity does not have a SimpleEntityController!');
     }
   
     const targetPosition = enemyPathfindingTargets[entityId];
-    entity.characterController.move(targetPosition, speed, { moveIgnoreAxes: { y: true } });
-    entity.characterController.face(targetPosition, speed / 2);
+    entity.controller.move(targetPosition, speed, { moveIgnoreAxes: { y: true } });
+    entity.controller.face(targetPosition, speed / 2);
   }
 
   enemyPathfindAccumulators[entityId]++;
 }
 
-function onTickWithPlayerInput(this: DefaultCharacterController, entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, _deltaTimeMs: number) {
+function onTickWithPlayerInput(this: PlayerEntityController, entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, _deltaTimeMs: number) {
   if (!entity.world) return;
 
   if (input.ml) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hytopia",
-  "version": "0.1.56",
+  "version": "0.1.57",
   "description": "The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.",
   "main": "server.js",
   "bin": {