001/*
002 * This file is part of Baritone.
003 *
004 * Baritone is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU Lesser General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * Baritone is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public License
015 * along with Baritone.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package baritone.api.event.events;
019
020import net.minecraft.util.math.BlockPos;
021
022/**
023 * Called when the local player interacts with a block, can be either {@link Type#START_BREAK} or {@link Type#USE}.
024 *
025 * @author Brady
026 * @since 8/22/2018
027 */
028public final class BlockInteractEvent {
029
030    /**
031     * The position of the block interacted with
032     */
033    private final BlockPos pos;
034
035    /**
036     * The type of interaction that occurred
037     */
038    private final Type type;
039
040    public BlockInteractEvent(BlockPos pos, Type type) {
041        this.pos = pos;
042        this.type = type;
043    }
044
045    /**
046     * @return The position of the block interacted with
047     */
048    public final BlockPos getPos() {
049        return this.pos;
050    }
051
052    /**
053     * @return The type of interaction with the target block
054     */
055    public final Type getType() {
056        return this.type;
057    }
058
059    public enum Type {
060
061        /**
062         * We're starting to break the target block.
063         */
064        START_BREAK,
065
066        /**
067         * We're right clicking on the target block. Either placing or interacting with.
068         */
069        USE
070    }
071}