Overview

The Kanga (Land) boss is an enemy in the game with animations reflecting two primary states:

• Wander Animation: The Kanga idly moves within its territory when not engaged with the player.

• Chase Animation: The Kanga aggressively chases the player.

Kanga boss also has the special ability to spawn little Joeys to attack the player.

Implementation

BossAnimationController class

/**
 * This class listens to events related to the Boss entity's state and plays the appropriate animation
 * when one of the events is triggered. The Boss has animations for wandering and chasing in both the
 * left and right directions.
 */
public class BossAnimationController extends Component {
  // Animation render component responsible for playing animations
  private AnimationRenderComponent animator;

  /**
   * Called when the component is created. Sets up listeners for the Boss movement events
   * and links them to corresponding animation triggers.
   */
  @Override
  public void create() {
    super.create();
    // Retrieves the AnimationRenderComponent from the entity
    animator = this.entity.getComponent(AnimationRenderComponent.class);

    // Set up listeners for movement-related events and assign appropriate animations
    entity.getEvents().addListener("wanderLeft", this::animateWanderLeft);
    entity.getEvents().addListener("wanderRight", this::animateWanderRight);
    entity.getEvents().addListener("chaseLeft", this::animateChaseLeft);
    entity.getEvents().addListener("chaseRight", this::animateChaseRight);
  }

  /**
   * Plays the wander animation with the entity facing left by flipping the animation on the X-axis.
   */
  private void animateWanderLeft() {
    animator.setFlipX(true);
    animator.startAnimation("wander");
  }

  /**
   * Plays the wander animation with the entity facing right (default direction).
   */
  private void animateWanderRight() {
    animator.setFlipX(false);
    animator.startAnimation("wander");
  }

  /**
   * Plays the chase animation with the entity facing left by flipping the animation on the X-axis.
   */
  private void animateChaseLeft() {
    animator.setFlipX(true);
    animator.startAnimation("chase");
  }

  /**
   * Plays the chase animation with the entity facing right (default direction).
   */
  private void animateChaseRight() {
    animator.setFlipX(false);
    animator.startAnimation("chase");
  }
}

Used in BossFactory class

     /**
     * Creates a boss NPC to be used as a boss entity by more specific NPC creation methods.
     *
     * @param target the entity to chase
     * @param type the type of the boss
     * @return entity
     */
    public static Entity createBossNPC(Entity target, Entity.EnemyType type, BaseEnemyEntityConfig config) {

        AnimationRenderComponent animator =
                new AnimationRenderComponent(
                        ServiceLocator.getResourceService().getAsset(config.getSpritePath(), TextureAtlas.class));
        animator.addAnimation("wander", 0.1f, Animation.PlayMode.LOOP);
        animator.addAnimation("chase", 0.1f, Animation.PlayMode.LOOP);

        Entity npc = new Entity()
                .addComponent(animator)
                .addComponent(new BossAnimationController());

        return npc;
    }

JoeyAnimationController

public class JoeyAnimationController extends Component {
    AnimationRenderComponent animator;

    @Override
    public void create() {
        super.create();
        // Get the AnimationRenderComponent associated with the entity and store it in the animator field
        animator = this.entity.getComponent(AnimationRenderComponent.class);
        entity.getEvents().addListener("spawnStart", this::animateSpawn);
        entity.getEvents().addListener("wanderLeft", this::animateWanderLeft);
        entity.getEvents().addListener("wanderRight", this::animateWanderRight);
        entity.getEvents().addListener("chaseLeft", this::animateChaseLeft);
        entity.getEvents().addListener("chaseRight", this::animateChaseRight);
    }

    private void animateSpawn() {
        animator.startAnimation("spawn");
    }

    private void animateWanderLeft() {
        animator.setFlipX(true);
        animator.startAnimation("wander");
    }

    private void animateWanderRight() {
        animator.setFlipX(false);
        animator.startAnimation("wander");
    }

    private void animateChaseLeft() {
        animator.setFlipX(true);
        animator.startAnimation("chase");
    }

    private void animateChaseRight() {
        animator.setFlipX(false);
        animator.startAnimation("chase");
    }
}

Used in EnemyFactory class

public static Entity createJoey(Entity target) {
    Entity joey = createBaseEnemy(target, EnemyType.JOEY);
    BaseEnemyEntityConfig config = configs.joey;
    joey.setEnemyType(Entity.EnemyType.JOEY);

    AnimationRenderComponent animator =
            new AnimationRenderComponent(
                    ServiceLocator.getResourceService().getAsset(config.getSpritePath(), TextureAtlas.class));
    animator.addAnimation("wander", 0.1f, Animation.PlayMode.LOOP);
    animator.addAnimation("chase", 0.1f, Animation.PlayMode.LOOP);
    animator.addAnimation("spawn", 1.0f, Animation.PlayMode.NORMAL);

    joey.addComponent(animator)
        .addComponent(new JoeyAnimationController());

    joey.getComponent(AnimationRenderComponent.class).scaleEntity();

    return joey;
  }

Testing Plan

Visual Testing - https://youtu.be/yU9CXT3zjS0

https://github.com/user-attachments/assets/8cd3d9bb-1fea-43e9-b8b3-2c146fc2736d

For visual confirmation of the animations and behaviour of Kanga Boss and its ability to spawn Joeys, a video recording was created to ensure the following aspects are functioning as intended:

1. Wander Animation (Kanga): The Kanga boss idly roams its designated territory when not engaged with the player, with correct left and right flipping depending on its movement direction.

2. Chase Animation (Kanga): When the player is detected, the Kanga boss transitions into a chase animation. The boss correctly flips its orientation based on the direction of movement, and the animation runs smoothly with no visible glitches.

3. Joey Spawn Animation: The special ability of the Kanga boss allows it to spawn Joeys to attack the player. This animation plays correctly during the spawn event, ensuring that the Joey appears as expected in the game environment.

4. Joey Wander Animation: After being spawned, Joeys idle or wander around the area when not directly engaging the player. The wander animation plays smoothly, including the left and right directional flips based on movement.

5. Joey Chase Animation: Like the Kanga boss, Joeys also have a chase animation when they pursue the player. The video demonstrates the smooth transition from idle to chase, with correct orientation based on direction.

All these animations were visually confirmed in the gameplay environment and documented through the video above. This method of visual testing compensates for the limitations of automated testing in areas of graphical rendering, ensuring that the animations behave as expected in a live game scenario.

Code Coverage & Reliability Report

The automated testing results show that the Boss Factory and related systems have a 76.4% code coverage, focusing primarily on the logic and functionality of the Kanga and Joey entities. The remaining 23.6% of the code is primarily related to visual rendering, which cannot be covered by standard unit tests and is instead verified through the visual testing described above.

Code Coverage Summary:

• Line Coverage: 76.0% - This measures how much of the executable code has been tested. Uncovered lines are mainly tied to graphical rendering, where visual confirmation is more reliable than automated testing.

Bugs and Vulnerabilities:

• Bugs: 0 - No bugs have been identified in the code.
• Vulnerabilities: 0 - No security vulnerabilities were detected, ensuring the system is secure.

Maintainability:

• Code Smells: 7 - These refer to areas in the code that could be improved for readability, maintainability, or efficiency. However, they do not negatively impact the performance or functionality of the game.

UML Diagram

Sequence Diagram

Class Diagram