/*
 * This file is part of LanternServer, licensed under the MIT License (MIT).
 *
 * Copyright (c) LanternPowered <https://www.lanternpowered.org>
 * Copyright (c) SpongePowered <https://www.spongepowered.org>
 * Copyright (c) contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the Software), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.lanternpowered.server.block.action;

import org.spongepowered.api.entity.living.player.Player;
import org.spongepowered.api.world.Chunk;

public interface BlockAction {

    /**
     * Fills the {@link BlockActionData} with values that are
     * needed to trigger this action.
     *
     * @param actionData The action data
     */
    void fill(BlockActionData actionData);

    /**
     * Gets the {@link Type}.
     *
     * @return The type
     */
    Type type();

    enum Type {
        /**
         * The event will be present until a new {@link BlockAction}
         * is triggered for the block.
         * <p>The event will only be resend when a {@link Player} starts
         * tracking a {@link Chunk}.</p>
         */
        CONTINUOUS,
        /**
         * The event will be triggered once.
         */
        SINGLE,
    }
}