/*
 * This file is part of Araknemu.
 *
 * Araknemu is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Araknemu 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Araknemu.  If not, see <https://www.gnu.org/licenses/>.
 *
 * Copyright (c) 2017-2020 Vincent Quatrevieux
 */

package fr.quatrevieux.araknemu.game.spell.effect.area;

import fr.arakne.utils.maps.MapCell;
import fr.quatrevieux.araknemu.data.value.EffectArea;
import org.checkerframework.checker.index.qual.NonNegative;

import java.util.List;

/**
 * Resolve cells from area and target cell
 */
public interface SpellEffectArea {
    /**
     * Resolve the cells from an effect area
     *
     * Cells must be sorted by distance from the target cell, nearest cells first,
     * and then sorted by direction, clockwise from the north-east
     *
     * @param target The target cell
     * @param source The source cell (caster cell)
     */
    public <C extends MapCell> List<C> resolve(C target, C source);

    /**
     * The area type
     */
    public EffectArea.Type type();

    /**
     * The area size
     */
    public @NonNegative int size();
}