package org.bukkit;

import com.google.common.collect.Maps;
import org.bukkit.entity.HumanEntity;

import java.util.Map;

/**
 * Represents the various type of game modes that {@link HumanEntity}s may
 * have
 */
public enum GameMode
{
	// Cauldron start - FakePlayers do not set their gametype and use the default
	/**
	 * Default mode
	 */
	NOT_SET(-1),
	// Cauldron end
	/**
	 * Creative mode may fly, build instantly, become invulnerable and create
	 * free items.
	 */
	CREATIVE(1),

	/**
	 * Survival mode is the "normal" gameplay type, with no special features.
	 */
	SURVIVAL(0),

	/**
	 * Adventure mode cannot break blocks, use chat, use buckets, etc.
	 */
	ADVENTURE(2);

	private final int value;
	private final static Map<Integer, GameMode> BY_ID = Maps.newHashMap();

	private GameMode(final int value)
	{
		this.value = value;
	}

	/**
	 * Gets the mode value associated with this GameMode
	 *
	 * @return An integer value of this gamemode
	 * @deprecated Magic value
	 */
	@Deprecated
	public int getValue()
	{
		return value;
	}

	/**
	 * Gets the GameMode represented by the specified value
	 *
	 * @param value Value to check
	 * @return Associative {@link GameMode} with the given value, or null if
	 * it doesn't exist
	 * @deprecated Magic value
	 */
	@Deprecated
	public static GameMode getByValue(final int value)
	{
		return BY_ID.get(value);
	}

	static
	{
		for(GameMode mode : values())
		{
			BY_ID.put(mode.getValue(), mode);
		}
	}
}