/*
 * 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 org.illarion.engine.graphic.Sprite;

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

/**
 * This is the template that contains the required data to create the graphical representation of a effect on the map.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
@Immutable
@ThreadSafe
public class EffectTemplate extends AbstractAnimatedEntityTemplate {
    /**
     * The encoded light value of this effect.
     */
    private final int light;

    /**
     * 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 speed the animation speed
     */
    public EffectTemplate(
            int id, @Nonnull Sprite sprite, int frames, int speed, int light) {
        super(id, sprite, frames, 0, speed, null, 0);

        this.light = light;
    }

    public int getLight() {
        return light;
    }
}