school/cs142/lab10/FighterInterface.h

#pragma once
#include <iostream>
#include <string>
using namespace std;

/*
	WARNING: It is expressly forbidden to modify any part of this document, including its name
*/

/*
	This class specifies the methods for a fighter.

	All fighters have the following attributes:
		Name - The fighter's name.
		Hit Points - The amount of health the fighter has, with a specified maximum.  Reaching 0 is equivalent to death.
		Strength - Physical power, used to determine hit point regeneration.
		Speed - Dexterity and physical movement, used to reduce damage when being attacked.
		Magic - Magical prowess, used for some special abilities.

	The three fighter types have unique abilities:
		Robot - Relies on strength to deal damage.  Also can use stored electricity to temporarily increase damage (max electricity equal to 2*magic).
		Archer - Relies on speed to deal damage.  Also can increase its speed for the remainder of the battle (no max bonus speed).
		Cleric - Relies on magic to deal damage.  Also can heal itself using mana, restoring hit points (max mana equal to 5*magic).

	More details about how stats are used and how abilities work can be found in the comments below.
*/

/*
	ROBOT_ABILITY_COST
	The amount of energy a Robot needs to perform its special ability.
*/
const int ROBOT_ABILITY_COST = 5;

/*
	CLERIC_ABILITY_COST
	The amount of mana a Cleric needs to perform its special ability.
*/
const int CLERIC_ABILITY_COST = 25;

class FighterInterface
{
	public:
		FighterInterface(){}
		virtual ~FighterInterface(){}
		
		/*
			getName()

			Returns the name of this fighter.
		*/
		virtual string getName() = 0;

		/*
			getMaximumHP()

			Returns the maximum hit points of this fighter.
		*/
		virtual int getMaximumHP() = 0;

		/*
			getCurrentHP()

			Returns the current hit points of this fighter.
		*/
		virtual int getCurrentHP() = 0;

		/*
			getStrength()

			Returns the strength stat of this fighter.
		*/
		virtual int getStrength() = 0;

		/*
			getSpeed()

			Returns the speed stat of this fighter.
		*/
		virtual int getSpeed() = 0;

		/*
			getMagic()

			Returns the magic stat of this fighter.
		*/
		virtual int getMagic() = 0;

		/*
			getDamage()

			Returns the amount of damage a fighter will deal.

			Robot:
			This value is equal to the Robot's strength plus any additional damage added for having just used its special ability.

			Archer:
			This value is equal to the Archer's speed.

			Cleric:
			This value is equal to the Cleric's magic.
		*/
		virtual int getDamage() = 0;

		/*
			takeDamage(int)

			Reduces the fighter's current hit points by an amount equal to the given 
			damage minus one fourth of the fighter's speed.  This method must reduce 
			the fighter's current hit points by at least one.  It is acceptable for 
			this method to give the fighter negative current hit points.

			Examples:
				damage=10, speed=7		=> damage_taken=9
				damage=10, speed=9		=> damage_taken=8
				damage=10, speed=50		=> damage_taken=1
		*/
		virtual void takeDamage(int damage) = 0;

		/*
			reset()

			Restores a fighter's current hit points to its maximum hit points.

			Robot:
			Also restores a Robot's current energy to its maximum value (which is 2 times its magic).
			Also resets a Robot's bonus damage to 0.

			Archer:
			Also resets an Archer's current speed to its original value.

			Cleric:
			Also restores a Cleric's current mana to its maximum value (which is 5 times its magic).
		*/
		virtual void reset() = 0;

		/*
			regenerate()

			Increases the fighter's current hit points by an amount equal to one sixth of
			the fighter's strength.  This method must increase the fighter's current hit 
			points by at least one.  Do not allow the current hit points to exceed the 
			maximum hit points.

			Cleric:
			Also increases a Cleric's current mana by an amount equal to one fifth of the 
			Cleric's magic.  This method must increase the Cleric's current mana by at 
			least one.  Do not allow the current mana to exceed the maximum mana.
		*/
		virtual void regenerate() = 0;

		/*
			useAbility()
			
			Attempts to perform a special ability based on the type of fighter.  The 
			fighter will attempt to use this special ability just prior to attacking 
			every turn.

			Robot: Shockwave Punch
			Adds bonus damage to the Robot's next attack (and only its next attack) equal to (strength * ((current_energy/maximum_energy)^4)).
			Can only be used if the Robot has at least [ROBOT_ABILITY_COST] energy.
			Decreases the Robot's current energy by [ROBOT_ABILITY_COST] (after calculating the additional damage) when used.
				Examples:
				strength=20, current_energy=20, maximum_energy=20		=> bonus_damage=20
				strength=20, current_energy=15, maximum_energy=20		=> bonus_damage=6
				strength=20, current_energy=10, maximum_energy=20		=> bonus_damage=1
				strength=20, current_energy=5,  maximum_energy=20		=> bonus_damage=0
			Robot Note:
			The bonus damage formula should be computed using double arithmetic, and only 
			the final result should be cast into an integer.

			Archer: Quickstep
			Increases the Archer's speed by one point each time the ability is used.
			This bonus lasts until the reset() method is used.
			This ability always works; there is no maximum bonus speed.

			Cleric: Healing Light
			Increases the Cleric's current hit points by an amount equal to one third of its magic.
			Can only be used if the Cleric has at least [CLERIC_ABILITY_COST] mana.
			Will be used even if the Cleric's current HP is equal to their maximum HP
			Decreases the Cleric's current mana by [CLERIC_ABILITY_COST] when used.
			Cleric Note:
			This ability, when successful, must increase the Cleric's current hit points 
			by at least one.  Do not allow the current hit points to exceed the maximum 
			hit points.

			Return true if the ability was used; false otherwise.
		*/
		virtual bool useAbility() = 0;

		/*
			isSimplified()

			Returns true if you have not completed the useAbility() and/or the regenerate()
			methods for this type of fighter.  This allows the test driver to award points 
			for Part 3 even if Part 4 is incomplete.
			
			Return true if the testing is to be simplified; false otherwise.
		*/
		virtual bool isSimplified() = 0;
};