Sprint 3 Main Character New Unlockable Attires and Functionality improvement

• Link to Sprint 2 Documentation

Contents

• Automatic Item PickUp Implementation
• Buff Debuffs Animation Integration
• Unlockable Attires
• Texture Atlas
• Testing
• UML Diagrams
• Relevant Files

Automatic Item PickUp Implementation

When the main player - Jason collides with an item, Jason will automatically pick up the item. With this feature, the user has no need to press a key to initiate item pickup.

PlayerFactory.java

    switch (attire) {

            ...
            case "OG":
            default:
                mpcAnimator = createAnimationComponent("images/mpc/finalAtlas/OG/mpcAnimation.atlas");
                mpcTexture = new TextureRenderComponent("images/mpc/finalAtlas/OG/mpc_right.png");
                break;
        }
    ...
    mpcAnimator.addAnimation("main_player_pickup",0.125f,Animation.PlayMode.LOOP);

Automatic Item Pick Up animation is triggered from ItemComponent.java

After 1s the animation is stopped.

    private void onCollisionStart(Fixture me, Fixture other){

        if (PhysicsLayer.contains(PhysicsLayer.PLAYER, other.getFilterData().categoryBits)) {
           // checking if the collision is done with the player
           callback.accept(target);
           target.getEvents().trigger("itemPickUp");
           entity.getEvents().trigger("itemPickedUp");
           ...
           try {
               ...
               // after 1s stop the item pickUp animation
               Timer timer=new Timer();
               timer.scheduleTask(new Timer.Task() {
                   @Override
                   public void run() {
                       target.getEvents().trigger("stopPickUp");
                       timer.stop();
                   }
               },1);
           }
           catch (Exception e){
               System.out.print(e);
           }
        }
    }

Buff Debuffs Animation Integration

As the player Jason interacts progress in the game, it will experience buffs and debuffs from interacting with the obstacles and items.

Buffs And Debuffs Map

Buff/ Debuff	Type
Hungry	Debuff
Poisoned	Debuff
Dizzy	Debuff
Health Down	Debuff
Health Limit UP	Debuff
Speed Down	Debuff
Thirsty	Debuff
Recovered	Buff
Health Up	Buff

PlayerFactory.java adds the animation for those buffs and debuffs

