Package net.md_5.bungee.api.event

Class CustomClickEvent

java.lang.Object

net.md_5.bungee.api.plugin.Event

net.md_5.bungee.api.event.CustomClickEvent

All Implemented Interfaces:

Cancellable

public class CustomClickEvent
extends Event
implements Cancellable

Called after a ProxiedPlayer runs a custom action from a chat event or form submission.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTION_KEY	Map key containing the form action, if available.

Constructor Summary

Constructors

Constructor	Description
CustomClickEvent(ProxiedPlayer player, String id, Map<String,String> data)	Creates a new CustomClickEvent instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,String>	getData()	Form data, may be null.
String	getId()	Custom action ID.
ProxiedPlayer	getPlayer()	Player who clicked.
int	hashCode()
boolean	isCancelled()	Cancelled state.
void	setCancelled(boolean cancelled)	Cancelled state.
String	toString()

Methods inherited from class net.md_5.bungee.api.plugin.Event

callEvent, postCall

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_KEY

public static final String ACTION_KEY

Map key containing the form action, if available.

See Also:

Constant Field Values

Constructor Detail

CustomClickEvent

public CustomClickEvent(ProxiedPlayer player,
                        String id,
                        Map<String,String> data)

Creates a new CustomClickEvent instance.

Parameters:

player - Player who clicked.

id - Custom action ID.

data - Form data, may be null. If a form submission, usually contains a CustomClickEvent.ACTION_KEY key with the ID of the relevant submission action.

Method Detail

getPlayer

public ProxiedPlayer getPlayer()

Player who clicked.

getId

public String getId()

Custom action ID.

getData

public Map<String,String> getData()

Form data, may be null. If a form submission, usually contains a CustomClickEvent.ACTION_KEY key with the ID of the relevant submission action.

isCancelled

public boolean isCancelled()

Cancelled state.

Specified by:

isCancelled in interface Cancellable

Returns:

the cancelled state of this event

setCancelled

public void setCancelled(boolean cancelled)

Cancelled state.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancelled - the state to set

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object