hytopia 0.3.6 → 0.3.8

package/examples/hygrounds/classes/TerrainDamageManager.ts

@@ -0,0 +1,56 @@
+import { Block, Vector3Like, World } from 'hytopia';
+import {
+  BEDROCK_BLOCK_ID,
+  BLOCK_ID_BREAK_DAMAGE,
+  BLOCK_ID_MATERIALS,
+ } from '../gameConfig';
+
+interface BlockDamage {
+  blockId: number;
+  totalDamage: number;
+}
+
+export default class TerrainDamageManager {
+  public static instance: TerrainDamageManager = new TerrainDamageManager();
+
+  private _blockDamages: Map<string, BlockDamage> = new Map();
+
+  private constructor() {}
+
+  public static getBreakMaterialCount(blockId: number): number {
+    return BLOCK_ID_MATERIALS[blockId] ?? BLOCK_ID_MATERIALS.default; 
+  }
+
+  public damageBlock(world: World, block: Block, damage: number): boolean {
+    const coordinateKey = this._coordinateToKey(block.globalCoordinate);
+    let blockDamage = this._blockDamages.get(coordinateKey);
+
+    if (!blockDamage) {
+      const blockId = block.blockType.id;
+
+      if (block.blockType.isLiquid || blockId === BEDROCK_BLOCK_ID) {
+        return false;
+      }
+
+      blockDamage = { blockId, totalDamage: 0 };
+      this._blockDamages.set(coordinateKey, blockDamage);
+    }
+
+    blockDamage.totalDamage += damage;
+
+    const requiredBreakDamage = BLOCK_ID_BREAK_DAMAGE[blockDamage.blockId] ?? BLOCK_ID_BREAK_DAMAGE.default;
+
+    if (blockDamage.totalDamage >= requiredBreakDamage) {
+      world.chunkLattice.setBlock(block.globalCoordinate, 0);
+      this._blockDamages.delete(coordinateKey);
+      
+      return true;
+    }
+
+    return false;
+  }
+
+  private _coordinateToKey(coordinate: Vector3Like): string {
+    return `${coordinate.x},${coordinate.y},${coordinate.z}`;
+  }
+}

package/examples/hygrounds/classes/items/GravityPotionEntity.ts

@@ -0,0 +1,48 @@
+import { Quaternion } from 'hytopia';
+import ItemEntity from "../ItemEntity";
+import GamePlayerEntity from '../GamePlayerEntity';
+import type { ItemEntityOptions } from "../ItemEntity";
+
+const GRAVITY_SCALE = 0.3;
+const GRAVITY_DURATION_MS = 15 * 1000; // 15 seconds
+
+const DEFAULT_GRAVITY_POTION_OPTIONS: ItemEntityOptions = {
+  heldHand: 'right',
+  iconImageUri: 'icons/gravity-potion.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'shoot_gun_right',
+  modelUri: 'models/items/gravity-potion.glb',
+  modelScale: 0.4,
+  name: 'Gravity Potion',
+  consumable: true,
+  consumeAudioUri: 'audio/sfx/potion-consume.mp3',
+  consumeTimeMs: 1000,
+  quantity: 1,
+}
+
+export default class GravityPotionEntity extends ItemEntity {
+  public constructor(options: Partial<ItemEntityOptions> = {}) {
+    super({ ...DEFAULT_GRAVITY_POTION_OPTIONS, ...options });
+  }
+
+  public override consume(): void {
+    if (!(this.parent instanceof GamePlayerEntity)) {
+      return;
+    }
+
+    const parent = this.parent as GamePlayerEntity;
+
+    // Apply gravity potion effect
+    parent.setGravity(GRAVITY_SCALE);
+    setTimeout(() => parent.setGravity(1), GRAVITY_DURATION_MS);
+
+    super.consume(); 
+  }
+
+  public override equip(): void {
+    super.equip();
+
+    this.setPosition({ x: 0, y: 0.15, z: -0.2 });
+    this.setRotation(Quaternion.fromEuler(-90, 0, 0));
+  }
+}

package/examples/hygrounds/classes/items/MedPackEntity.ts

