Package eu.sculkpowered.server.event.player

Record Class PlayerAttackedEntityEvent

java.lang.Object
java.lang.Record
eu.sculkpowered.server.event.player.PlayerAttackedEntityEvent
public record PlayerAttackedEntityEvent(@NotNull Player player, @NotNull Entity entity) extends Record
Represents an event that fires when a player attacks another entity.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerAttackedEntityEvent(@NotNull Player player, @NotNull Entity entity)
    Creates an instance of a PlayerAttackedEntityEvent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Entity
    entity()
    Returns the value of the entity 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

    • PlayerAttackedEntityEvent

      public PlayerAttackedEntityEvent(@NotNull @NotNull Player player, @NotNull @NotNull Entity entity)
      Creates an instance of a PlayerAttackedEntityEvent record class.
      Parameters:
      player - the value for the player record component
      entity - the value for the entity 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. 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.

    • player

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

    • entity

      @NotNull public @NotNull Entity entity()
      Returns the value of the entity record component.
      Returns:
      the value of the entity record component