Package studio.mevera.lotus.api.button

Record Class SpanningButton

java.lang.Object
java.lang.Record
studio.mevera.lotus.api.button.SpanningButton
All Implemented Interfaces:
Button
public record SpanningButton(@NotNull org.bukkit.inventory.ItemStack item, @NotNull Set<Slot> footprint, @NotNull ClickAction action, @NotNull DataRegistry data) extends Record implements Button
A single logical button whose visual presence and click target span multiple slots — typically used for banners, multi-cell icons, region selectors or "tile" art that should read as one element to the user.

The footprint() is the immutable set of slots this button claims. Placement is most conveniently done via ContentEditor.placeSpanning(SpanningButton), which writes the same instance to every slot in the footprint. Because the Content map is keyed by Slot, every footprint slot resolves back to this same instance, and Bukkit will render item() in each one.

On click, action() fires once per click event regardless of which slot in the footprint was clicked. The originating slot remains available via InventoryClickEvent.getSlot() should the action wish to discriminate.

Lifecycle note: removing a spanning button should be done by clearing every slot in its footprint — clearing only one leaves the remainder visible but orphaned.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpanningButton(@NotNull org.bukkit.inventory.ItemStack item, @NotNull Set<Slot> footprint, @NotNull ClickAction action, @NotNull DataRegistry data)
    Creates an instance of a SpanningButton record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull ClickAction
    action()
    Returns the value of the action record component.
    @NotNull DataRegistry
    data()
    Returns the value of the data record component.
    void
    dispatch(@NotNull MenuView<?,?> view, @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull Set<Slot>
    footprint()
    Returns the value of the footprint record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull org.bukkit.inventory.ItemStack
    item()
    Returns the value of the item record component.
    final String
    toString()
    Returns a string representation of this record class.
    @NotNull SpanningButton
    withItem(@NotNull org.bukkit.inventory.ItemStack item)
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • SpanningButton

      public SpanningButton(@NotNull @NotNull org.bukkit.inventory.ItemStack item, @NotNull @NotNull Set<Slot> footprint, @NotNull @NotNull ClickAction action, @NotNull @NotNull DataRegistry data)
      Creates an instance of a SpanningButton record class.
      Parameters:
      item - the value for the item record component
      footprint - the value for the footprint record component
      action - the value for the action record component
      data - the value for the data record component

  • Method Details

    • withItem

      @NotNull public @NotNull SpanningButton withItem(@NotNull @NotNull org.bukkit.inventory.ItemStack item)
      Specified by:
      withItem in interface Button

    • dispatch

      public void dispatch(@NotNull @NotNull MenuView<?,?> view, @NotNull @NotNull org.bukkit.event.inventory.InventoryClickEvent event)
      Specified by:
      dispatch in interface Button

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • item

      @NotNull public @NotNull org.bukkit.inventory.ItemStack item()
      Returns the value of the item record component.
      Specified by:
      item in interface Button
      Returns:
      the value of the item record component

    • footprint

      @NotNull public @NotNull Set<Slot> footprint()
      Returns the value of the footprint record component.
      Returns:
      the value of the footprint record component

    • action

      @NotNull public @NotNull ClickAction action()
      Returns the value of the action record component.
      Returns:
      the value of the action record component

    • data

      @NotNull public @NotNull DataRegistry data()
      Returns the value of the data record component.
      Specified by:
      data in interface Button
      Returns:
      the value of the data record component