/*
 * 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 illarion.common.types.ServerCoordinate;

import javax.annotation.Nonnull;

/**
 * This is the GUI controller that manages the GUI elements that are directly related to the elements on the GUI.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
public interface GameMapGui {
    /**
     * Show a item tooltip in the GUI.
     *
     * @param location the location of the item on the map
     * @param stackPosition the position of the referenced item on the stack
     * @param tooltip the tooltip of the item that is supposed to be displayed
     */
    void showItemTooltip(@Nonnull ServerCoordinate location, int stackPosition, @Nonnull Tooltip tooltip);

    /**
     * Toggle the pulsing animation of the run button.
     */
    void toggleRunMode();
}