org.spongepowered.api.item.inventory.Slot Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation

A plugin API for Minecraft: Java Edition

The newest version!

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

import org.spongepowered.api.item.inventory.transaction.InventoryTransactionResult;

/**
 * A slot is an {@link Inventory} with only a single stack.
 */
public interface Slot extends Inventory {

    /**
     * Returns the slot in a {@link Container}s viewed inventory or itself.
     *
     * @return the viewed inventory slot or itself if not a container slot
     */
    Slot viewedSlot();

    /**
     * Adds the ItemStack to this slot overwriting the existing item.
     *
     * Stacks bigger than the max stack size will be partially rejected.
     *
     * @param stack The stack to add to this slot.
     *
     * @return A SUCCESS transaction-result if the entire stack was added and
     *           FAILURE when the stack was not or only partially added to the inventory.
     */
    InventoryTransactionResult set(ItemStack stack);
}