Package eu.sculkpowered.server.event.player

Record Class PlayerClickContainerButtonEvent

java.lang.Object
java.lang.Record
eu.sculkpowered.server.event.player.PlayerClickContainerButtonEvent
public record PlayerClickContainerButtonEvent(@NotNull Player player, @NotNull Container container, int button) extends Record
Represents an event that fires when the client clicks at a container button.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerClickContainerButtonEvent(@NotNull Player player, @NotNull Container container, int button)
    Creates an instance of a PlayerClickContainerButtonEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    button()
    Returns the value of the button record component.
    @NotNull Container
    container()
    Returns the value of the container record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull Player
    player()
    Returns the value of the player record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PlayerClickContainerButtonEvent

      public PlayerClickContainerButtonEvent(@NotNull @NotNull Player player, @NotNull @NotNull Container container, int button)
      Creates an instance of a PlayerClickContainerButtonEvent record class.
      Parameters:
      player - the value for the player record component
      container - the value for the container record component
      button - the value for the button record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • player

      @NotNull public @NotNull Player player()
      Returns the value of the player record component.
      Returns:
      the value of the player record component

    • container

      @NotNull public @NotNull Container container()
      Returns the value of the container record component.
      Returns:
      the value of the container record component

    • button

      public int button()
      Returns the value of the button record component.
      Returns:
      the value of the button record component