hytopia 0.2.11 → 0.3.0-dev.3

package/examples/payload-game/index.ts

@@ -18,19 +18,23 @@
 
 import {
   Audio,
+  BaseEntityControllerEvent,
   BlockType,
   PlayerCameraMode,
   ColliderShape,
   CollisionGroup,
   PlayerEntityController,
   Entity,
+  EntityEvent,
   PlayerEntity,
+  PlayerEvent,
   RigidBodyType,
   SimpleEntityController,
   Vector3,
   World,
   startServer,
   Collider,
+  Quaternion,
 } from 'hytopia';
 
 import type {
@@ -38,6 +42,7 @@ import type {
   PlayerCameraOrientation,
   QuaternionLike,
   Vector3Like,
+  EventPayloads,
 } from 'hytopia';
 
 import map from './assets/map.json';
@@ -99,15 +104,16 @@ startServer(world => { // Perform our game setup logic in the startServer init c
   world.loadMap(map);
 
   // Setup Player Join & Spawn Controlled Entity
-  world.onPlayerJoin = player => {
+  world.on(PlayerEvent.JOINED_WORLD, ({ player }) => {
     const playerEntity = new PlayerEntity({ // Create an entity our newly joined player controls
       player,
       name: 'Player',
-      modelUri: 'models/player-with-gun.gltf',
-      modelLoopedAnimations: [ 'idle' ],
+      modelUri: 'models/soldier-player.gltf',
+      modelLoopedAnimations: [ 'idle_lower', 'idle_gun_right' ],
       modelScale: 0.5,
     });
 
+    
     player.ui.load('ui/index.html');
 
     // Setup a first person camera for the player
@@ -120,8 +126,15 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     const randomSpawnCoordinate = PLAYER_SPAWN_COORDINATES[Math.floor(Math.random() * PLAYER_SPAWN_COORDINATES.length)];
     playerEntity.spawn(world, randomSpawnCoordinate);
 
+    // Override default model animations
+    const playerController = playerEntity.controller as PlayerEntityController;
+    playerController.idleLoopedAnimations = [ 'idle_lower', 'idle_gun_right' ];
+    playerController.interactOneshotAnimations = [];
+    playerController.walkLoopedAnimations = ['walk_lower', 'idle_gun_right' ];
+    playerController.runLoopedAnimations = [ 'run_lower', 'idle_gun_right' ];
+
     // We need to do some custom logic for player inputs, so let's assign custom onTick handler to the default player controller.
-    playerEntity.controller!.onTickWithPlayerInput = onTickWithPlayerInput;
+    playerController.on(BaseEntityControllerEvent.TICK_WITH_PLAYER_INPUT, onTickWithPlayerInput);
 
     // Set custom collision groups for the player entity, this is so we can reference the PLAYER collision group
     // specifically in enemy collision sensors.
@@ -130,6 +143,16 @@ startServer(world => { // Perform our game setup logic in the startServer init c
       collidesWith: [ CollisionGroup.ALL ],
     });
 
+    // Spawn gun as child entity
+    const gun = new Entity({
+      modelUri: 'models/raygun.gltf',
+      modelScale: 0.04,
+      parent: playerEntity,
+      parentNodeName: 'hand_right_anchor',
+    });
+
+    gun.spawn(world, { x: 0, y: 0, z: 0.1 }, Quaternion.fromEuler(-90, 0, 0));
+
     // Initialize player health
     playerEntityHealth[playerEntity.id!] = 20;
 
@@ -143,10 +166,10 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     if (!started) {
       chatManager.sendBroadcastMessage('Enter command /start to start the game!', 'FFFFFF');
     }
-  };
+  });
 
   // Setup Player Leave & Despawn Controlled Entity
-  world.onPlayerLeave = player => {
+  world.on(PlayerEvent.LEFT_WORLD, ({ player }) => {
     world.entityManager.getPlayerEntitiesByPlayer(player).forEach(entity => {
       entity.despawn();
     });
@@ -154,7 +177,7 @@ startServer(world => { // Perform our game setup logic in the startServer init c
     playerCount--;
 
     chatManager.sendBroadcastMessage(`Player ${player.username} has left the game!`, 'FFFFFF');
-  };
+  });
 
   // Spawn Payload
   spawnPayloadEntity(world);
@@ -229,13 +252,13 @@ function spawnBullet(world: World, coordinate: Vector3Like, direction: Vector3Li
     },
   });
 
-  bullet.onBlockCollision = (bullet: Entity, block: BlockType, started: boolean) => { // If the bullet hits a block, despawn it
+  bullet.on(EntityEvent.BLOCK_COLLISION, ({  started }) => { // If the bullet hits a block, despawn it
     if (started) {
       bullet.despawn();
     }
-  };
+  });
 
-  bullet.onEntityCollision = (bullet: Entity, otherEntity: Entity, started: boolean) => { // If the bullet hits an enemy, deal damage if it is a Spider
+  bullet.on(EntityEvent.ENTITY_COLLISION, ({ otherEntity, started }) => { // If the bullet hits an enemy, deal damage if it is a Spider
     if (!started || otherEntity.name !== 'Spider') {
       return;
     }
@@ -261,7 +284,7 @@ function spawnBullet(world: World, coordinate: Vector3Like, direction: Vector3Li
     }
 
     bullet.despawn();
-  };
+  });
 
   bullet.spawn(world, coordinate);
 
@@ -317,7 +340,7 @@ function spawnPayloadEntity(world: World) {
     },
   });
 
-  payloadEntity.onTick = onTickPathfindPayload; // Use our own basic pathfinding function each tick of the game for the payload.
+  payloadEntity.on(EntityEvent.TICK, onTickPathfindPayload);
   payloadEntity.spawn(world, PAYLOAD_SPAWN_COORDINATE); // Spawn the payload at the designated spawn coordinate
 
   (new Audio({ // Play a looped idle sound that follows the payload spatially
@@ -367,19 +390,16 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
     },
   });
 
-  spider.onTick = (entity: Entity, tickDeltaMs: number) => onTickPathfindEnemy( // Use our own basic pathfinding function each tick of the game for the enemy
-    entity,
-    targetPlayers,
-    baseSpeed * randomScaleMultiplier,
-    tickDeltaMs,
-  );
+  spider.on(EntityEvent.TICK, ({ entity, tickDeltaMs }) => {
+    onTickPathfindEnemy(entity, targetPlayers, baseSpeed * randomScaleMultiplier, tickDeltaMs);
+  });
 
-  spider.onEntityCollision = (spider: Entity, entity: Entity, started: boolean) => { // If the spider hits a player, deal damage and apply knockback
-    if (started && entity instanceof PlayerEntity && entity.isSpawned) {
+  spider.on(EntityEvent.ENTITY_COLLISION, ({ otherEntity, started }) => {
+    if (started && otherEntity instanceof PlayerEntity && otherEntity.isSpawned) {
       const spiderDirection = spider.directionFromRotation;
       const knockback = 4 * randomScaleMultiplier;
 
-      entity.applyImpulse({
+      otherEntity.applyImpulse({
         x: -spiderDirection.x * knockback,
         y: 4,
         z: -spiderDirection.z * knockback,
@@ -392,9 +412,9 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
         referenceDistance: 8,
       })).play(world);
 
-      damagePlayer(entity);
+      damagePlayer(otherEntity);
     }
-  };
+  });
 
   spider.spawn(world, coordinate);
 
@@ -402,7 +422,8 @@ function spawnSpider(world: World, coordinate: Vector3Like) {
   enemyHealth[spider.id!] = 2 * Math.round(randomScaleMultiplier);
 }
 
-function onTickPathfindPayload(entity: Entity) { // Movement logic for the payload
+function onTickPathfindPayload(payload: EventPayloads[EntityEvent.TICK]) { // Movement logic for the payload
+  const entity = payload.entity;
   const speed = started // Set the payload speed relative to the number of players in the payload sensor
     ? Math.max(Math.min(PAYLOAD_PER_PLAYER_SPEED * payloadPlayerEntityCount, PAYLOAD_MAX_SPEED), 0)
     : 0;
@@ -472,7 +493,9 @@ function onTickPathfindEnemy(entity: Entity, targetPlayers: Set<PlayerEntity>, s
   enemyPathfindAccumulators[entityId]++;
 }
 
-function onTickWithPlayerInput(this: PlayerEntityController, entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, _deltaTimeMs: number) {
+function onTickWithPlayerInput(payload: EventPayloads[BaseEntityControllerEvent.TICK_WITH_PLAYER_INPUT]) {
+  const { entity, input, cameraOrientation } = payload;
+
   if (!entity.world) return;
 
   if (input.ml) {
@@ -489,7 +512,7 @@ function onTickWithPlayerInput(this: PlayerEntityController, entity: PlayerEntit
     // Normalize the direction vector to unit length
     direction.normalize();
 
-    entity.startModelOneshotAnimations([ 'shoot' ]);
+    entity.startModelOneshotAnimations([ 'shoot_gun_right' ]);
 
     // Adjust bullet origin roughly for camera offset so crosshair is accurate
     const bulletOrigin = entity.position;

package/examples/wall-dodge-game/index.ts

@@ -4,11 +4,13 @@ import {
   ColliderShape,
   BlockType,
   Entity,
+  EntityEvent,
   GameServer,
   SceneUI,
   startServer,
   Player,
   PlayerEntity,
+  PlayerEvent,
   RigidBodyType,
   SimpleEntityController,
   World,
@@ -51,8 +53,8 @@ startServer(world => {
   // world.simulation.enableDebugRendering(true);
   
   world.loadMap(worldMap);
-  world.onPlayerJoin = player => onPlayerJoin(world, player);
-  world.onPlayerLeave = player => onPlayerLeave(world, player);
+  world.on(PlayerEvent.JOINED_WORLD, ({ player }) => onPlayerJoin(world, player));
+  world.on(PlayerEvent.LEFT_WORLD, ({ player }) => onPlayerLeave(world, player));
 
   setupJoinNPC(world);
   startBlockSpawner(world);
@@ -180,7 +182,7 @@ function startBlockSpawner(world: World) {
         },
       });
   
-      blockEntity.onTick = () => {
+      blockEntity.on(EntityEvent.TICK, () => {
         if (blockEntity.isSpawned && blockEntity.position.z > GAME_BLOCK_DESPAWN_Z) {
           // Make it "fall" out of the world for a nice effect and prevent
           // player collision platforming sensors from not getting their off
@@ -191,7 +193,7 @@ function startBlockSpawner(world: World) {
         if (blockEntity.isSpawned && blockEntity.position.y < -5) {
           blockEntity.despawn();
         }
-      };
+      });
   
       blockEntity.spawn(world, spawnPoint);
 
@@ -268,12 +270,12 @@ function onPlayerJoin(world: World, player: Player) {
     modelScale: 0.5,
   });
 
-  playerEntity.onTick = () => {
+  playerEntity.on(EntityEvent.TICK, () => {
     if (playerEntity.position.y < -3 || playerEntity.position.y > 10) {
       // Assume the player has fallen off the map or shot over the wall
       endGame(playerEntity);
     }
-  };
+  });
 
   // Spawn with a random X coordinate to spread players out a bit.
   playerEntity.spawn(world, getRandomSpawnCoordinate());