InteractItemEvent

InteractItemEvent.java

/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * 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.spongepowered.api.event.item.inventory;

import org.spongepowered.api.block.BlockTypes;
import org.spongepowered.api.data.type.HandType;
import org.spongepowered.api.event.action.InteractEvent;
import org.spongepowered.api.event.block.InteractBlockEvent;
import org.spongepowered.api.event.block.InteractBlockEvent.Primary;
import org.spongepowered.api.item.inventory.ItemStackSnapshot;

/**
 * Base event for all interactions with an @{link ItemStack} in hand.
 * 
 * <p>Note: Canceling this event will halt any future actions from
 * occuring.</p>
 */
public interface InteractItemEvent extends InteractEvent {

    /**
     * Gets the {@link ItemStackSnapshot} being interacted with.
     *
     * @return The item being interacted with
     */
    ItemStackSnapshot getItemStack();

    interface Primary extends InteractItemEvent { 

        /**
         * Gets the {@link HandType} used for interaction.
         *
         * @return The hand type
         */
        HandType getHandType();

        /**
         * A {@link Primary} event where the interaction is from the client's main hand.
         */
        interface MainHand extends Primary {}

        /**
         * A {@link Primary} event where the interaction is from the client's off hand.
         */
        interface OffHand extends Primary {}
    }

    interface Secondary extends InteractItemEvent {

        /**
         * Gets the {@link HandType} used for interaction.
         *
         * @return The hand type
         */
        HandType getHandType();

        /**
         * A {@link Secondary} event where the interaction is from the client's main hand.
         */
        interface MainHand extends Secondary {}

        /**
         * A {@link Secondary} event where the interaction is from the client's off hand.
         */
        interface OffHand extends Secondary {}
    }
}