Record Class BotDisconnectedEvent

java.lang.Object
java.lang.Record
com.soulfiremc.server.api.event.bot.BotDisconnectedEvent
Record Components:
connection - The bot connection instance.
message - The disconnect message that was received.
All Implemented Interfaces:
SoulFireBotEvent, SoulFireEvent, SoulFireGlobalEvent, SoulFireInstanceEvent
public record BotDisconnectedEvent(BotConnection connection, net.kyori.adventure.text.Component message) extends Record implements SoulFireBotEvent
This event is called when a bot is disconnected from the server.

  • Constructor Details

    • BotDisconnectedEvent

      public BotDisconnectedEvent(BotConnection connection, net.kyori.adventure.text.Component message)
      Creates an instance of a BotDisconnectedEvent record class.
      Parameters:
      connection - the value for the connection record component
      message - the value for the message 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.

    • 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

    • message

      public net.kyori.adventure.text.Component message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component