Healing Tool

Introduction

The Healing Tool is a component of the game that allows players to interact with entities and heal them. To heal any entity such as turret or wall after damage, we need to press 3 and then T-Key on keyboard respectively. A toolbox opens where we can see the heal icon. We click on the heal icon to activate the healing component and then click on either wall or turret to heal the health to maximum.

Table of Contents

• Overview
• Code Structure
• Usage
• UML Diagram
• Purpose
• [Testing)(#testing)
• Future Work

Overview

The Healing Tool is a subclass of the Tool class and is responsible for healing entities in the game. Below, we'll dive into the details of the code.

Code Structure

Healing Class

The Healing class is the main component responsible for healing entities. It is a subclass of the Tool class.

Constructor

The Healing class has a constructor that accepts a map of costs. The cost map is used to specify the resource cost of using this healing tool.

public Healing(ObjectMap<String, Integer> cost) {
    super(cost);
}

Interact Method

The interact method allows the player to interact with entities in the game world. It checks if the player has clicked on an entity, and if so, it attempts to heal the entity by setting its health to its maximum health value.

@Override
public boolean interact(Entity player, GridPoint2 position) {
    Entity clickedEntity = determineSelectedEntity(position);

    if (clickedEntity == null) {
        return false;
    }

    CombatStatsComponent combatStats = clickedEntity.getComponent(CombatStatsComponent.class);

    if (combatStats == null) {
        return false;
    }

    combatStats.setHealth(combatStats.getMaxHealth());
    return true;
}

determineSelectedEntity Method

The determineSelectedEntity method is a private helper function that determines which entity the player has clicked on. It uses the ServiceLocator to access the StructurePlacementService and retrieve the entity at the specified position.

private Entity determineSelectedEntity(GridPoint2 position) {
    return ServiceLocator.getStructurePlacementService().getStructureAt(position);
}

UML Diagram

Purpose

The purpose of adding healing feature in the game is to basically enable players to strengthen their defence during gameplay. Be it preventing the walls from collapsing or the turrets from getting damaged, the healing tool handles it all.

Testing

The healing feature was tested by placing the gates and turrets near enemies and luring them to attack those. Since enemies' attack reduced the health of both of these entities, we were able to heal these entities to maximum by clicking 3 and T-Key respectively, then clicking on the heal icon, and finally clicking on the entity that we wanted to heal.

Future Work

In coming weeks, we will develop the healing feature to heal as per our requirement in accordance with the resources collected. We might assign a cost per percent of healing. This will enable us to figure the resources (having specific costs allocated to themselves) that are needed for a specific percent of healing of desired entity.