de.placeblock.betterinventories.gui.impl.CanvasGUI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of BetterInventories Show documentation
Easy to use and extensive InventoryAPI for Spigot
There is a newer version: 2.2.0
package de.placeblock.betterinventories.gui.impl;

import de.placeblock.betterinventories.content.pane.impl.simple.SimpleGUIPane;
import de.placeblock.betterinventories.util.InventoryTypeMapper;
import de.placeblock.betterinventories.util.Vector2d;
import net.kyori.adventure.text.TextComponent;
import org.bukkit.event.inventory.InventoryType;
import org.bukkit.plugin.Plugin;
import org.bukkit.plugin.java.JavaPlugin;

/**
 * Used for creating GUIs that only have one canvas e.g. HopperGUIs and a fixed size.
 * Bear in mind that for creating Chest Inventories you should use {@link ChestGUI}
 */
@SuppressWarnings("unused")
public class CanvasGUI extends BaseCanvasGUI {
    /**
     * Creates a new CanvasGUI
     * @param plugin The plugin
     * @param title The title of the GUI
     * @param height The height of the GUI
     * @param removeItems Whether to remove loose items on close.
     *                   The first player that closes the gui gets the items
     */
    @Deprecated(forRemoval = true)
    public CanvasGUI(Plugin plugin, TextComponent title, int height, boolean removeItems) {
        super(plugin, title, InventoryType.CHEST, removeItems);
        this.setCanvas(new SimpleGUIPane.Builder(this).size(new Vector2d(9, height)).autoSize(false).build());
    }

    /**
     * Creates a new CanvasGUI
     * @param plugin The plugin
     * @param title The title of the GUI
     * @param type The type of the GUI
     * @param removeItems Whether to remove loose items on close.
     *                   The first player that closes the gui gets the items
     */
    @Deprecated(forRemoval = true)
    public CanvasGUI(Plugin plugin, TextComponent title, InventoryType type, boolean removeItems) {
        super(plugin, title, type, removeItems);
        this.setCanvas(new SimpleGUIPane.Builder(this).size(InventoryTypeMapper.getSize(type)).autoSize(false).build());
    }

    /**
     * Builder used for creating CanvasGUIs
     * @param  The Plugin that uses this builder
     */
    public static class Builder
 extends BaseCanvasGUI.Builder, CanvasGUI, SimpleGUIPane, P> {
        private int height = 3;
        private InventoryType type = InventoryType.CHEST;
        /**
         * Creates a new Builder
         * @param plugin The plugin that uses this builder
         */
        public Builder(P plugin) {
            super(plugin);
        }

        /**
         * Sets the type attribute. You can either specify the type or the height.
         * @param type The inventory type
         * @return Itself
         */
        public Builder
 type(InventoryType type) {
            this.type = type;
            return this.self();
        }

        /**
         * Sets the height attribute. You can either specify the type or the height.
         * @param height The inventory's height. Only used if type is CHEST
         * @return Itself
         */
        public Builder
 height(int height) {
            this.height = height;
            return this.self();
        }

        @Override
        public CanvasGUI build() {
            if (this.type == InventoryType.CHEST) {
                return new CanvasGUI(this.getPlugin(), this.getTitle(), this.height, this.isRemoveItems());
            } else {
                return new CanvasGUI(this.getPlugin(), this.getTitle(), this.type, this.isRemoveItems());
            }
        }

        @Override
        protected Builder self() {
            return this;
        }
    }
}