org.spongepowered.api.item.inventory.Container 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.entity.living.player.server.ServerPlayer;
import org.spongepowered.api.item.inventory.menu.InventoryMenu;

import java.util.List;
import java.util.Optional;

/**
 * A Container is effectively a ViewModel for a particular set of
 * {@link Inventory} objects used to allow players to interact
 * with the Inventories, usually via a GUI (the View).
 */
public interface Container extends Inventory {

    /**
     * Returns whether given slot is part of the viewed inventories
     * but not part of the viewers own inventory.
     *
     * Examples for viewed inventory slots:
     * All the slots of the opened chest and not the player grid below.
     * The slots of the crafting grid in the opened player inventory.
     *
     * @param slot The slot to check.
     * @return {@code true} when the slot is part of the viewed inventories.
     */
    boolean isViewedSlot(Slot slot);

    /**
     * Returns the list of viewed inventories.
     * This is usually at least the inventory a player opened and the players inventory.
     * It is not necessary, that all slots of the viewed inventories are visible or interactable with.
     *
     * @return the list of viewed inventories.
     */
    List viewed();

    /**
     * Sets the viewing players cursor item.
     * Returns false when the container is no longer open.
     *
     * @param item The item to set.
     *
     * @return true if the cursor was set.
     */
    boolean setCursor(ItemStack item);

    /**
     * Gets the viewing players cursor item.
     * Returns {@link Optional#empty()} when the container was closed.
     *
     * @return The players cursor item.
     */
    Optional cursor();

    /**
     * Gets the viewing {@link ServerPlayer player}.
     *
     * @return The viewing player
     */
    ServerPlayer viewer();

    /**
     * Returns whether this Container is open.
     *
     * @return Whether this Container is open.
     */
    boolean isOpen();

    /**
     * Returns the {@link ContainerType} of this container.
     *
     * @return the ContainerType of this container.
     */
    ContainerType type();

    /**
     * Returns the {@link InventoryMenu} if this container has been opened by one.
     *
     * @return the current InventoryMenu if present
     */
    Optional currentMenu();

}