Record Class CustomItemListener

java.lang.Object
java.lang.Record
net.mathias2246.buildmc.api.item.CustomItemListener
All Implemented Interfaces:
org.bukkit.event.Listener

public record CustomItemListener(@NotNull CustomItemRegistry itemRegistry) extends Record implements org.bukkit.event.Listener
The Listener used to call the events inside custom item type implementations.

NOTE: This listener needs to be registered in your plugin when you want to be able to use custom items.

  • Constructor Details

    • CustomItemListener

      public CustomItemListener(@NotNull @NotNull CustomItemRegistry itemRegistry)
      Creates an instance of a CustomItemListener record class.
      Parameters:
      itemRegistry - the value for the itemRegistry record component
  • Method Details

    • onItemInteract

      public void onItemInteract(@NotNull @NotNull org.bukkit.event.player.PlayerInteractEvent event)
    • 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.
    • itemRegistry

      @NotNull public @NotNull CustomItemRegistry itemRegistry()
      Returns the value of the itemRegistry record component.
      Returns:
      the value of the itemRegistry record component