SpaceScooter/src/de/teamteamteam/spacescooter/entity/ShootingEntity.java

package de.teamteamteam.spacescooter.entity;

import de.teamteamteam.spacescooter.entity.shot.Beam;
import de.teamteamteam.spacescooter.entity.shot.Rocket;
import de.teamteamteam.spacescooter.entity.shot.Shot;

/**
 * The ShootingEntity is a LivingEntity that is able to fire Shots.
 * It handles the generic shooting logic concerning the delay between shots,
 * the damage the fired shot will cause and some more details.
 */
public abstract class ShootingEntity extends LivingEntity {

	/**
	 * Whether the ShootingEntity is currently able to fire Shots.
	 */
	private boolean canShoot = true;
	
	/**
	 * The tick delay to wait until the next Shot can be fired.
	 * This value is pretty much constant.
	 */
	private int shootDelay;
	
	/**
	 * The current tick delay to wait until the next Shot can be fired.
	 * This value is used to enforce the actual delay defined in shootDelay.
	 */
	private int currentShootDelay;
	
	/**
	 * The current tick delay to wait until the next Rocket can be fired.
	 * This value is used to enforce the actual delay defined in shootDelay.
	 */
	private int currentRocketDelay;
	
	/**
	 * The current tick delay to wait until the next Beam can be fired.
	 * This value is used to enforce the actual delay defined in shootDelay.
	 */
	private int currentBeamDelay;
	
	/**
	 * The X delta to pass to the Shot, so it spawns at the 
	 * right position relative to the ShootingEntity.
	 */
	private int shootSpawnX;

	/**
	 * The Y delta to pass to the Shot, so it spawns at the 
	 * right position relative to the ShootingEntity.
	 */
	private int shootSpawnY;
	
	/**
	 * The direction the fired Shot will travel into.
	 * Use Shot.LEFT or Shot.RIGHT.
	 */
	private int shootDirection;
	
	/**
	 * The damage the fired Shots will cause.
	 */
	private int shootDamage;
	
	/**
	 * The speed the fired Shots will travel at.
	 */
	private int shootSpeed;
	
	/**
	 * The image to use for the primary Shots.
	 */
	private String primaryShotImage;
	
	
	/**
	 * Constructor.
	 * Initializes the currentShootDelay.
	 */
	public ShootingEntity(int x, int y) {
		super(x, y);
		this.currentShootDelay = 0;
	}

	/**
	 * Update logic making sure that the currentShootDelay is updated.
	 */
	public void update() {
		if(this.currentShootDelay > 0) this.currentShootDelay--;
		if(this.currentRocketDelay > 0) this.currentRocketDelay--;
		if(this.currentBeamDelay > 0) this.currentBeamDelay--;
	}
	
	/**
	 * Fire a Shot. This method handles all the delay stuff, so use
	 * this method in your code.
	 */
	public void shoot() {
		if(this.canShoot == true) {
			if(this.currentShootDelay == 0) {
				this.createShot();
				this.currentShootDelay = this.shootDelay;
			}
		}
	}
	
	public void shootRocket() {
		if(this.canShoot == true) {
			if(this.currentRocketDelay == 0) {
				this.createRocket();
				this.currentRocketDelay = this.shootDelay*2;
			}
		}
	}

	public void shootBeam() {
		if(this.canShoot == true) {
			if(this.currentBeamDelay == 0) {
				this.createBeam();
				this.currentBeamDelay = this.shootDelay*2;
			}
		}
	}
	/**
	 * Enable or disable the ShootingEntitys fire ability.
	 */
	public void setCanShoot(boolean canShoot) {
		this.canShoot = canShoot;
	}
	
	/**
	 * Returns true if the ShootingEntity is able to fire.
	 */
	public boolean canShoot() {
		return this.canShoot;
	}
	
	/**
	 * Configure the shoot direction.
	 * Use Shot.LEFT or Shot.RIGHT
	 */
	public void setShootDirection(int direction) {
		this.shootDirection = direction;
	}
	
	/**
	 * Set the speed the fired Shots will travel at.
	 */
	public void setShootSpeed(int speed) {
		this.shootSpeed = speed;
	}
	
	/**
	 * Set the ShootingEntites shoot delay.
	 */
	public void setShootDelay(int shootDelay) {
		this.shootDelay = shootDelay;
	}
	
	/**
	 * Use this to reset the current shoot cooldown once.
	 */
	public void resetShootDelay() {
		this.currentShootDelay = 0;
	}
	
	/**
	 * Set the delta position the Shots shall spawn at.
	 * Use this to make sure the shots come out where you want it.
	 */
	public void setShootSpawn(int x, int y) {
		this.shootSpawnX = x;
		this.shootSpawnY = y;
	}
	
	/**
	 * Get the shoot delay.
	 */
	public int getShootDelay() {
		return this.shootDelay;
	}
	
	/**
	 * Get the current shoot delay.
	 */
	public int getCurrentShootDelay() {
		return this.currentShootDelay;
	}
	
	/**
	 * Set the current shoot delay.
	 */
	public void setCurrentShootDelay(int delay) {
		this.currentShootDelay = delay;
	}
	
	/**
	 * Set the damage value the fired shots will cause.
	 */
	public void setShootDamage(int shootDamage){
		this.shootDamage = shootDamage;
	}
	
	/**
	 * Get the current damage the fired shots will cause.
	 */
	public int getShootDamage(){
		return this.shootDamage;
	}

	/**
	 * Set the image for primary shots by filename.
	 * The Loader will be used internally to fetch the image.
	 */
	public void setPrimaryShotImage(String filename){
	    this.primaryShotImage = filename;
	}

	/**
	 * Internal method to actually spawn the fired Shots.
	 */
	public void createShot() {
		new Shot(
			this.getX() + this.shootSpawnX,
			this.getY() + this.shootSpawnY,
			this.shootDirection,
			this.shootSpeed,
			this.shootDamage,
			this.primaryShotImage
		);
	}
	
	public void createShot(int x_offset, int y_offset) {
		new Shot(
			this.getX() + x_offset,
			this.getY() + y_offset,
			this.shootDirection,
			this.shootSpeed,
			this.shootDamage,
			this.primaryShotImage
		);
	}
	
	/**
	 * Internal method to actually spawn a fired rocket.
	 */
	public void createRocket() {
		new Rocket(
			this.getX() + this.shootSpawnX,
			this.getY() + this.shootSpawnY,
			this.shootDirection,
			this.shootSpeed,
			(int) (this.shootDamage*5),
			this. primaryShotImage
		);
	}

	/**
	 * Internal method to actually spawn a fired beam.
	 */
	public void createBeam() {
		new Beam(
			this.getX() + this.shootSpawnX - 7,
			this.getY() + this.shootSpawnY - 3,
			this.shootDirection,
			this.shootSpeed,
			this.shootDamage,
			this.primaryShotImage
		);
	}
		
	/**
	 * Custom Shot for special purposes.
	 */
	public void createCustomShot(int x_offset, int y_offset, int speed, int dmg, String filename) {
		new Shot(
			this.getX() + x_offset,
			this.getY() + y_offset,
			this.shootDirection,
			speed,
			dmg,
			filename
		);
	}

}