Record Class BotDamageEvent

java.lang.Object
java.lang.Record
com.soulfiremc.server.api.event.bot.BotDamageEvent
Record Components:
connection - The bot connection instance.
previousHealth - The health before the damage was taken.
newHealth - The health after the damage was taken.
damageAmount - The amount of damage taken (previousHealth - newHealth).
All Implemented Interfaces:
SoulFireBotEvent, SoulFireEvent, SoulFireGlobalEvent, SoulFireInstanceEvent
public record BotDamageEvent(BotConnection connection, float previousHealth, float newHealth, float damageAmount) extends Record implements SoulFireBotEvent
This event is called when the bot takes damage (health decreases).

  • Constructor Details

    • BotDamageEvent

      public BotDamageEvent(BotConnection connection, float previousHealth, float newHealth, float damageAmount)
      Creates an instance of a BotDamageEvent record class.
      Parameters:
      connection - the value for the connection record component
      previousHealth - the value for the previousHealth record component
      newHealth - the value for the newHealth record component
      damageAmount - the value for the damageAmount 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 the compare method from their corresponding wrapper classes.
      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.

    • connection

      public BotConnection connection()
      Returns the value of the connection record component.
      Specified by:
      connection in interface SoulFireBotEvent
      Returns:
      the value of the connection record component

    • previousHealth

      public float previousHealth()
      Returns the value of the previousHealth record component.
      Returns:
      the value of the previousHealth record component

    • newHealth

      public float newHealth()
      Returns the value of the newHealth record component.
      Returns:
      the value of the newHealth record component

    • damageAmount

      public float damageAmount()
      Returns the value of the damageAmount record component.
      Returns:
      the value of the damageAmount record component