These buffs/Debuffs are added for each movement animation.

           ...
            mpcAnimator.addAnimation("main_player_run_dizzy", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_health-down", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_health-limit-up", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_health-up", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_hungry", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_poisoned", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_recovered", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_speed-down", 0.1f, Animation.PlayMode.LOOP);
            mpcAnimator.addAnimation("main_player_run_thirsty", 0.1f, Animation.PlayMode.LOOP);
           ...

The listeners implemented here lookout for trigger events and run the corresponding functions in PlayerAnimationController.java. These functions are discussed in detail in the following sections of the wiki.

     ...
     public void create() {
        super.create();
        animator = this.entity.getComponent(AnimationRenderComponent.class);
        ...
        entity.getEvents().addListener("hungry", this::animateHungry);
        entity.getEvents().addListener("poisoned", this::animatePoison);
        entity.getEvents().addListener("healthDown", this::animateHealthDown);
        entity.getEvents().addListener("dizzy", this::animateDizzy);
        entity.getEvents().addListener("health_limit_up", this::animateHealthLimit);
        entity.getEvents().addListener("healthUp", this::animateHealthUP);
        entity.getEvents().addListener("recovered", this::animateRecovered);
        entity.getEvents().addListener("speedDown", this::animateSpeedDown);
        entity.getEvents().addListener("thirsty", this::animateThirsty);
        entity.getEvents().addListener("stopBuffDebuff", this::animateWalk);
    }
    ...

Each time an animation event is triggered, a function is used to start the animation for the buff/debuff while taking into account the previous animation that was running and runs an animation for buff/debuff corresponding to that animation.

    
   ...
   
   /**
     *  Activate the hungry animation debuff
     */
    private void animateHungry() {
        animationName = animator.getCurrentAnimation();
        preAnimationCleanUp();
        switch (animationName) {
            case "main_player_run":
                animator.startAnimation("main_player_run_hungry");
                break;
            case "main_player_pickup":
                animator.startAnimation("main_player_pickup_hungry");
                break;
            case "main_player_jump":
                animator.startAnimation("main_player_jump_hungry");
                break;
            case "main_player_attack":
                animator.startAnimation("main_player_attack_hungry");
                break;
            case "main_player_crouch":
                animator.startAnimation("main_player_crouch_hungry");
                break;
            case "main_player_right":
                animator.startAnimation("main_player_right_hungry");
                break;
            case "main_player_walk":
            default:
                animator.startAnimation("main_player_walk_hungry");
                break;
        }
    }
  ...

Unlockable Attires

Texture Atlas

Buff/Debuff Atlas

For the different attires, we have the same atlas in terms of creating buffs/ debuffs animation and was generated using a texture packer. The atlas has player buff representations for all the movements (explained in Sprint 2 Documentation )in the following states:

1. Dizzy (facing right, animated)
2. Hungry (facing right, animated)
3. Poisoned (facing right, animated)
4. Health Down (facing right, animated)
5. Speed Down (facing right, animated)
6. Thirsty (facing right, animated)
7. Recovered (facing right, animated)
8. Health UP (facing right, animated)
9. Health Limit Up (facing right, animated)

Atlas Files

For OG Attire : mpcAnimation.atlas

For Gold_4 Attire : mpcAnimation_4.atlas

For Gold_6 Attire : mpcAnimation_6.atlas

Generated Texture pack

The bellow image file shows the atlas image for Gold_6 attire.

mpcAnimation.png

Testing

Considering it is hard to test whether an animation plays because of its visual nature, unit tests were written to verify and validate that when an animation event is triggered the corresponding movement animation is triggered. The tests check that all the expected animations actually are rendered when their respective events are triggered.

PlayerAnimationRenderTest.java

@ExtendWith(GameExtension.class)
class PlayerAnimationRenderTest {

    private Entity player;
    private AnimationRenderComponent animator;
    @BeforeEach
    void beforeEach() {
        ServiceLocator.registerPhysicsService(new PhysicsService());
        player = new Entity()
                .addComponent(new PhysicsComponent())
                .addComponent(new PlayerAnimationController());

        animator = mock(AnimationRenderComponent.class);
        player.addComponent(animator);

        PlayerAnimationController animationController =
                player.getComponent(PlayerAnimationController.class);
        animationController.setTexturePresent(false);
        player.create();
    }


    @Test
    void shouldTriggerRightMovement() {
        player.getEvents().trigger("walkRight");
        verify(animator).startAnimation("main_player_run");
    }

    @Test
    void shouldTriggerWalkMovement() {
        player.getEvents().trigger("startMPCAnimation");
        verify(animator).startAnimation("main_player_walk");
    }

    @Test
    void shouldTriggerJumpMovement() {
        player.getEvents().trigger("jump");
        verify(animator).startAnimation("main_player_jump");
    }

    @Test
    void shouldTriggerCrouchMovement() {
        player.getEvents().trigger("crouch");
        verify(animator).startAnimation("main_player_crouch");
    }

    @Test
    void shouldTriggerItemPickUpMovement() {
        player.getEvents().trigger("itemPickUp");
        verify(animator).startAnimation("main_player_pickup");
    }

    @Test
    void shouldTriggerAttackMovement() {
        player.getEvents().trigger("attack");
        verify(animator).startAnimation("main_player_attack");
    }
}

UML Diagrams

Class Diagram

Sequence Diagrams

Relevant Files

PlayerFactory.java

PlayerAnimationController.java

PlayerAnimationRenderTest.java

ItemComponent.java

mpcAnimation.atlas

mpcAnimation_4.atlas

mpcAnimation_6.atlas

mpcAnimation.png

mpcAnimation_4.png

mpcAnimation_6.png