package de.geolykt.starloader.api.empire;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.ApiStatus.ScheduledForRemoval;

import com.badlogic.gdx.graphics.Color;

import de.geolykt.starloader.DeprecatedSince;
import de.geolykt.starloader.api.Galimulator;
import de.geolykt.starloader.api.Identifiable;

/**
 * Base interface for any empires that exist in the game, whether collapsed or
 * not.
 *
 * @deprecated Scheduled for removal. There is no replacement at this point in time.
 * Cause for this action is the fact that this {@link Empire} interface and the
 * {@link ActiveEmpire} interface may be easily confused for beginners. In the future,
 * only {@link de.geolykt.starloader.api.dimension.Empire} will exist, which represent
 * "alive" - that is non-collapsed - empires. Former empires will be represented under
 * an alternative name going forward. This action is ultimately rooted in the fact that
 * both {@link Empire} and {@link ActiveEmpire} were written before a lot of knowledge
 * about galimulator's internals was known. Combined with the fact that before galimulator
 * 4.8 many classes were obfuscated, this unfortunate naming blunder was created
 * due to erroneous application of OOP principles where it shouldn't have been applied.
 */
@Deprecated
@ScheduledForRemoval(inVersion = "3.0.0")
@DeprecatedSince(value = "2.0.0")
public interface Empire extends Dateable, Identifiable {

    /**
     * The age of an empire is counted in years and ceases to stop increasing once
     * the empire has collapsed.
     *
     * @return The age of the empire
     */
    @Override
    public default int getAge() {
        return (hasCollapsed() ? getCollapseYear() : Galimulator.getGameYear()) - getFoundationYear();
    }

    /**
     * The empire color is used for multiple interfaces as well as to paint the
     * territory of an empire to a constant color, the color as such should not
     * change without reason to not confuse the user.
     *
     * @return The GDX {@link Color} assigned to the empire
     */
    @NotNull
    public Color getGDXColor();

    /**
     * The year the empire collapsed, or -1 if the empire did not collapse.
     *
     * @return the year of collapse
     */
    public int getCollapseYear();

    /**
     * The name of the empire without any colors.
     *
     * @return A String that contains the empire's name
     */
    public @NotNull String getEmpireName();

    /**
     * Obtains the total star count of the empire. Should never be negative. For
     * collapsed empires this should return 0.
     *
     * @return The current total star count
     */
    public int getStarCount();

    /**
     * Empires are usually not in the collapse state, however sometimes this is
     * true, albeit rare.
     *
     * @return true if the empire ceased to exist
     */
    public boolean hasCollapsed();
}