hytopia 0.4.3 → 0.5.0-dev

package/examples/block-entity/index.ts

@@ -1,7 +1,7 @@
 import {
   startServer,
   ColliderShape,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
   Entity,
   EntityEvent,
@@ -20,12 +20,9 @@ startServer(world => {
   
   world.loadMap(worldMap);
   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/child-entity/index.ts

@@ -1,7 +1,7 @@
 import {
   startServer,
   Entity,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
   Quaternion,
 } from 'hytopia';
@@ -13,12 +13,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 });

package/examples/custom-ui/index.ts

@@ -1,8 +1,8 @@
 import {
   startServer,
   Audio,
+  DefaultPlayerEntity,
   Player,
-  PlayerEntity,
   PlayerEvent,
   PlayerUIEvent,
 } from 'hytopia';
@@ -10,7 +10,7 @@ import {
 import worldMap from './assets/map.json';
 
 // Simple map for player -> singular controlled entity
-const playerEntityMap = new Map<Player, PlayerEntity>();
+const playerEntityMap = new Map<Player, DefaultPlayerEntity>();
 
 startServer(world => {
   world.loadMap(worldMap);
@@ -24,12 +24,9 @@ startServer(world => {
     // or just use plain HTML like in this example.
     player.ui.load('ui/index.html');
 
-    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/entity-controller/index.ts

@@ -1,6 +1,6 @@
 import {
   startServer,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
 } from 'hytopia';
 
@@ -19,12 +19,9 @@ startServer(world => {
   world.loadMap(worldMap);
 
   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,
       controller: new MyEntityController(), // attach our entity controller
     });
 

package/examples/entity-spawn/index.ts

@@ -3,9 +3,9 @@ import {
   BlockType,
   Collider,
   ColliderShape,
+  DefaultPlayerEntity,
   Entity,
   EntityEvent,
-  PlayerEntity,
   PlayerEvent,
   RigidBodyType,
   World,
@@ -70,12 +70,9 @@ function setup(world: 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 });

package/examples/hole-in-wall-game/index.ts

@@ -3,17 +3,18 @@ import {
   BlockType,
   Collider,
   ColliderShape,
+  DefaultPlayerEntity,
   Entity,
   EntityEvent,
   GameServer,
   RigidBodyType,
   startServer,
   Player,
-  PlayerEntity,
   PlayerEvent,
   SceneUI,
   World,
   CollisionGroup,
+  PlayerEntity,
 } from 'hytopia';
 
 import GAME_WALL_SHAPES from './wall-shapes';
@@ -53,8 +54,8 @@ const GAME_CONFIG = {
 };
 
 // Game state
-const QUEUED_PLAYER_ENTITIES = new Set<PlayerEntity>();
-const GAME_PLAYER_ENTITIES = new Set<PlayerEntity>();
+const QUEUED_PLAYER_ENTITIES = new Set<DefaultPlayerEntity>();
+const GAME_PLAYER_ENTITIES = new Set<DefaultPlayerEntity>();
 
 let gameLevel = 1;
 let gameState: 'awaitingPlayers' | 'starting' | 'inProgress' = 'awaitingPlayers';
@@ -89,12 +90,10 @@ function onPlayerJoin(world: World, player: Player) {
   player.ui.load('ui/index.html');
   player.ui.sendData(gameUiState);
 
-  const playerEntity = new PlayerEntity({
+  const playerEntity = new DefaultPlayerEntity({
     player,
     name: 'Player',
-    modelUri: 'models/players/player.gltf',
-    modelLoopedAnimations: ['idle'],
-    modelScale: 0.5,
+    modelUri: 'models/players/soldier-player.gltf',
   });
 
   playerEntity.spawn(world, GAME_CONFIG.POSITIONS.PLAYER_SPAWN);
@@ -169,7 +168,7 @@ function addPlayerEntityToQueue(world: World, playerEntity: PlayerEntity) {
   world.chatManager.sendPlayerMessage(playerEntity.player, 'You have joined the next game queue!', '00FF00');
   uiUpdate({ queueCount: QUEUED_PLAYER_ENTITIES.size });
 
-  if (gameState === 'awaitingPlayers' && QUEUED_PLAYER_ENTITIES.size > 0) {
+  if (gameState === 'awaitingPlayers' && QUEUED_PLAYER_ENTITIES.size > 1) {
     queueGame(world);
   }
 
@@ -272,7 +271,7 @@ function killPlayer(playerEntity: PlayerEntity) {
   playerEntity.setPosition(GAME_CONFIG.POSITIONS.PLAYER_SPAWN);
   GAME_PLAYER_ENTITIES.delete(playerEntity);
 
-  if (GAME_PLAYER_ENTITIES.size <= 0) {
+  if (GAME_PLAYER_ENTITIES.size <= 1) {
     endGame();
   }
 

package/examples/hygrounds/classes/GameManager.ts

@@ -206,6 +206,7 @@ export default class GameManager {
 
     // Reset map to initial state
     this.world.loadMap(worldMap);
+    this._spawnBedrock(this.world);
 
     // Reset player state
     this.world.entityManager.getAllPlayerEntities().forEach(playerEntity => {

package/examples/hygrounds/classes/GamePlayerEntity.ts

@@ -1,14 +1,14 @@
 import { 
   Audio,
   BaseEntityControllerEvent,
+  DefaultPlayerEntity,
+  DefaultPlayerEntityController,
   EventPayloads,
   Player,
-  PlayerEntity,
   PlayerCameraMode,
   Vector3Like,
   QuaternionLike,
   World,
-  PlayerEntityController,
   PlayerUIEvent,
   SceneUI,
   ErrorHandler,
@@ -41,7 +41,7 @@ interface PlayerPersistedData extends Record<string, unknown> {
   totalExp: number
 }
 
-export default class GamePlayerEntity extends PlayerEntity {
+export default class GamePlayerEntity extends DefaultPlayerEntity {
   private readonly _damageAudio: Audio;
   private readonly _inventory: (ItemEntity | undefined)[] = new Array(TOTAL_INVENTORY_SLOTS).fill(undefined);
   private _dead: boolean = false;
@@ -58,8 +58,8 @@ export default class GamePlayerEntity extends PlayerEntity {
   private _totalExp: number = 0;
 
   // Player entities always assign a PlayerController to the entity
-  public get playerController(): PlayerEntityController {
-    return this.controller as PlayerEntityController;
+  public get playerController(): DefaultPlayerEntityController {
+    return this.controller as DefaultPlayerEntityController;
   }
 
   public get health(): number { return this._health; }
@@ -84,7 +84,6 @@ export default class GamePlayerEntity extends PlayerEntity {
       player,
       name: 'Player',
       modelUri: 'models/players/soldier-player.gltf',
-      modelScale: 0.5,
     });
     
     this._setupPlayerController();

package/examples/lighting/index.ts

@@ -1,9 +1,9 @@
 import {
-  Audio,
   startServer,
+  Audio,
+  DefaultPlayerEntity,
   Light,
   LightType,
-  PlayerEntity,
   PlayerEvent,
 } from 'hytopia';
 
@@ -85,12 +85,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 });

package/examples/mobile-controls/index.ts

@@ -1,6 +1,6 @@
 import {
   startServer,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
 } from 'hytopia';
 
@@ -11,12 +11,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,
     });
 
     // Load our game UI for this player, this creates our mobile controls UI

package/examples/pathfinding/index.ts

@@ -1,8 +1,8 @@
 import {
   startServer,
+  DefaultPlayerEntity,
   Entity,
   PathfindingEntityController,
-  PlayerEntity,
   PlayerEvent,
   Quaternion,
   RigidBodyType,
@@ -94,12 +94,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,
     });
 
     world.chatManager.sendPlayerMessage(player, 'To make the zombie pathfind to you, enter: /pathfind', '00FF00');

package/examples/payload-game/index.ts

@@ -20,13 +20,13 @@ import {
   Audio,
   BaseEntityControllerEvent,
   BlockType,
-  PlayerCameraMode,
+  DefaultPlayerEntity,
+  DefaultPlayerEntityController,
   ColliderShape,
   CollisionGroup,
-  PlayerEntityController,
   Entity,
   EntityEvent,
-  PlayerEntity,
+  PlayerCameraMode,
   PlayerEvent,
   RigidBodyType,
   SimpleEntityController,
@@ -105,12 +105,10 @@ startServer(world => { // Perform our game setup logic in the startServer init c
 
   // Setup Player Join & Spawn Controlled Entity
   world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
-    const playerEntity = new PlayerEntity({ // Create an entity our newly joined player controls
+    const playerEntity = new DefaultPlayerEntity({ // Create an entity our newly joined player controls
       player,
       name: 'Player',
       modelUri: 'models/soldier-player.gltf',
-      modelLoopedAnimations: [ 'idle_lower', 'idle_gun_right' ],
-      modelScale: 0.5,
     });
 
     
@@ -127,7 +125,7 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     playerEntity.spawn(world, randomSpawnCoordinate);
 
     // Override default model animations
-    const playerController = playerEntity.controller as PlayerEntityController;
+    const playerController = playerEntity.controller as DefaultPlayerEntityController;
     playerController.idleLoopedAnimations = [ 'idle_lower', 'idle_gun_right' ];
     playerController.interactOneshotAnimations = [];
     playerController.walkLoopedAnimations = ['walk_lower', 'idle_gun_right' ];
@@ -186,10 +184,10 @@ startServer(world => { // Perform our game setup logic in the startServer init c
   startEnemySpawnLoop(world);
 
   // Game Commands
-  chatManager.registerCommand('/start', () => {
-    chatManager.sendBroadcastMessage('Game started!');
+  // chatManager.registerCommand('/start', () => {
+  //   chatManager.sendBroadcastMessage('Game started!');
     started = true;
-  });
+  // });
 
   chatManager.registerCommand('/stop', () => {
     chatManager.sendBroadcastMessage('Game stopped!');
@@ -327,7 +325,7 @@ function spawnPayloadEntity(world: World) {
           // We use a onCollision handler specific to this sensor, and 
           // not the whole entity, so we can track the number of players in the payload sensor.
           onCollision: (other: BlockType | Entity, started: boolean) => { 
-            if (other instanceof PlayerEntity) {
+            if (other instanceof DefaultPlayerEntity) {
               started ? payloadPlayerEntityCount++ : payloadPlayerEntityCount--;
               console.log('player count change', payloadPlayerEntityCount, started, other.name);
             } else if (other instanceof Entity && other.name === 'Spider') {
@@ -356,7 +354,7 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
   const baseScale = 0.5;
   const baseSpeed = 3;
   const randomScaleMultiplier = Math.random() * 2 + 1; // Random value between 1 and 3 // Random scale multiplier to make each spider a different size
-  const targetPlayers = new Set<PlayerEntity>();
+  const targetPlayers = new Set<DefaultPlayerEntity>();
 
   const spider = new Entity({
     controller: new SimpleEntityController(),
@@ -381,7 +379,7 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
             collidesWith: [ CollisionGroup.PLAYER ],
           },
           onCollision: (other: BlockType | Entity, started: boolean) => { // If a player enters or exits the aggro sensor, add or remove them from the target players set
-            if (other instanceof PlayerEntity) {
+            if (other instanceof DefaultPlayerEntity) {
               started ? targetPlayers.add(other) : targetPlayers.delete(other);
             }
           },
@@ -395,7 +393,7 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
   });
 
   spider.on(EntityEvent.ENTITY_COLLISION, ({ otherEntity, started }) => {
-    if (started && otherEntity instanceof PlayerEntity && otherEntity.isSpawned) {
+    if (started && otherEntity instanceof DefaultPlayerEntity && otherEntity.isSpawned) {
       const spiderDirection = spider.directionFromRotation;
       const knockback = 4 * randomScaleMultiplier;
 
@@ -454,14 +452,14 @@ function onTickPathfindPayload(payload: EventPayloads[EntityEvent.TICK]) { // Mo
   entity.controller.face(targetWaypointCoordinate, speed / 2);
 }
 
-function onTickPathfindEnemy(entity: Entity, targetPlayers: Set<PlayerEntity>, speed: number, _tickDeltaMs: number) {
+function onTickPathfindEnemy(entity: Entity, targetPlayers: Set<DefaultPlayerEntity>, speed: number, _tickDeltaMs: number) {
   if (!entity.isSpawned || !payloadEntity) return;
   
   const entityId = entity.id!;
   enemyPathfindAccumulators[entityId] ??= 0; // Initialize the accumulator for this enemy if it isn't initialized yet
 
   if (!enemyPathfindingTargets[entityId] || enemyPathfindAccumulators[entityId] >= PATHFIND_ACCUMULATOR_THRESHOLD) {
-    const targetPlayer = targetPlayers.values().next().value as PlayerEntity | undefined;
+    const targetPlayer = targetPlayers.values().next().value as DefaultPlayerEntity | undefined;
 
     enemyPathfindingTargets[entityId] = targetPlayer?.isSpawned
       ? targetPlayer.position
@@ -523,7 +521,7 @@ function onTickWithPlayerInput(payload: EventPayloads[BaseEntityControllerEvent.
   }
 }
 
-function damagePlayer(playerEntity: PlayerEntity) {
+function damagePlayer(playerEntity: DefaultPlayerEntity) {
   const chatManager = playerEntity.world!.chatManager;
   
   playerEntityHealth[playerEntity.id!]--;

package/examples/player-persistence/index.ts

@@ -1,6 +1,6 @@
 import {
   startServer,
-  PlayerEntity,
+  DefaultPlayerEntity,
   PlayerEvent,
   Player,
   PersistenceManager,
@@ -13,12 +13,9 @@ startServer(world => {
 
   // Handle player join
   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/wall-dodge-game/index.ts

@@ -2,6 +2,7 @@ import {
   Audio,
   CollisionGroup,
   ColliderShape,
+  DefaultPlayerEntity,
   BlockType,
   Entity,
   EntityEvent,
@@ -9,7 +10,6 @@ import {
   SceneUI,
   startServer,
   Player,
-  PlayerEntity,
   PlayerEvent,
   RigidBodyType,
   SimpleEntityController,
@@ -71,7 +71,7 @@ startServer(world => {
  * with to join the game.
  */
 function setupJoinNPC(world: World) {
-  let focusedPlayer: PlayerEntity | null = null;
+  let focusedPlayer: DefaultPlayerEntity | null = null;
 
   // Create our NPC
   const joinNPC = new Entity({
@@ -91,7 +91,7 @@ function setupJoinNPC(world: World) {
           isSensor: true,
           tag: 'teleport-sensor',
           onCollision: (other: BlockType | Entity, started: boolean) => {
-            if (started && other instanceof PlayerEntity) {
+            if (started && other instanceof DefaultPlayerEntity) {
               startGame(other); // When a player entity enters this sensor, start the game for them
             }
           },
@@ -103,7 +103,7 @@ function setupJoinNPC(world: World) {
           isSensor: true, // This makes the collider not collide with other entities/objets
           tag: 'rotate-sensor',
           onCollision: (other: BlockType | Entity, started: boolean) => {
-            if (started && other instanceof PlayerEntity) {
+            if (started && other instanceof DefaultPlayerEntity) {
               focusedPlayer = other;
             }
           },
@@ -210,7 +210,7 @@ function startBlockSpawner(world: World) {
   spawnBlock();
 }
 
-function startGame(playerEntity: PlayerEntity) {
+function startGame(playerEntity: DefaultPlayerEntity) {
   playerEntity.setPosition({ x: 1, y: 4, z: 1 });
   playerEntity.setOpacity(0.3);
   playerEntity.player.ui.sendData({ type: 'game-start' });
@@ -226,7 +226,7 @@ function startGame(playerEntity: PlayerEntity) {
   }, 3500);
 }
 
-function endGame(playerEntity: PlayerEntity) {
+function endGame(playerEntity: DefaultPlayerEntity) {
   const startTime = PLAYER_GAME_START_TIME.get(playerEntity.player) ?? Date.now();
   const scoreTime = Date.now() - startTime;
   const lastTopScoreTime = PLAYER_TOP_SCORES.get(playerEntity.player) ?? 0;
@@ -262,12 +262,9 @@ function onPlayerJoin(world: World, player: Player) {
   sendPlayerLeaderboardData(player);
 
   // Create the player entity
-  const playerEntity = new PlayerEntity({
+  const playerEntity = new DefaultPlayerEntity({
     player,
     name: 'Player',
-    modelUri: 'models/players/player.gltf',
-    modelLoopedAnimations: [ 'idle' ],
-    modelScale: 0.5,
   });
 
   playerEntity.on(EntityEvent.TICK, () => {
@@ -299,7 +296,7 @@ function onPlayerLeave(world: World, player: Player) {
  * We also con't collide with other players.
  * Collision groups work on if both contacted colliders belong to a group the other collides with.
  */
-function enablePlayerEntityGameCollisions(playerEntity: PlayerEntity, enabled: boolean) {
+function enablePlayerEntityGameCollisions(playerEntity: DefaultPlayerEntity, enabled: boolean) {
   playerEntity.colliders.forEach(collider => {
     collider.setCollisionGroups({
       belongsTo: [ CollisionGroup.ENTITY, CollisionGroup.PLAYER ],

package/examples/zombies-fps/classes/GamePlayerEntity.ts

@@ -2,20 +2,18 @@ import {
   Audio,
   BaseEntityControllerEvent,
   CollisionGroup,
+  DefaultPlayerEntity,
+  DefaultPlayerEntityController,
   EventPayloads,
   Light,
   LightType,
   Player,
-  PlayerCameraOrientation,
-  PlayerEntity,
   PlayerCameraMode,
-  PlayerInput,
   SceneUI,
   Vector3Like,
   QuaternionLike,
   World,
   Quaternion,
-  PlayerEntityController,
   Vector3,
 } from 'hytopia';
 
@@ -31,7 +29,7 @@ const REVIVE_REQUIRED_HEALTH = 50;
 const REVIVE_PROGRESS_INTERVAL_MS = 1000;
 const REVIVE_DISTANCE_THRESHOLD = 3;
 
-export default class GamePlayerEntity extends PlayerEntity {
+export default class GamePlayerEntity extends DefaultPlayerEntity {
   public health: number;
   public maxHealth: number;
   public money: number;
@@ -46,8 +44,8 @@ export default class GamePlayerEntity extends PlayerEntity {
   private _reviveDistanceVectorB: Vector3;
 
   // Player entities always assign a PlayerController to the entity, so we can safely create a convenience getter
-  public get playerController(): PlayerEntityController {
-    return this.controller as PlayerEntityController;
+  public get playerController(): DefaultPlayerEntityController {
+    return this.controller as DefaultPlayerEntityController;
   }
 
   public constructor(player: Player) {
@@ -55,7 +53,6 @@ export default class GamePlayerEntity extends PlayerEntity {
       player,
       name: 'Player',
       modelUri: 'models/players/soldier-player.gltf',
-      modelScale: 0.5,
     });
     
     // Prevent mouse left click from being cancelled, required

package/package.json

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