Arakne / Araknemu

 * 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.exploration.map.cell;

import fr.arakne.utils.maps.MapCell;

import fr.quatrevieux.araknemu.game.exploration.creature.ExplorationCreature;

import fr.quatrevieux.araknemu.game.exploration.creature.Operation;

import fr.quatrevieux.araknemu.game.exploration.map.ExplorationMap;

import org.checkerframework.checker.index.qual.NonNegative;

import org.checkerframework.checker.nullness.qual.Nullable;

/**

 * Cell of exploration map

 */

public interface ExplorationMapCell extends MapCell<ExplorationMapCell> {

    @Override

    public @NonNegative int id();

    @Override

    public ExplorationMap map();

    /**

     * Does the cell is free ?

     * A cell is free if a new sprite can be added on, and no other objects is present

     */

    /**

     * Apply an operation to all creatures on current cell

     * If the operation return false, the iteration will be stopped

     *

     * @see ExplorationCreature#apply(Operation)

     */

    public default void apply(Operation<@Nullable Boolean> operation)  {

        // Optimisation : the cell is not walkable, no creatures can be located here

        if (!walkable()) {

            return;

        }

        for (ExplorationCreature creature : map().creatures()) {

            if (equals(creature.cell())) {

                final Boolean result = creature.apply(operation);

                if (result != null && !result) {

                    break;

                }

            }

        }

    }

}