Package de.placeblock.betterinventories.builder.content

Class BaseGUIButtonBuilder<G extends GUIButton,B extends BaseGUIButtonBuilder<G,B>>

java.lang.Object
de.placeblock.betterinventories.builder.content.BaseGUISectionBuilder<T,B>
de.placeblock.betterinventories.builder.content.BaseGUIItemBuilder<G,B>
de.placeblock.betterinventories.builder.content.BaseGUIButtonBuilder<G,B>
Type Parameters:
G - The GUIButton type
B - The Builder type
All Implemented Interfaces:
Builder<G,B>
Direct Known Subclasses:
GUIButtonBuilder, SubmitGUIButtonBuilder
public abstract class BaseGUIButtonBuilder<G extends GUIButton,B extends BaseGUIButtonBuilder<G,B>> extends BaseGUIItemBuilder<G,B>
Base class for creating GUIButton-Builders

  • Constructor Details

    • BaseGUIButtonBuilder

      public BaseGUIButtonBuilder(GUI gui)
      Creates a new BaseGUIButtonBuilder
      Parameters:
      gui - The GUI for the Button

  • Method Details

    • onClick

      public B onClick(Consumer<ClickData> onClick)
      Sets the onClick handler
      Parameters:
      onClick - The handler
      Returns:
      this

    • onLeftClick

      public B onLeftClick(Consumer<ClickData> onLeftClick)
      Sets the onLeftClick handler
      Parameters:
      onLeftClick - The handler
      Returns:
      this

    • onRightClick

      public B onRightClick(Consumer<ClickData> onRightClick)
      Sets the onRightClick handler
      Parameters:
      onRightClick - The handler
      Returns:
      this

    • onShiftClick

      public B onShiftClick(Consumer<ClickData> onShiftClick)
      Sets the onShiftClick handler
      Parameters:
      onShiftClick - The handler
      Returns:
      this

    • onShiftLeftClick

      public B onShiftLeftClick(Consumer<ClickData> onShiftLeftClick)
      Sets the onShiftLeftClick handler
      Parameters:
      onShiftLeftClick - The handler
      Returns:
      this

    • onShiftRightClick

      public B onShiftRightClick(Consumer<ClickData> onShiftRightClick)
      Sets the onShiftRightClick handler
      Parameters:
      onShiftRightClick - The handler
      Returns:
      this

    • permission

      public B permission(String permission)
      Sets the permission required to click on this button
      Parameters:
      permission - The permission
      Returns:
      this

    • clickSound

      public B clickSound(org.bukkit.Sound sound)
      Sets the click-sound this button makes on click
      Parameters:
      sound - The sound
      Returns:
      this

    • cooldown

      public B cooldown(int cooldown)
      Sets the cooldown after which the button can get clicked again
      Parameters:
      cooldown - The cooldown
      Returns:
      this

    • getOnClick

      protected Consumer<ClickData> getOnClick()
      Returns:
      The onClick Handler

    • getOnLeftClick

      protected Consumer<ClickData> getOnLeftClick()
      Returns:
      The onLeftClick Handler

    • getOnRightClick

      protected Consumer<ClickData> getOnRightClick()
      Returns:
      The onRightClick Handler

    • getOnShiftClick

      protected Consumer<ClickData> getOnShiftClick()
      Returns:
      The onShiftClick Handler

    • getOnShiftLeftClick

      protected Consumer<ClickData> getOnShiftLeftClick()
      Returns:
      The onShiftLeftClick Handler

    • getOnShiftRightClick

      protected Consumer<ClickData> getOnShiftRightClick()
      Returns:
      The onShiftRightClick Handler

    • getCooldown

      protected int getCooldown()
      Returns:
      The cooldown after which the Button can be clicked again

    • getClickSound

      protected org.bukkit.Sound getClickSound()
      Returns:
      The clickSound the Button makes when clicked or null

    • getPermission

      protected String getPermission()
      Returns:
      The permission required to click the Button or null