@@ -0,0 +1,43 @@
+import { Quaternion } from 'hytopia';
+import ItemEntity from "../ItemEntity";
+import GamePlayerEntity from '../GamePlayerEntity';
+import type { ItemEntityOptions } from "../ItemEntity";
+
+const ADD_HEALTH_AMOUNT = 50;
+
+const DEFAULT_MEDPACK_OPTIONS: ItemEntityOptions = {
+  heldHand: 'right',
+  iconImageUri: 'icons/medpack.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'shoot_gun_right',
+  modelUri: 'models/items/medpack.glb',
+  modelScale: 0.4,
+  name: 'Med Pack',
+  consumable: true,
+  consumeAudioUri: 'audio/sfx/medpack-consume.mp3',
+  consumeTimeMs: 1000,
+  quantity: 1,
+}
+
+export default class MedPackEntity extends ItemEntity {
+  public constructor(options: Partial<ItemEntityOptions> = {}) {
+    super({ ...DEFAULT_MEDPACK_OPTIONS, ...options });
+  }
+
+  public override consume(): void {
+    if (!(this.parent instanceof GamePlayerEntity) || this.parent.health >= this.parent.maxHealth) {
+      return;
+    }
+
+    this.parent.updateHealth(ADD_HEALTH_AMOUNT);
+
+    super.consume(); 
+  }
+
+  public override equip(): void {
+    super.equip();
+
+    this.setPosition({ x: 0, y: 0.15, z: 0.3 });
+    this.setRotation(Quaternion.fromEuler(-90, 0, 270));
+  }
+}

package/examples/hygrounds/classes/items/ShieldPotionEntity.ts

@@ -0,0 +1,43 @@
+import { Quaternion } from 'hytopia';
+import ItemEntity from "../ItemEntity";
+import GamePlayerEntity from '../GamePlayerEntity';
+import type { ItemEntityOptions } from "../ItemEntity";
+
+const ADD_SHIELD_AMOUNT = 25;
+
+const DEFAULT_SHIELD_POTION_OPTIONS: ItemEntityOptions = {
+  heldHand: 'right',
+  iconImageUri: 'icons/shield-potion.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'shoot_gun_right',
+  modelUri: 'models/items/shield-potion.glb',
+  modelScale: 0.4,
+  name: 'Shield Potion',
+  consumable: true,
+  consumeAudioUri: 'audio/sfx/potion-consume.mp3',
+  consumeTimeMs: 1000,
+  quantity: 1,
+}
+
+export default class ShieldPotionEntity extends ItemEntity {
+  public constructor(options: Partial<ItemEntityOptions> = {}) {
+    super({ ...DEFAULT_SHIELD_POTION_OPTIONS, ...options });
+  }
+
+  public override consume(): void {
+    if (!(this.parent instanceof GamePlayerEntity) || this.parent.shield >= this.parent.maxShield) {
+      return;
+    }
+
+    this.parent.updateShield(ADD_SHIELD_AMOUNT);
+
+    super.consume(); 
+  }
+
+  public override equip(): void {
+    super.equip();
+
+    this.setPosition({ x: 0, y: 0.15, z: -0.2 });
+    this.setRotation(Quaternion.fromEuler(-90, 0, 0));
+  }
+}

package/examples/hygrounds/classes/weapons/AK47Entity.ts

