/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2015 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion 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.
 */
package illarion.client.gui;

import de.lessvoid.nifty.screen.ScreenController;
import org.illarion.engine.GameContainer;
import org.jetbrains.annotations.Contract;

import javax.annotation.Nonnull;

/**
 * This interface is the global accessor to the GUI of the game.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
@SuppressWarnings("InterfaceNamingConvention")
public interface GameGui {
    /**
     * Get the book GUI control.
     *
     * @return the controller of the book display
     */
    @Nonnull
    @Contract(pure = true)
    BookGui getBookGui();

    /**
     * Get the GUI that controls the display of the chat window and the display of the chat on the screen.
     *
     * @return the chat GUI controller
     */
    @Nonnull
    @Contract(pure = true)
    ChatGui getChatGui();

    /**
     * Get the GUI that controls the display of item containers in the game.
     *
     * @return the item container gui controller
     */
    @Nonnull
    @Contract(pure = true)
    ContainerGui getContainerGui();

    /**
     * Get the GUI controller that is used to display the dialogs.
     *
     * @return the dialog GUI control
     */
    @Nonnull
    @Contract(pure = true)
    DialogGui getDialogGui();

    /**
     * Get the GUI controller that is used to display the crafting dialogs.
     *
     * @return the crafting dialog GUI control
     */
    @Nonnull
    @Contract(pure = true)
    DialogCraftingGui getDialogCraftingGui();

    /**
     * Get the GUI controller that is used to display the merchant dialogs.
     *
     * @return the crafting dialog GUI control
     */
    @Nonnull
    @Contract(pure = true)
    DialogMerchantGui getDialogMerchantGui();

    /**
     * Get the GUI controller that is used to display the input dialogs.
     *
     * @return the input dialog GUI control
     */
    @Nonnull
    @Contract(pure = true)
    DialogInputGui getDialogInputGui();

    /**
     * Get the GUI controller that is used to display message dialogs.
     *
     * @return the message dialog GUI control
     */
    @Nonnull
    @Contract(pure = true)
    DialogMessageGui getDialogMessageGui();

    /**
     * Get the GUI controller that is used to display selection dialogs.
     *
     * @return the selection dialog GUI control
     */
    @Nonnull
    @Contract(pure = true)
    DialogSelectionGui getDialogSelectionGui();

    /**
     * Get the controller that displays the elements that are directly related to the game game.
     *
     * @return the game map gui controller
     */
    @Nonnull
    @Contract(pure = true)
    GameMapGui getGameMapGui();

    /**
     * Get the GUI that controls the display of the inform messages.
     *
     * @return the inform GUI controller
     */
    @Nonnull
    @Contract(pure = true)
    InformGui getInformGui();

    /**
     * Get the GUI that controls the display of the inventory.
     *
     * @return the inventory gui controller
     */
    @Nonnull
    @Contract(pure = true)
    InventoryGui getInventoryGui();

    /**
     * Get the GUI that shows the status of the player. So the hit points, food points and mana points.
     *
     * @return the player character GUI controller
     */
    @Nonnull
    @Contract(pure = true)
    PlayerStatusGui getPlayerStatusGui();

    /**
     * Get the GUI that control the display of the quests in the GUI.
     *
     * @return the quest GUI controller
     */
    @Nonnull
    @Contract(pure = true)
    QuestGui getQuestGui();

    /**
     * Get the GUI that control the display of the documentation in the GUI.
     *
     * @return the documentation GUI controller
     */
    @Nonnull
    @Contract(pure = true)
    DocumentationGui getDocumentationGui();

    /**
     * Get the main screen controller of the GUI.
     *
     * @return the GUI screen controller
     */
    @Nonnull
    @Contract(pure = true)
    ScreenController getScreenController();

    /**
     * Get the GUI that controls the skill display in the GUI.
     *
     * @return the skill GUI controller
     */
    @Nonnull
    @Contract(pure = true)
    SkillGui getSkillGui();

    /**
     * Get the GUI that controls the mini map display.
     *
     * @return the mini map display control
     */
    @Nonnull
    @Contract(pure = true)
    MiniMapGui getMiniMapGui();

    @Nonnull
    @Contract(pure = true)
    CloseGameGui getCloseGameGui();

    /**
     * Check if the GUI is ready to work.
     *
     * @return {@code true} in case the GUI is ready
     */
    @Contract(pure = true)
    boolean isReady();

    /**
     * Update the GUI. This should be called once during the update cycle.
     *
     * @param container the container of the game
     * @param delta the time since the last update in milliseconds
     */
    void onUpdateGame(@Nonnull GameContainer container, int delta);
}