Record Class BotConnectionInitEvent

java.lang.Object
java.lang.Record
com.soulfiremc.server.api.event.bot.BotConnectionInitEvent
Record Components:
connection - The bot connection instance.
All Implemented Interfaces:
SoulFireBotEvent, SoulFireEvent, SoulFireGlobalEvent, SoulFireInstanceEvent
public record BotConnectionInitEvent(BotConnection connection) extends Record implements SoulFireBotEvent

The event is called the moment after a bot connection object was created. The BotConnection instance has all fields filled, but most methods are unusable as the bot is not connected yet.

This event is recommended for when you want to add a plugin listener to the bot connection.

  • Constructor Details

    • BotConnectionInitEvent

      public BotConnectionInitEvent(BotConnection connection)
      Creates an instance of a BotConnectionInitEvent record class.
      Parameters:
      connection - the value for the connection 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