Record Class ChatMessageReceiveEvent

java.lang.Object

java.lang.Record

com.soulfiremc.server.api.event.bot.ChatMessageReceiveEvent

Record Components:

connection - The bot connection instance.

timestamp - The timestamp when the message was received.

message - The message that was received.

All Implemented Interfaces:

SoulFireBotEvent, SoulFireEvent, SoulFireGlobalEvent, SoulFireInstanceEvent

public record ChatMessageReceiveEvent(BotConnection connection, long timestamp, net.kyori.adventure.text.Component message)
extends Record
implements SoulFireBotEvent

This event is called when a chat message is received from the server.

Constructor Summary

Constructors

Constructor	Description
ChatMessageReceiveEvent(BotConnection connection, long timestamp, net.kyori.adventure.text.Component message)	Creates an instance of a ChatMessageReceiveEvent record class.

Method Summary

Modifier and Type	Method	Description
BotConnection	connection()	Returns the value of the connection record component.
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.
net.kyori.adventure.text.Component	message()	Returns the value of the message record component.
String	parseToPlainText()
long	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface SoulFireBotEvent

instanceManager

Methods inherited from interface SoulFireInstanceEvent

soulFireServer

Constructor Details

ChatMessageReceiveEvent

public ChatMessageReceiveEvent(BotConnection connection,
 long timestamp,
 net.kyori.adventure.text.Component message)

Creates an instance of a ChatMessageReceiveEvent record class.

Parameters:

connection - the value for the connection record component

timestamp - the value for the timestamp record component

message - the value for the message record component

Method Details

parseToPlainText

public String parseToPlainText()

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

timestamp

public long timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp 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