Record Class PlayerDialogActionEvent

java.lang.Object

java.lang.Record

fr.fidorial.event.player.PlayerDialogActionEvent

All Implemented Interfaces:

Event, PlayerEvent

public record PlayerDialogActionEvent(Player player, Key id, DialogResponse response)
extends Record
implements PlayerEvent

Fired when a player presses a dialog button carrying a custom or dynamic custom action.

Since:

0.1.0

Since Minecraft:

1.21.6

Constructor Summary

Constructors

Constructor	Description
PlayerDialogActionEvent(Player player, Key id, DialogResponse response)	Creates an instance of a PlayerDialogActionEvent record class.

Method Summary

Modifier and Type	Method	Description
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.
Key	id()	Returns the identifier the action was declared with.
Player	player()	Returns the value of the player record component.
DialogResponse	response()	Returns the input values the player submitted, empty for a static custom action.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

PlayerDialogActionEvent

public PlayerDialogActionEvent(Player player,
 Key id,
 DialogResponse response)

Creates an instance of a PlayerDialogActionEvent record class.

Parameters:

player - the value for the player record component

id - the value for the id record component

response - the value for the response record component

Method Details

id

public Key id()

Returns the identifier the action was declared with.

Returns:

the identifier the action was declared with

Since:

0.1.0

response

public DialogResponse response()

Returns the input values the player submitted, empty for a static custom action.

Returns:

the input values the player submitted, empty for a static custom action

Since:

0.1.0

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.

player

public Player player()

Returns the value of the player record component.

Specified by:

player in interface PlayerEvent

Returns:

the value of the player record component