GameCharacter.java

package vooga.scroller.sprites.superclasses;

import java.awt.Dimension;
import util.Location;
import util.Vector;
import vooga.scroller.level_editor.Level;
import vooga.scroller.sprites.Sprite;
import vooga.scroller.sprites.interfaces.Locatable;
import vooga.scroller.util.ISpriteView;

/**
 * UPDATE - This is the superclass for all sprites a game designer creates 
 * that interact in the game as living things. Critical in this class 
 * are the myHealth and myDamage fields. If you have a sprite that can die 
 * and/or cause damage to another sprite, then you want a GameCharacter.
 * 
 * @author Jay Wang
 * @author Scott Valentine
 *
 */
public abstract class GameCharacter extends Sprite implements Locatable{

    /**
     * Default speed of a game character.
     */
    public static Vector DEFAULT_SPEED = new Vector(0, 45);
    
    private int myHealth;
    private int myDamage;
    private Locatable myTarget;

    
    /**
     * Builds a new GameCharacter that interacts with other game characters in the game.
     * 
     * @param image is the view of the character.
     * @param size is the dimensions of the character.
     * @param health is the initial health of the character.
     * @param damage is the initial damage of the character.
     */
    public GameCharacter (ISpriteView image, Dimension size, int health, int damage) {
        super(image, size);
        myHealth = health;
        myDamage = damage;
    }
    
    /**
     * Builds a new GameCharacter that interacts with other game characters in the game at the given location.
     * 
     * @param image is the view of the character.
     * @param size is the dimensions of the character.
     * @param health is the initial health of the character.
     * @param damage is the initial damage of the character.
     */
    public GameCharacter (ISpriteView image, Dimension size, int health, int damage, Location location) {
        super(image, location, size);
        myHealth = health;
        myDamage = damage;
    }

    public void update (double elapsedTime, Dimension bounds) {
        super.update(elapsedTime, bounds);
    }
    
    /**
     * This sprite takes damage from its health.
     * 
     * @param damage is the value that this looses from its health.
     */
    public void takeHit(int damage) {
        myHealth -= damage;
    }

    /**
     * Gives the value that an attack of this character will give.
     * 
     * @return The value of the sprite's hit.
     */
    public int getHit () {
        return myDamage;
    }
    
    /**
     * Gives this characters current health.
     * 
     * @return An integer represeting this character's current health.
     */
    public int getHealth() {
        return myHealth;
    }
    
    /**
     * Sets the health of this character.
     * 
     * @param health value for this character.
     */
    public void setHealth(int health) {
        myHealth = health;
    }
    
    /**
     * Gives a target sprite for this to target.
     * @param targetSprite is the sprite that this will target.
     */
    public void addTarget(Locatable targetSprite) {
        myTarget = targetSprite;
    }
    
    /**
     * This defines where this sprite is targeting, if it is at all targeting.
     * @return
     */
    public Locatable getLocatable() {
        return myTarget;
    }
    
    /**
     * Defines how to handle the death of this character.
     */
    public abstract void handleDeath(Level level);
    
}