package thetadev.constructionwand.api;

import net.minecraft.core.BlockPos;
import net.minecraft.world.item.BlockItem;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.phys.BlockHitResult;
import thetadev.constructionwand.wand.undo.PlaceSnapshot;

import javax.annotation.Nullable;

public interface IWandSupplier
{
    void getSupply(@Nullable BlockItem target);

    /**
     * Tries to create a new PlaceSnapshot at the specified position.
     * Returns null if there aren't any blocks available that can be placed
     * in that position.
     */
    @Nullable
    PlaceSnapshot getPlaceSnapshot(Level world, BlockPos pos, BlockHitResult rayTraceResult,
                                   @Nullable BlockState supportingBlock);

    /**
     * Consumes an item stack if the placement was successful
     */
    int takeItemStack(ItemStack stack);
}