AdventureGame.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;

import es.eucm.ead.model.elements.events.Event;
import es.eucm.ead.model.elements.extra.EAdList;
import es.eucm.ead.model.interfaces.Element;
import es.eucm.ead.model.interfaces.Param;
import es.eucm.ead.model.interfaces.features.Evented;
import es.eucm.ead.model.interfaces.features.Identified;

/**
 * The eAdventure game model.
 */
@Element
public class AdventureGame extends BasicElement implements Evented {

	public static final String EFFECTS_BINDS = "#effects_binds";
	public static final String EVENTS_BINDS = "#events_binds";
	public static final String SCENES_ELEMENT_BINDS = "#scene_element_binds";
	public static final String GAME_WIDTH = "#game_width";
	public static final String GAME_HEIGHT = "#game_height";
	public static final String GAME_TITLE = "#game_title";
	/**
	 * Not serialize (special treatment in writer)
	 */
	private EAdList<Chapter> chapters;

	/**
	 * Not serialize (special treatment in writer)
	 */
	private Chapter initialChapter;

	@Param
	/**
	 * This events are launched after the game loads
	 */
	private EAdList<Event> events;

	@Param
	/**
	 * List with all the identified used in the game across chapters
	 */
	private EAdList<Identified> identified;

	/**
	 * Constructs a {@link AdventureGame}.
	 */
	public AdventureGame() {
		chapters = new EAdList<Chapter>();
		events = new EAdList<Event>();
		identified = new EAdList<Identified>();
	}

	/**
	 * Returns the chapters of the adventures.
	 *
	 * @return the chapters in the adventure
	 */
	public EAdList<Chapter> getChapters() {
		return chapters;
	}

	public void setChapters(EAdList<Chapter> chapters) {
		this.chapters = chapters;
	}

	/**
	 * Adds a chapter to the adventure
	 * @param chapter
	 */
	public void addChapter(Chapter chapter) {
		if (initialChapter == null) {
			this.initialChapter = chapter;
		}
		this.chapters.add(chapter);

	}

	@Override
	public EAdList<Event> getEvents() {
		return events;
	}

	@Override
	public void addEvent(Event e) {
		if (events == null) {
			events = new EAdList<Event>();
		}
		events.add(e);
	}

	/**
	 *
	 * @return the initial chapter of the game
	 */
	public Chapter getInitialChapter() {
		return initialChapter;
	}

	/**
	 * Sets the inital chapter for the adventure
	 * @param initialChapter
	 */
	public void setInitialChapter(Chapter initialChapter) {
		this.initialChapter = initialChapter;
	}

	public void addIdentified(Identified i) {
		this.identified.add(i);
	}

	public EAdList<Identified> getIdentified() {
		return identified;
	}

	public void setIdentified(EAdList<Identified> identified) {
		this.identified = identified;
	}

	public void setEvents(EAdList<Event> events) {
		this.events = events;
	}

}