/*
 * 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.fight.castable.effect.buff;

import fr.quatrevieux.araknemu.game.fight.fighter.FighterData;

/**
 * Handle and store buff list for a fighter
 */
public interface Buffs<B extends Buff> extends Iterable<B> {
    /**
     * Add and start a buff
     */
    public void add(B buff);

    /**
     * Refresh the buff list after turn end
     */
    public void refresh();

    /**
     * Remove all buffs than can be removed, and fire {@link BuffHook#onBuffTerminated(FightBuff)}
     *
     * @return true if there is at least one removed buff
     */
    public boolean removeAll();

    /**
     * Remove all buffs casted by the given fighter
     *
     * @return true if there is at least one removed buff
     */
    public boolean removeByCaster(FighterData caster);
}