de.placeblock.betterinventories.content.item.impl.ToggleGUIButton 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.content.item.impl;

import de.placeblock.betterinventories.content.item.GUIButton;
import de.placeblock.betterinventories.content.item.ClickData;
import de.placeblock.betterinventories.gui.GUI;
import lombok.Getter;
import org.bukkit.Sound;
import org.bukkit.inventory.ItemStack;

import java.util.function.BiConsumer;
import java.util.function.Supplier;

/**
 * GUIButton which toggles between on and off
 */
@SuppressWarnings("unused")
@Getter
public abstract class ToggleGUIButton extends GUIButton {
    /**
     * Whether the button is currently toggled
     */
    private boolean toggled;

    /**
     * Creates a new ToggleGUIButton
     * @param gui The GUI
     * @param permission The permission required to toggle
     * @param toggled The default value of the toggled-state
     * @param cooldown The cooldown of the Button
     * @param sound The sound played when pressing this button
     */
    public ToggleGUIButton(GUI gui, int cooldown, Sound sound, String permission, boolean toggled) {
        super(gui, null, cooldown, sound, permission);
        this.toggled = toggled;
        this.updateItem();
    }

    /**
     * Is called when the player clicks on the Button no matter how.
     * @param data The ClickData
     */
    @Override
    public void onClick(ClickData data) {
        this.toggle(data);
    }

    /**
     * Toggles the state of the Button
     * @param clickData The clickData of the action
     */
    public void toggle(ClickData clickData) {
        this.toggled = !this.toggled;
        this.onToggle(clickData, this.toggled);
        this.updateItem();
    }

    /**
     * Updates the Item of the Button using the current toggled state
     */
    private void updateItem() {
        this.setItemStack(this.toggled ? this.getEnabledItem() : this.getDisabledItem());
    }

    /**
     * @return The Item for the enabled-state
     */
    protected abstract ItemStack getEnabledItem();

    /**
     * @return The Item for the disabled-state
     */
    protected abstract ItemStack getDisabledItem();

    /**
     * Gets called when the Button gets toggled
     * @param clickData The clickData of the action
     * @param toggled The current state
     */
    protected abstract void onToggle(ClickData clickData, boolean toggled);


    /**
     * Builder for creating {@link ToggleGUIButton}
     */
    public static class Builder extends AbstractBuilder {
        private boolean toggled;
        private BiConsumer onToggle;
        private Supplier enabledItem;
        private Supplier disabledItem;

        /**
         * Creates a new Builder
         * @param gui The gui this button belongs to
         */
        public Builder(GUI gui) {
            super(gui);
        }

        /**
         * Sets the toggled attribute
         * @param toggled Default value for the toggled state
         * @return Itself
         */
        public Builder toggled(boolean toggled) {
            this.toggled = toggled;
            return this;
        }

        /**
         * Sets the onToggle attribute
         * @param onToggle Is called if the button is toggled
         * @return Itself
         */
        public Builder onToggle(BiConsumer onToggle) {
            this.onToggle = onToggle;
            return this;
        }

        /**
         * Sets the enabledItem attribute
         * @param enabledItem This item is shown if the button is toggled
         * @return Itself
         */
        public Builder enabledItem(Supplier enabledItem) {
            this.enabledItem = enabledItem;
            return this;
        }

        /**
         * Sets the disabledItem attribute
         * @param disabledItem This item is shown if the button is not toggled
         * @return Itself
         */
        public Builder disabledItem(Supplier disabledItem) {
            this.disabledItem = disabledItem;
            return this;
        }

        @Override
        public ToggleGUIButton build() {
            if (this.enabledItem == null || this.disabledItem == null) {
                throw new IllegalStateException("Enabled and Disabled items have to be set");
            }
            return new ToggleGUIButton(this.getGui(), this.getCooldown(),
                    this.getSound(), this.getPermission(), this.toggled) {
                @Override
                protected ItemStack getEnabledItem() {
                    return Builder.this.enabledItem.get();
                }

                @Override
                protected ItemStack getDisabledItem() {
                    return Builder.this.disabledItem.get();
                }

                @Override
                protected void onToggle(ClickData clickData, boolean toggled) {
                    Builder.this.onToggle.accept(clickData, toggled);
                }
            };
        }

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

}