Item Pickup - UQdeco2800/2021-ext-studio-2 GitHub Wiki

Description:

The items on the game world anywhere could be picked up by the character.

Different sorts of items may have different spawning ways and provide same buff (increasing health 10 point for the player character) in current version sprint2

1.First_Aid_Kit

spawning ways: dropping out randomly

born at: ItemFactory.java

public static Entity createFirstAid(Entity target){
        /**
         * creates an entity for a firstAidKit
         * @param target The entity which is passed on to the first Aid component
         * @return entity
         */

        Entity firstAid = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/first_aid_kit.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new ItemComponent(target, (player) -> inchealth.increaseHealth(player)));

        return firstAid;
    }

use of the item: increase the health of the character

pick-up styles: The character can pick up the item directly or by destorying obstacles

ItemComponent & trigger event: The "collisionStart" event will be added to the entity licenser, "hitboxComponent" will be added to the entity to check if there is a collision between the character and the obstacle, when the first_aid_kit item is created from the item factory

public void create(){
        firstAid.getEvents().addListener("collisionStart", this::onCollisionStart);
        hitboxComponent = firstAidKit.getComponent(HitboxComponent.class);
}

If the player ovelapped with the obsatcle and has a collision, the "itemPickedup" event will be triggered and the items effect heals the player

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);
                    entity.getEvents().trigger("itemPickedUp");
                    AchievementsHelper.getInstance().trackItemPickedUpEvent();
                    Body physBody = entity.getComponent(PhysicsComponent.class).getBody();
                    if (physBody.getFixtureList().contains(other, true)) {
                       physBody.destroyFixture(other);
                    }
                    AchievementsHelper.getInstance().trackItemPickedUpEvent(AchievementsHelper.ITEM_FIRST_AID);
                    try {
                       entity.getComponent(TextureRenderComponent.class).dispose();
                       ServiceLocator.getEntityService().unregister(entity);
                    }
                    catch (Exception e){
                       System.out.print(e);
                   }
        }
    }

2.Apple

spawning ways: dropping out randomly

born at: ItemFactory.java

public static Entity createApple(Entity target){
        /**
         * creates an entity for a apple
         * @param target The entity which is passed on to the first Aid component
         * @return entity
         */
        Entity apple = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/food.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new ItemComponent(target,(player) -> inchealth.increaseHealth(player)));

        return apple;
    }

implementing ways: same as First_Aid_Kit

3.Water

born at: ItemFactory.java

public static Entity createWater(Entity target){
        /**
         * creates an entity for a water
         * @param target The entity which is passed on to the first Aid component
         * @return entity
         */
        Entity water = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/water.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new ItemComponent(target,(player) -> inchealth.increaseHealth(player)));

        return water;
    }

implementing ways: same as First_Aid_Kit

spawning ways: dropping out by achievement triggering

spawning working progress: (AchievementsBonusItem.java)

Firstly, the event "spawningBonusItem" will be added to the AchievementHelper when the game world be created(ForestGameArea.java)

private void setBonusItems(Entity player) {
        AchievementsBonusItems bonusItems = new AchievementsBonusItems(player);
        bonusItems.setBonusItem();
    }
public void setBonusItem() {
        AchievementsHelper.getInstance().getEvents().addListener("spawnBonusItem", this::spawnBonusItem);
    }

Once the player character unlock one achievement, a random sort of bonus item will be spawned

/**
     *  This func is used to spawn bonus items at the game world
     *  and the sort of bonus items spawned is random
     */
    public void spawnBonusItem() {
        new Thread(() -> {
            try {
                r = new Random(++RandomSeed);  //random func
                ran1 = r.nextInt(++result);    //random func
                if (ran1 % 4 == 1) {
                bonusItem = ItemFactory.createWater(this.getTarget());
                } else if (ran1 % 4 == 2) {
                    bonusItem = ItemFactory.createMagicPotion(this.getTarget());
                } else if (ran1 % 4 == 3) {
                    bonusItem = ItemFactory.createSyringe(this.getTarget());
                } else {
                    bonusItem = ItemFactory.createBandage(this.getTarget());
                }
                Vector2 vector2 = new Vector2(this.target.getPosition());
                vector2.add(5,0);
                bonusItem.setPosition(vector2);
                ServiceLocator.getEntityService().register(bonusItem);
                Thread.sleep(RENDER_DURATION);
            }
            catch (InterruptedException ignored){
            }
        }).start();

    }

4.Magic potion

spawning ways: dropping out by achievements triggering

born at: ItemFactory.java

public static Entity createMagicPotion(Entity target){
        /**
         * creates an entity for a magic potion
         * @param target The entity which is passed on to the first Aid component
         * @return entity
         */
        Entity magicPotion = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/magic_potion.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new ItemComponent(target,(player) -> inchealth.increaseHealth(player)));

        return magicPotion;
    }

implementing ways: same as Water

5.Bandage

spawning ways: dropping out by achievements triggering

born at: ItemFactory.java

public static Entity createBandage(Entity target){
        /**
         * creates an entity for a bandage
         * @param target The entity which is passed on to the first Aid component
         * @return entity
         */
        Entity bandage = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/bandage.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new ItemComponent(target,(player) -> inchealth.increaseHealth(player)));

        return bandage;
    }

implementing ways: same as Water

6.Syringe

spawning ways: dropping out by achievements triggering

born at: ItemFactory.java

public static Entity createSyringe(Entity target){
        /**
         * creates an entity for a syringe
         * @param target The entity which is passed on to the first Aid component
         * @return entity
         */
        Entity syringe = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/syringe.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new ItemComponent(target,(player) -> inchealth.increaseHealth(player)));

        return syringe;
    }

implementing ways: same as Water

7.GoldCoin

spawning ways: dropping out randomly

born at: ItemFactory.java

public static Entity createGold(Entity target){
        /**
         * creates an entity for a gold
         * @param target The entity which is passed on to the gold component
         * @return entity
         */
        Entity gold = new Entity()
                .addComponent(new TextureRenderComponent("images/Items/goldCoin.png"))
                .addComponent(new PhysicsComponent())
                .addComponent(new ColliderComponent())
                .addComponent(new GoldComponent(target));
        gold.getComponent(TextureRenderComponent.class).scaleEntity();
        gold.scaleHeight(0.8f);
        PhysicsUtils.setScaledCollider(gold, 0.5f, 0.2f);

        return gold;
    }

implementing ways: similar to First_Aid_Kit The different between the goldCoin and other items is the difference of component(GoldComponent vs ItemComponent). Under GoldComponent.java, its onCollisionStart func(check if the item able to pick up) is same as the others. However there is new recordGold(int gold) func in the GoldComponent.java, it is used to store the amount of gold taken for the player in the current game round and the gold could be used at the props shop in the next game round.

/**
     * This func is used to store the amount of goldCoin got from the player character
     * @param  gold the amount of goldCoin got from the player character in the current game round
     */
    private void recordGold(int gold) {
        try{
            String goldAmountLastRound = Integer.toString(gold);

            fileWriter.write(goldAmountLastRound);
            fileWriter.flush();
            fileWriter.close();
        }catch(IOException e){
            e.printStackTrace();
        }
    }