/*
 * 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.resources.data;

import illarion.client.graphics.AbstractEntity;
import org.illarion.engine.graphic.Color;
import org.illarion.engine.graphic.Sprite;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.ThreadSafe;

/**
 * This template in general stores the data required to create any class that inherits
 * {@link AbstractEntity} and has additional support for multiple frames.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
@Immutable
@ThreadSafe
public class AbstractMultiFrameEntityTemplate extends AbstractEntityTemplate {
    /**
     * The frame displayed by this entity in case no animation is going on.
     */
    private final int stillFrame;

    /**
     * The total amount of frames.
     */
    private final int frames;

    /**
     * The constructor of this class.
     *
     * @param id the identification number of the entity
     * @param sprite the sprite used to render the entity
     * @param frames the total amount of frames
     * @param stillFrame the frame displayed in case no frame animation is running
     * @param defaultColor the default color of the entity
     * @param shadowOffset the offset of the shadow
     */
    protected AbstractMultiFrameEntityTemplate(
            int id,
            @Nonnull Sprite sprite,
            int frames,
            int stillFrame,
            @Nullable Color defaultColor,
            int shadowOffset) {
        super(id, sprite, defaultColor, shadowOffset);
        this.frames = frames;
        this.stillFrame = stillFrame;
    }

    public int getFrames() {
        return frames;
    }

    public int getStillFrame() {
        return stillFrame;
    }
}