Package com.monkey.ultimatebot.api.extension.brain

Record Class BrainDamage

java.lang.Object
java.lang.Record
com.monkey.ultimatebot.api.extension.brain.BrainDamage
public record BrainDamage(double amount, org.bukkit.event.entity.EntityDamageEvent.DamageCause cause, @Nullable org.bukkit.entity.Entity source) extends Record
Immutable damage signal delivered directly to one custom brain session.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BrainDamage(double amount, org.bukkit.event.entity.EntityDamageEvent.DamageCause cause, @Nullable org.bukkit.entity.Entity source)
    Creates an instance of a BrainDamage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    amount()
    Returns the value of the amount record component.
    org.bukkit.event.entity.EntityDamageEvent.DamageCause
    cause()
    Returns the value of the cause record component.
    Optional<org.bukkit.entity.Entity>
    damageSource()
     
    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.
    @Nullable org.bukkit.entity.Entity
    source()
    Returns the value of the source 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

    • BrainDamage

      public BrainDamage(double amount, org.bukkit.event.entity.EntityDamageEvent.DamageCause cause, @Nullable org.bukkit.entity.Entity source)
      Creates an instance of a BrainDamage record class.
      Parameters:
      amount - the value for the amount record component
      cause - the value for the cause record component
      source - the value for the source record component

  • Method Details

    • damageSource

      public Optional<org.bukkit.entity.Entity> damageSource()

    • 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.

    • amount

      public double amount()
      Returns the value of the amount record component.
      Returns:
      the value of the amount record component

    • cause

      public org.bukkit.event.entity.EntityDamageEvent.DamageCause cause()
      Returns the value of the cause record component.
      Returns:
      the value of the cause record component

    • source

      public @Nullable org.bukkit.entity.Entity source()
      Returns the value of the source record component.
      Returns:
      the value of the source record component