PlaySoundEf.java

/**
 * eAdventure (formerly <e-Adventure> and <e-Game>) is a research project of the
 *    <e-UCM> research group.
 *
 *    Copyright 2005-2010 <e-UCM> research group.
 *
 *    You can access a list of all the contributors to eAdventure at:
 *          http://e-adventure.e-ucm.es/contributors
 *
 *    <e-UCM> is a research group of the Department of Software Engineering
 *          and Artificial Intelligence at the Complutense University of Madrid
 *          (School of Computer Science).
 *
 *          C Profesor Jose Garcia Santesmases sn,
 *          28040 Madrid (Madrid), Spain.
 *
 *          For more info please visit:  <http://e-adventure.e-ucm.es> or
 *          <http://www.e-ucm.es>
 *
 * ****************************************************************************
 *
 *  This file is part of eAdventure, version 2.0
 *
 *      eAdventure is free software: you can redistribute it and/or modify
 *      it under the terms of the GNU Lesser General Public License as published by
 *      the Free Software Foundation, either version 3 of the License, or
 *      (at your option) any later version.
 *
 *      eAdventure is distributed in the hope that it will be useful,
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *      GNU Lesser General Public License for more details.
 *
 *      You should have received a copy of the GNU Lesser General Public License
 *      along with eAdventure.  If not, see <http://www.gnu.org/licenses/>.
 */

package es.eucm.ead.model.elements.effects;

import es.eucm.ead.model.interfaces.Element;
import es.eucm.ead.model.interfaces.Param;
import es.eucm.ead.model.assets.multimedia.EAdSound;

/**
 * An effect that plays a sound
 * 
 * 
 */
@Element
public class PlaySoundEf extends Effect {

	@Param
	private es.eucm.ead.model.assets.multimedia.EAdSound sound;

	@Param
	private boolean overlay;

	@Param
	private float volume;

	public PlaySoundEf() {
		this(null);
	}

	public PlaySoundEf(EAdSound sound) {
		this(sound, 1.0f);
	}

	public PlaySoundEf(EAdSound sound, float volume) {
		this.sound = sound;
		this.volume = volume;
	}

	public void setSound(EAdSound sound) {
		this.sound = sound;
	}

	/**
	 * Returns the sound to be played
	 * 
	 * @return
	 */
	public EAdSound getSound() {
		return sound;
	}

	public boolean isOverlay() {
		return overlay;
	}

	public void setOverlay(boolean overlay) {
		this.overlay = overlay;
	}

	public float getVolume() {
		return volume;
	}

	/**
	 * Sets the volume for the sound, being 1.0f the maximum volume and 0.0f the
	 * minimum
	 * 
	 * @param volume
	 */
	public void setVolume(float volume) {
		this.volume = volume;
	}

}