UQ 2025 Studio 4

📖 Description

This project is developed as part of CSSE3200 Software Engineering Studio at the University of Queensland.
It provides a fun, team-based environment in which students collaboratively design, implement, and test a working game over the semester.

The engine is built on the libGDX framework and written in Java.
It is open-sourced under the MIT License.

---

🎯 Feature Team Contribution – Hero System

Our feature team is responsible for implementing the Hero System, including:

• Rotating Hero Rendering
  Hero sprite rotates to face the mouse cursor using a new RotatingTextureRenderComponent.

• Hero Turret Attack Component
  Hero can shoot bullets towards the mouse with configurable attributes:

  • cooldown (attack rate)
  • bulletSpeed
  • bulletLife
  • damage

• Integration with Game Engine
  Implemented in HeroFactory to spawn a hero with physics, collision, rendering, and attack logic.
  Fully integrated with the engine's Entity Component System (ECS) and ProjectileFactory.

---

📂 File Structure and Responsibilities

🎨 Assets

source/core/assets/images/
├─ hero/
│ ├─ Heroshoot.png # Default hero sprite (rotatable)
│ └─ Bullet.png # Bullet sprite
└─ base_enemy.png # Enemy sprite (used in EnemyFactory)

Asset Purposes

• hero/ – folder containing hero sprites (used in HeroFactory & HeroTurretAttackComponent).
• base_enemy.png – default enemy sprite, used in EnemyFactory.

---

🧩 Code

source/core/src/main/com/csse3200/game/
├─ components/
│ └─ hero/
│ └─ HeroTurretAttackComponent.java # Handles aiming, shooting, cooldown logic
│
│ └─ projectile/
│ ├─ ProjectileComponent.java # Controls bullet velocity & lifetime
│ ├─ DestroyOnHitComponent.java # Destroys bullet on collision
│ └─ TouchAttackComponent.java # Applies bullet damage to enemies
│
├─ entities/
│ ├─ factories/
│ │ ├─ HeroFactory.java # Builds hero entity (physics, rendering, attack, combat stats)
│ │ ├─ EnemyFactory.java # Builds enemy entities with AI/behaviour
│ │ └─ ProjectileFactory.java # Creates bullet entities with texture, speed, lifetime, damage
│ └─ Enemies/
│ └─ Enemy.java # Base enemy entity definition
│
├─ rendering/
│ ├─ TextureRenderComponent.java # Static texture rendering (used by tests)
│ └─ RotatingTextureRenderComponent.java # Rotating texture rendering (used by Hero & projectiles)
│
├─ physics/
│ ├─ components/ColliderComponent.java # Collision handling
│ ├─ components/HitboxComponent.java # Hitbox layer setup
│ └─ PhysicsLayer.java # Defines collision layers (PLAYER, ENEMY, PROJECTILE, etc.)
│
└─ entities/configs/
├─ HeroConfig.java # Config values for hero (health, attack, cooldown, textures)
└─ EnemyConfig.java # Config values for enemies

File Purposes

• HeroTurretAttackComponent.java – Controls hero’s turret behaviour (aim, rotation, shooting).
• HeroFactory.java – Central place to spawn hero entity with all required components.
• ProjectileFactory.java – Creates bullets with physics, damage, and collision handling.
• ProjectileComponent.java – Controls bullet flight and timed cleanup.
• TouchAttackComponent.java – Applies bullet damage to enemy entities on collision.
• DestroyOnHitComponent.java – Ensures bullet is safely removed when hitting an enemy.
• RotatingTextureRenderComponent.java – Provides rotation support for rendering hero/projectile sprites.
• EnemyFactory.java & Enemy.java – Build and define enemy entities, integrated alongside hero for combat interactions.
• HeroConfig.java / EnemyConfig.java – Store configurable attributes (HP, attack, textures, cooldowns).
• Physics components – Ensure hero/enemy/projectiles interact correctly (collisions, layers).

---

🔫 Projectiles / Bullets

🔎 Responsibilities

• ProjectileFactory – Standardised creation of bullets with texture, velocity, lifetime, and combat stats.
• ProjectileComponent – Handles bullet motion and removes it after its lifetime expires.
• TouchAttackComponent – Applies bullet damage (from CombatStatsComponent) to enemies on collision.
• DestroyOnHitComponent – Ensures the bullet is destroyed safely on collision.
• HeroTurretAttackComponent – Spawns bullets and passes damage/speed/lifetime attributes.
• PhysicsLayer.PROJECTILE – Ensures bullets collide with ENEMY but not PLAYER.

---

🔁 Lifecycle (actual)

1. Spawn → HeroTurretAttackComponent calls ProjectileFactory.createBullet(...).
   The bullet entity is created with:

   • TextureRenderComponent (rendering)
   • PhysicsComponent (movement & collisions)
   • ProjectileComponent(vx, vy, life) (velocity & lifetime)
   • CombatStatsComponent(damage) (stores bullet damage)
   • TouchAttackComponent (applies damage to enemies)
   • DestroyOnHitComponent (destroys bullet on collision)

2. Init → In ProjectileComponent.create(), the lifetime timer starts and the physics body is given linear velocity.

3. Fly → Bullet travels through the world under physics simulation.

4. End → The bullet is removed when either condition occurs:

   • Hit: TouchAttackComponent applies damage to the enemy; DestroyOnHitComponent schedules bullet destruction.
   • Timeout: ProjectileComponent.update() timer expires → disables physics → schedules bullet destruction.

5. Cleanup → Actual destruction (entity.dispose() + EntityService.unregister()) is deferred with Gdx.app.postRunnable to avoid concurrent modification during entity iteration.

---

📑 Documentation and Reports

• JavaDoc – Provided for all hero and projectile components.
• SonarCloud – Used for code quality checks and static analysis.