Record Class ChatMessageEvent

java.lang.Object
java.lang.Record
com.botwithus.bot.api.event.ChatMessageEvent
Record Components:
message - the chat message payload
timestamp - event creation time in milliseconds since epoch
All Implemented Interfaces:
GameEvent
public record ChatMessageEvent(ChatMessage message, long timestamp) extends Record implements GameEvent
Event fired when a chat message is received in the game.

Subscribe to this event via the EventBus to react to chat messages:

eventBus.subscribe(ChatMessageEvent.class, event -> {
    ChatMessage msg = event.message();
    log.info("{}: {}", msg.playerName(), msg.text());
});
See Also:

  • Constructor Details

    • ChatMessageEvent

      public ChatMessageEvent(ChatMessage message)

    • ChatMessageEvent

      public ChatMessageEvent(ChatMessage message, long timestamp)
      Creates an instance of a ChatMessageEvent record class.
      Parameters:
      message - the value for the message record component
      timestamp - the value for the timestamp 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.

    • message

      public ChatMessage message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface GameEvent
      Returns:
      the value of the timestamp record component