Alarm.java

package it.marteEngine.entity;

import it.marteEngine.ME;

public class Alarm {
	/**
	 * we want some alarms to ignore the trigger time. They can only be
	 * triggered by Entity.triggerAlarm()
	 */
	public static final int FOREVER = -666;

	/** the name of this alarm */
	private String name;
	/** is this alarm active or not */
	private boolean active = false;
	/** the time in update calls or milliseconds to trigger */
	private int triggerTime;
	/** the current update call counter or delta time counter for this alarm */
	private int counter = 0;
	/** is this a one time alarm or an endless looping one */
	private boolean oneShotAlaram = true;
	/** marked as dead, don't want to remove alarms while iterating them! */
	private boolean dead = false;
	/** this alarm is only triggered by calling trigger() */
	private boolean triggeredExternal = false;

	/**
	 * create a new Alarm object
	 * 
	 * @param name
	 *            the name of this alarm
	 * @param triggerTime
	 *            after how many update calls should this alarm trigger
	 * @param oneShot
	 *            shall this alarm remove itself after one trigger or shall it
	 *            run for ever
	 */
	public Alarm(String name, int triggerTime, boolean oneShot) {
		this(name, triggerTime, oneShot, false);
	}

	/**
	 * create a new Alarm object
	 * 
	 * @param name
	 *            the name of this alarm
	 * @param triggerTime
	 *            after how many update calls should this alarm trigger
	 * @param oneShot
	 *            shall this alarm remove itself after one trigger or shall it
	 *            run for ever
	 * @param useDelta
	 *            do we count update calls or delta time in milliseconds?
	 */
	public Alarm(String name, int triggerTime, boolean oneShot, boolean useDelta) {
		this.name = name;
		this.triggerTime = triggerTime;
		this.counter = 0;
		this.oneShotAlaram = oneShot;
		this.active = false;
	}

	public void start() {
		if (this.triggerTime != FOREVER) {
			if (this.counter >= this.triggerTime)
				this.counter -= this.triggerTime;
			else
				this.counter = 0;
		}
		this.triggeredExternal = false;
		this.active = true;
	}

	public void pause() {
		this.active = false;
	}

	public void resume() {
		this.active = true;
	}

	public boolean isActive() {
		return active;
	}

	public void trigger() {
		this.triggeredExternal = true;
	}

	/**
	 * called by World if alarm is active. Don't mess around with it.
	 */
	public boolean update(int delta) {
		if (this.triggeredExternal)
			return true;
		if (this.triggerTime != FOREVER) {
			if (ME.useDeltaTiming)
				this.counter += delta;
			else
				this.counter++;
			if (this.counter >= this.triggerTime)
				return true;
		}
		return false;
	}

	public String getName() {
		return name;
	}

	public int getTriggerTime() {
		return triggerTime;
	}

	public int getCounter() {
		return counter;
	}

	public boolean isOneShotAlaram() {
		return oneShotAlaram;
	}

	public void setActive(boolean active) {
		this.active = active;
	}

	public void setCounter(int counter) {
		this.counter = counter;
	}

	public boolean isDead() {
		return dead;
	}

	public void setDead(boolean dead) {
		this.dead = dead;
	}

}