Package me.remigio07.chatplugin.api.server.event.tablist

Class TablistSendEvent

java.lang.Object

me.remigio07.chatplugin.api.server.event.tablist.TablistSendEvent

All Implemented Interfaces:

CancellableEvent, ChatPluginEvent, ChatPluginPlayerEvent, ChatPluginServerPlayerEvent

public class TablistSendEvent
extends Object
implements CancellableEvent, ChatPluginServerPlayerEvent

Represents an event called when a Tablist is sent to a player.

See Also:

• TablistManager.sendTablist(Tablist, ChatPluginServerPlayer)

Constructor Summary

Constructors

Constructor	Description
TablistSendEvent(Tablist tablist, ChatPluginServerPlayer player)	Constructs a new tablist send event.

Method Summary

Modifier and Type	Method	Description
ChatPluginServerPlayer	getPlayer()	Gets the player involved with this event.
Tablist	getTablist()	Gets the tablist sent to the player.
boolean	isCancelled()	Checks if this event has been cancelled and will not be executed.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface me.remigio07.chatplugin.api.common.event.ChatPluginEvent

call

Constructor Details

TablistSendEvent

public TablistSendEvent(Tablist tablist,
 ChatPluginServerPlayer player)

Constructs a new tablist send event.

Parameters:

tablist - Tablist involved

player - Player involved

Method Details

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Checks if this event has been cancelled and will not be executed.

Specified by:

isCancelled in interface CancellableEvent

Returns:

Whether this event is cancelled

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Sets the cancellation state of this event.

It will be passed through other registered listeners even if it is cancelled, but it will not be executed.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - Whether this event should be cancelled

getPlayer

public ChatPluginServerPlayer getPlayer()

Description copied from interface: ChatPluginServerPlayerEvent

Gets the player involved with this event.

Specified by:

getPlayer in interface ChatPluginPlayerEvent

Specified by:

getPlayer in interface ChatPluginServerPlayerEvent

Returns:

Player involved

getTablist

public Tablist getTablist()

Gets the tablist sent to the player.

Returns:

Tablist sent