Record Class BotOpenContainerEvent

java.lang.Object

java.lang.Record

com.soulfiremc.server.api.event.bot.BotOpenContainerEvent

All Implemented Interfaces:

SoulFireBotEvent, SoulFireEvent, SoulFireGlobalEvent, SoulFireInstanceEvent

public record BotOpenContainerEvent(BotConnection connection, int containerId, String containerName, String containerType)
extends Record
implements SoulFireBotEvent

This event is called when the bot opens screen.

Constructor Summary

Constructors

Constructor	Description
BotOpenContainerEvent(BotConnection connection, int containerId, String containerName, String containerType)	Creates an instance of a BotOpenContainerEvent record class.

Method Summary

Modifier and Type	Method	Description
BotConnection	connection()	Returns the value of the connection record component.
int	containerId()	Returns the value of the containerId record component.
String	containerName()	Returns the value of the containerName record component.
String	containerType()	Returns the value of the containerType 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.
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

BotOpenContainerEvent

public BotOpenContainerEvent(BotConnection connection,
 int containerId,
 String containerName,
 String containerType)

Creates an instance of a BotOpenContainerEvent record class.

Parameters:

connection - the value for the connection record component

containerId - the value for the containerId record component

containerName - the value for the containerName record component

containerType - the value for the containerType 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

containerId

public int containerId()

Returns the value of the containerId record component.

Returns:

the value of the containerId record component

containerName

public String containerName()

Returns the value of the containerName record component.

Returns:

the value of the containerName record component

containerType

public String containerType()

Returns the value of the containerType record component.

Returns:

the value of the containerType record component