@@ -0,0 +1,43 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+
+const DEFAULT_AK47_OPTIONS: GunEntityOptions = {
+  ammo: 25,
+  damage: 22,
+  fireRate: 5,
+  heldHand: 'both',
+  iconImageUri: 'icons/ak-47.png',
+  idleAnimation: 'idle_gun_both',
+  mlAnimation: 'shoot_gun_both',
+  name: 'AK-47',
+  maxAmmo: 25,
+  totalAmmo: 150,
+  scopeZoom: 2,
+  modelUri: 'models/items/ak-47.glb',
+  modelScale: 1.3,
+  range: 70,
+  reloadAudioUri: 'audio/sfx/rifle-reload.mp3',
+  reloadTimeMs: 2200,
+  shootAudioUri: 'audio/sfx/rifle-shoot.mp3',
+};
+
+export default class AK47Entity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_AK47_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return {
+      position: { x: 0, y: 0.01, z: -1.25 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+}
+

package/examples/hygrounds/classes/weapons/AutoShotgunEntity.ts

@@ -0,0 +1,80 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+
+const DEFAULT_AUTO_SHOTGUN_OPTIONS: GunEntityOptions = {
+  ammo: 6,
+  damage: 11,
+  fireRate: 1.5,
+  heldHand: 'both',
+  iconImageUri: 'icons/auto-shotgun.png',
+  idleAnimation: 'idle_gun_both',
+  mlAnimation: 'shoot_gun_both',
+  name: 'Auto Shotgun',
+  maxAmmo: 6,
+  totalAmmo: 30,
+  modelUri: 'models/items/auto-shotgun.glb',
+  modelScale: 1.2,
+  range: 8,
+  reloadAudioUri: 'audio/sfx/shotgun-reload.mp3',
+  reloadTimeMs: 3500,
+  shootAudioUri: 'audio/sfx/shotgun-shoot.mp3',
+};
+
+export default class AutoShotgunEntity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_AUTO_SHOTGUN_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return {
+      position: { x: 0.015, y: 0, z: -1 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+
+  public override shootRaycast(origin: Vector3Like, direction: Vector3Like, length: number) {
+    // Create spread pattern for auto-shotgun pellets using angles relative to direction
+    const spreadAngles = [
+      { x: 0, y: 0 },      // Center
+      { x: 0.05, y: 0.05 },  // Upper right
+      { x: -0.05, y: 0.05 }, // Upper left
+      { x: 0.07, y: 0 },   // Right
+      { x: -0.07, y: 0 },  // Left
+      { x: 0.05, y: -0.05 }, // Lower right
+      { x: -0.05, y: -0.05 } // Lower left
+    ];
+
+    // Fire each pellet with spread applied to original direction
+    for (const angle of spreadAngles) {
+      // Calculate spread direction relative to original direction
+      const spreadDirection = {
+        x: direction.x + (direction.z * angle.x), // Add horizontal spread
+        y: direction.y + angle.y,                 // Add vertical spread
+        z: direction.z - (direction.x * angle.x)  // Maintain direction magnitude
+      };
+
+      // Normalize the spread direction to maintain consistent range
+      const magnitude = Math.sqrt(
+        spreadDirection.x * spreadDirection.x + 
+        spreadDirection.y * spreadDirection.y + 
+        spreadDirection.z * spreadDirection.z
+      );
+
+      const normalizedDirection = {
+        x: spreadDirection.x / magnitude,
+        y: spreadDirection.y / magnitude,
+        z: spreadDirection.z / magnitude
+      };
+
+      super.shootRaycast(origin, normalizedDirection, length);
+    }
+  }
+}
+

package/examples/hygrounds/classes/weapons/AutoSniperEntity.ts

@@ -0,0 +1,43 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+
+const DEFAULT_AUTO_SNIPER_OPTIONS: GunEntityOptions = {
+  ammo: 10,
+  damage: 50,
+  fireRate: 1.5,
+  heldHand: 'both',
+  iconImageUri: 'icons/auto-sniper.png',
+  idleAnimation: 'idle_gun_both',
+  mlAnimation: 'shoot_gun_both',
+  name: 'Auto Sniper',
+  maxAmmo: 1,
+  totalAmmo: 12,
+  scopeZoom: 5,
+  modelUri: 'models/items/auto-sniper.glb',
+  modelScale: 1.3,
+  range: 100,
+  reloadAudioUri: 'audio/sfx/sniper-reload.mp3',
+  reloadTimeMs: 2200,
+  shootAudioUri: 'audio/sfx/sniper-shoot.mp3',
+};
+
+export default class AutoSniperEntity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_AUTO_SNIPER_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return {
+      position: { x: 0, y: 0.01, z: -2.7 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+}
+

package/examples/hygrounds/classes/weapons/BoltActionSniperEntity.ts

@@ -0,0 +1,46 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+
+const DEFAULT_BOLT_ACTION_SNIPER_OPTIONS: GunEntityOptions = {
+  ammo: 1,
+  damage: 75,
+  fireRate: 0.5,
+  heldHand: 'both',
+  iconImageUri: 'icons/bolt-action-sniper.png',
+  idleAnimation: 'idle_gun_both',
+  mlAnimation: 'shoot_gun_both',
+  name: 'Bolt Action Sniper',
+  maxAmmo: 1,
+  totalAmmo: 12,
+  scopeZoom: 5,
+  modelUri: 'models/items/bolt-action-sniper.glb',
+  modelScale: 1.3,
+  range: 100,
+  reloadAudioUri: 'audio/sfx/sniper-reload.mp3',
+  reloadTimeMs: 2200,
+  shootAudioUri: 'audio/sfx/sniper-shoot.mp3',
+};
+
+export default class BoltActionSniperEntity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_BOLT_ACTION_SNIPER_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+
+    // It's bolt action, auto reload it 300ms after a shot.
+    setTimeout(() => { this.reload() }, 300);
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return { // TODO: FIX MUZZLE FLASH POSITION
+      position: { x: 0, y: 0.01, z: -1.25 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+}
+

package/examples/hygrounds/classes/weapons/LightMachineGunEntity.ts

@@ -0,0 +1,43 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+
+const DEFAULT_LIGHT_MACHINE_GUN_OPTIONS: GunEntityOptions = {
+  ammo: 50,
+  damage: 9,
+  fireRate: 10,
+  heldHand: 'both',
+  iconImageUri: 'icons/light-machine-gun.png',
+  idleAnimation: 'idle_gun_both',
+  mlAnimation: 'shoot_gun_both',
+  name: 'Light Machine Gun',
+  maxAmmo: 50,
+  totalAmmo: 300,
+  scopeZoom: 1.35,
+  modelUri: 'models/items/light-machine-gun.glb',
+  modelScale: 1.3,
+  range: 50,
+  reloadAudioUri: 'audio/sfx/machine-gun-reload.mp3',
+  reloadTimeMs: 4200,
+  shootAudioUri: 'audio/sfx/machine-gun-shoot.mp3',
+};
+
+export default class LightMachineGunEntity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_LIGHT_MACHINE_GUN_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return {
+      position: { x: 0, y: 0.05, z: -1.7 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+}
+

package/examples/hygrounds/classes/weapons/MiningDrillEntity.ts

@@ -0,0 +1,38 @@
+import { Quaternion } from 'hytopia';
+import MeleeWeaponEntity from '../MeleeWeaponEntity';
+import type { MeleeWeaponEntityOptions } from '../MeleeWeaponEntity';
+
+const DEFAULT_MINING_DRILL_OPTIONS: MeleeWeaponEntityOptions = {
+  damage: 40,
+  attackRate: 5, 
+  heldHand: 'right',
+  iconImageUri: 'icons/mining-drill.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'shoot_gun_right', 
+  name: 'Mining Drill',
+  modelUri: 'models/items/mining-drill.glb',
+  modelScale: 0.05,
+  range: 1.5,
+  minesMaterials: true,
+  attackAudioUri: 'audio/sfx/mining-drill-drilling.mp3',
+  hitAudioUri: 'audio/sfx/dig/dig-stone.mp3',
+};
+
+export default class MiningDrillEntity extends MeleeWeaponEntity {
+  public constructor(options: Partial<MeleeWeaponEntityOptions> = {}) {
+    super({ ...DEFAULT_MINING_DRILL_OPTIONS, ...options, tag: 'mining-drill' });
+  }
+
+  public override attack(): void {
+    if (!this.parent || !this.processAttack()) return;
+
+    super.attack();
+  }
+
+  public override equip(): void {
+    super.equip();
+
+    this.setPosition({ x: -0.3, y: 0.5, z: -0.1 });
+    this.setRotation(Quaternion.fromEuler(180, 0, -90));
+  }
+}

package/examples/hygrounds/classes/weapons/PickaxeEntity.ts

@@ -0,0 +1,38 @@
+import { Quaternion } from 'hytopia';
+import MeleeWeaponEntity from '../MeleeWeaponEntity';
+import type { MeleeWeaponEntityOptions } from '../MeleeWeaponEntity';
+
+const DEFAULT_PICKAXE_OPTIONS: MeleeWeaponEntityOptions = {
+  damage: 10,         // 10 hits to kill unshielded
+  attackRate: 4.5,    // Slower attack rate to prevent spam
+  heldHand: 'right',
+  iconImageUri: 'icons/pickaxe.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'simple_interact', 
+  name: 'Pickaxe',
+  modelUri: 'models/items/pickaxe.gltf',
+  modelScale: 1.25,
+  range: 2,
+  minesMaterials: true,
+  attackAudioUri: 'audio/sfx/player/player-swing-woosh.mp3',
+  hitAudioUri: 'audio/sfx/dig/dig-stone.mp3',
+};
+
+export default class PickaxeEntity extends MeleeWeaponEntity {
+  public constructor(options: Partial<MeleeWeaponEntityOptions> = {}) {
+    super({ ...DEFAULT_PICKAXE_OPTIONS, ...options, tag: 'pickaxe' });
+  }
+
+  public override attack(): void {
+    if (!this.parent || !this.processAttack()) return;
+
+    super.attack();
+  }
+
+  public override equip(): void {
+    super.equip();
+
+    this.setPosition({ x: 0, y: 0.2, z: 0 });
+    this.setRotation(Quaternion.fromEuler(-90, 0, 90));
+  }
+}

package/examples/hygrounds/classes/weapons/PistolEntity.ts

@@ -0,0 +1,46 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+import type GamePlayerEntity from '../GamePlayerEntity';
+
+const DEFAULT_PISTOL_OPTIONS: GunEntityOptions = {
+  ammo: 15,
+  damage: 18,
+  fireRate: 6,
+  heldHand: 'right',
+  iconImageUri: 'icons/pistol.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'shoot_gun_right',
+  name: 'Pistol',
+  maxAmmo: 15,
+  totalAmmo: 75,
+  modelUri: 'models/items/pistol.glb',
+  modelScale: 1.3,
+  range: 30,
+  reloadAudioUri: 'audio/sfx/pistol-reload.mp3',
+  reloadTimeMs: 1500,
+  shootAudioUri: 'audio/sfx/pistol-shoot.mp3',
+};
+
+export default class PistolEntity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_PISTOL_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+    
+    // Cancel input since pistol requires click-to-shoot
+    (this.parent as GamePlayerEntity).player.input.ml = false;
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return {
+      position: { x: 0.03, y: 0.1, z: -0.5 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+}
+

package/examples/hygrounds/classes/weapons/RevolverEntity.ts

@@ -0,0 +1,46 @@
+import { Quaternion, Vector3Like, QuaternionLike } from 'hytopia';
+import GunEntity from '../GunEntity';
+import type { GunEntityOptions } from '../GunEntity';
+import type GamePlayerEntity from '../GamePlayerEntity';
+
+const DEFAULT_REVOLVER_OPTIONS: GunEntityOptions = {
+  ammo: 6,
+  damage: 45,
+  fireRate: 2,
+  heldHand: 'right',
+  iconImageUri: 'icons/revolver.png',
+  idleAnimation: 'idle_gun_right',
+  mlAnimation: 'shoot_gun_right',
+  name: 'Revolver',
+  maxAmmo: 6,
+  totalAmmo: 24,
+  modelUri: 'models/items/revolver.glb',
+  modelScale: 1.3,
+  range: 30,
+  reloadAudioUri: 'audio/sfx/pistol-reload.mp3',
+  reloadTimeMs: 2000,
+  shootAudioUri: 'audio/sfx/rifle-shoot.mp3',
+};
+
+export default class RevolverEntity extends GunEntity {
+  public constructor(options: Partial<GunEntityOptions> = {}) {
+    super({ ...DEFAULT_REVOLVER_OPTIONS, ...options });
+  }
+
+  public override shoot(): void {
+    if (!this.parent || !this.processShoot()) return;
+
+    super.shoot();
+    
+    // Cancel input since pistol requires click-to-shoot
+    (this.parent as GamePlayerEntity).player.input.ml = false;
+  }
+
+  public override getMuzzleFlashPositionRotation(): { position: Vector3Like, rotation: QuaternionLike } {
+    return {
+      position: { x: 0.03, y: 0.18, z: -0.7 },
+      rotation: Quaternion.fromEuler(0, 90, 0),
+    };
+  }
+}
+