Package com.velocitypowered.api.event.player

Class PlayerChannelUnregisterEvent

java.lang.Object

com.velocitypowered.api.event.player.PlayerChannelUnregisterEvent

public final class PlayerChannelUnregisterEvent
extends Object

This event is fired when a client (Player) sends a plugin message through the unregister channel. Velocity will not wait on this event to finish firing.

Constructor Summary

Constructors

Constructor	Description
PlayerChannelUnregisterEvent(Player player, List<ChannelIdentifier> channels)	Constructs a new PlayerChannelUnregisterEvent.

Method Summary

Modifier and Type	Method	Description
List<ChannelIdentifier>	getChannels()	Gets the list of ChannelIdentifiers that the player has unregistered.
Player	getPlayer()	Gets the Player who sent the unregister message.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

PlayerChannelUnregisterEvent

public PlayerChannelUnregisterEvent(Player player,
 List<ChannelIdentifier> channels)

Constructs a new PlayerChannelUnregisterEvent.

Parameters:

player - the player that sent the unregister message

channels - the list of ChannelIdentifiers being unregistered

Throws:

NullPointerException - if player or channels is null

Method Details

getPlayer

public Player getPlayer()

Gets the Player who sent the unregister message.

Returns:

the player involved in this event

getChannels

public List<ChannelIdentifier> getChannels()

Gets the list of ChannelIdentifiers that the player has unregistered.

These identifiers correspond to the plugin message channels that the client has indicated it will no longer use.

Returns:

the list of unregistered channels

toString

public String toString()

Overrides:

toString in class Object