opsu-dance/src/itdelatrisu/opsu/GameMod.java

/*
 * opsu! - an open-source osu! client
 * Copyright (C) 2014 Jeffrey Han
 *
 * opsu! is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * opsu! 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with opsu!.  If not, see <http://www.gnu.org/licenses/>.
 */

package itdelatrisu.opsu;

import java.util.Arrays;
import java.util.Collections;

import org.newdawn.slick.Image;
import org.newdawn.slick.SlickException;
import org.newdawn.slick.util.Log;

/**
 * Game mods.
 */
public enum GameMod {
	EASY          (0, "selection-mod-easy.png"),
	NO_FAIL       (1, "selection-mod-nofail.png"),
	HARD_ROCK     (2, "selection-mod-hardrock.png"),
	SUDDEN_DEATH  (3, "selection-mod-suddendeath.png"),
	SPUN_OUT      (4, "selection-mod-spunout.png"),
	AUTO          (5, "selection-mod-autoplay.png");

	/**
	 * The ID of the mod (used for positioning).
	 */
	private int id;

	/**
	 * The file name of the mod image.
	 */
	private String filename;

	/**
	 * Whether or not this mod is active.
	 */
	private boolean active = false;

	/**
	 * The button containing the mod image (displayed in Options screen).
	 */
	private GUIMenuButton button;

	/**
	 * Total number of mods.
	 */
	private static final int size = GameMod.values().length;

	/**
	 * Returns the total number of game mods.
	 * @return the number of mods
	 */
	public static int size() { return size; }

	/**
	 * Returns an array of GameMod objects in reverse order.
	 * @return all game mods in reverse order
	 */
	public static GameMod[] valuesReversed() {
		GameMod[] mods = GameMod.values();
		Collections.reverse(Arrays.asList(mods));
		return mods;
	}

	/**
	 * Constructor.
	 * @param id the ID of the mod (for positioning).
	 * @param filename the image file name
	 */
	GameMod(int id, String filename) {
		this.id = id;
		this.filename = filename;
	}

	/**
	 * Initializes the game mod.
	 * @param width the container width
	 * @param height the container height
	 */
	public void init(int width, int height) {
		try {
			// create and scale image
			Image img = new Image(filename);
			float scale = (height * 0.12f) / img.getHeight();
			img = img.getScaledCopy(scale);
	
			// find coordinates
			float offsetX = img.getWidth() * 1.5f;
			float x = (width / 2f) - (offsetX * size / 2.75f);
			float y = (height * 0.8f) + (img.getHeight() / 2);

			// create button
			img.setAlpha(0.5f);
			this.button = new GUIMenuButton(img, x + (offsetX * id), y);
		} catch (SlickException e) {
			Log.error(String.format("Failed to initialize game mod '%s'.", this), e);
		}
	}

	/**
	 * Toggles the active status of the mod.
	 * @param checkInverse if true, perform checks for mutual exclusivity
	 */
	public void toggle(boolean checkInverse) {
		button.getImage().setAlpha(active ? 0.5f : 1.0f);
		active = !active;

		if (checkInverse) {
			if (AUTO.isActive()) {
				if (this == AUTO) {
					if (SPUN_OUT.isActive())
						SPUN_OUT.toggle(false);
					if (SUDDEN_DEATH.isActive())
						SUDDEN_DEATH.toggle(false);
				} else if (this == SPUN_OUT || this == SUDDEN_DEATH) {
					if (active)
						toggle(false);
				}
			}
			if (SUDDEN_DEATH.isActive() && NO_FAIL.isActive()) {
				if (this == SUDDEN_DEATH)
					NO_FAIL.toggle(false);
				else
					SUDDEN_DEATH.toggle(false);
			}
			if (EASY.isActive() && HARD_ROCK.isActive()) {
				if (this == EASY)
					HARD_ROCK.toggle(false);
				else
					EASY.toggle(false);
			}
		}
	}

	/**
	 * Returns whether or not the mod is active.
	 * @return true if active
	 */
	public boolean isActive() { return active; }

	/**
	 * Returns the image associated with the mod.
	 * @return the associated image
	 */
	public Image getImage() { return button.getImage(); }

	/**
	 * Returns the mod ID.
	 * @return the mod ID
	 */
	public int getID() { return id; }

	/**
	 * Draws the game mod.
	 */
	public void draw() { button.draw(); }

	/**
	 * Checks if the coordinates are within the image bounds.
	 * @param x the x coordinate
	 * @param y the y coordinate
	 * @return true if within bounds
	 */
	public boolean contains(float x, float y) { return button.contains(x, y); }
}