InGameHUD.java

/*
 * This file is part of SpoutcraftPlugin.
 *
 * Copyright (c) 2011 SpoutcraftDev <http://spoutcraft.org//>
 * SpoutcraftPlugin is licensed under the GNU Lesser General Public License.
 *
 * SpoutcraftPlugin 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.
 *
 * SpoutcraftPlugin 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.getspout.spoutapi.gui;

/**
 * This is the main screen when playing Minecraft.
 * <p/>
 * There is no mouse interaction with this screen, so trying to place Controls
 * such as Buttons on it will fail.
 */
public interface InGameHUD extends Screen {
	/**
	 * Gets the armor bar associated with this HUD
	 * @return armor bar
	 */
	public ArmorBar getArmorBar();

	/**
	 * Gets the chat text box associated with this HUD
	 * @return chat text box
	 */
	public ChatTextBox getChatTextBox();

	/**
	 * Gets the chat text bar associated with this HUD
	 * @return chat bar
	 */
	public ChatBar getChatBar();

	/**
	 * Gets the underwater bubble bar associated with this HUD
	 * @return bubble bar
	 */
	public BubbleBar getBubbleBar();

	/**
	 * Gets the health bar associated with this HUD
	 * @return health bar
	 */
	public HealthBar getHealthBar();

	/**
	 * Gets the hunger bar associated with this HUD
	 * @return hunger bar
	 */
	public HungerBar getHungerBar();

	/**
	 * Gets the exp bar associated with this HUD
	 * @return exp bar
	 */
	public ExpBar getExpBar();

	/**
	 * Is true if the widget can be attached to the screen.
	 * Primary controls, like the health bar can not be attached twice.
	 * Control widgets that require input from the mouse or keyboard can not be attached
	 * @param widget
	 * @return true if the widge can be attached
	 */
	public boolean canAttachWidget(Widget widget);

	/**
	 * Attachs a popup screen and brings it to the front of the screen
	 * @param screen to pop up
	 * @return true if the popup screen was attached, false if there was already a popup launched
	 */
	public boolean attachPopupScreen(PopupScreen screen);

	/**
	 * Gets the active popup screen for this player, or null if none available
	 * @return the active popup
	 */
	public PopupScreen getActivePopup();

	/**
	 * Closes the popup screen, or returns false on failure
	 * @return true if a popup screen was closed
	 */
	public boolean closePopup();

	/**
	 * Ease of use method setting all the survival mode HUD elements to setVisible(toggle);
	 * @param toggle true or false
	 */
	public void toggleSurvivalHUD(boolean toggle);
}