com.comphenix.protocol.events

Class PacketAdapter

java.lang.Object

com.comphenix.protocol.events.PacketAdapter

All Implemented Interfaces:

PacketListener

public abstract class PacketAdapter
extends java.lang.Object
implements PacketListener

Represents a packet listener with useful constructors.

Remember to override onPacketReceiving() and onPacketSending(), depending on the ConnectionSide.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionSide	connectionSide
protected Plugin	plugin
protected ListeningWhitelist	receivingWhitelist
protected ListeningWhitelist	sendingWhitelist

Constructor Summary

Constructors

Constructor and Description
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, GamePhase gamePhase, java.lang.Integer... packets) Initialize a packet listener for a single connection side.
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, GamePhase gamePhase, java.util.Set<java.lang.Integer> packets) Initialize a packet listener for a single connection side.
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, java.lang.Integer... packets) Initialize a packet listener with default priority.
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, GamePhase gamePhase, java.lang.Integer... packets) Initialize a packet listener for a single connection side.
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, GamePhase gamePhase, java.util.Set<java.lang.Integer> packets) Initialize a packet listener for a single connection side.
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, java.lang.Integer... packets) Initialize a packet listener for a single connection side.
PacketAdapter(Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, java.util.Set<java.lang.Integer> packets) Initialize a packet listener for a single connection side.

Method Summary

Methods

Modifier and Type	Method and Description
Plugin	getPlugin() Retrieve the plugin that created list packet listener.
static java.lang.String	getPluginName(PacketListener listener) Retrieves the name of the plugin that has been associated with the listener.
static java.lang.String	getPluginName(Plugin plugin) Retrieves the name of the given plugin.
ListeningWhitelist	getReceivingWhitelist() Retrieve which packets sent by the client this listener will observe.
ListeningWhitelist	getSendingWhitelist() Retrieve which packets sent by the server this listener will observe.
void	onPacketReceiving(PacketEvent event) Invoked right before a recieved packet from a client is being processed.
void	onPacketSending(PacketEvent event) Invoked right before a packet is transmitted from the server to the client.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected Plugin plugin

connectionSide

protected ConnectionSide connectionSide

receivingWhitelist

protected ListeningWhitelist receivingWhitelist

sendingWhitelist

protected ListeningWhitelist sendingWhitelist

Constructor Detail

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             java.lang.Integer... packets)

Initialize a packet listener with default priority.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

packets - - the packet IDs the listener is looking for.

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             ListenerPriority listenerPriority,
             java.util.Set<java.lang.Integer> packets)

Initialize a packet listener for a single connection side.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

listenerPriority - - the event priority.

packets - - the packet IDs the listener is looking for.

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             GamePhase gamePhase,
             java.util.Set<java.lang.Integer> packets)

Initialize a packet listener for a single connection side.

The game phase is used to optmize performance. A listener should only choose BOTH or LOGIN if it's absolutely necessary.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

gamePhase - - which game phase this listener is active under.

packets - - the packet IDs the listener is looking for.

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             ListenerPriority listenerPriority,
             GamePhase gamePhase,
             java.util.Set<java.lang.Integer> packets)

Initialize a packet listener for a single connection side.

The game phase is used to optmize performance. A listener should only choose BOTH or LOGIN if it's absolutely necessary.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

listenerPriority - - the event priority.

gamePhase - - which game phase this listener is active under.

packets - - the packet IDs the listener is looking for.

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             ListenerPriority listenerPriority,
             java.lang.Integer... packets)

Initialize a packet listener for a single connection side.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

listenerPriority - - the event priority.

packets - - the packet IDs the listener is looking for.

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             GamePhase gamePhase,
             java.lang.Integer... packets)

Initialize a packet listener for a single connection side.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

gamePhase - - which game phase this listener is active under.

packets - - the packet IDs the listener is looking for.

PacketAdapter

public PacketAdapter(Plugin plugin,
             ConnectionSide connectionSide,
             ListenerPriority listenerPriority,
             GamePhase gamePhase,
             java.lang.Integer... packets)

Initialize a packet listener for a single connection side.

The game phase is used to optmize performance. A listener should only choose BOTH or LOGIN if it's absolutely necessary.

Parameters:

plugin - - the plugin that spawned this listener.

connectionSide - - the packet type the listener is looking for.

listenerPriority - - the event priority.

gamePhase - - which game phase this listener is active under.

packets - - the packet IDs the listener is looking for.

Method Detail

onPacketReceiving

public void onPacketReceiving(PacketEvent event)

Description copied from interface: PacketListener

Invoked right before a recieved packet from a client is being processed.

WARNING:
This method will be called asynchronously! You should synchronize with the main thread using scheduleSyncDelayedTask if you need to call the Bukkit API.

Specified by:

onPacketReceiving in interface PacketListener

Parameters:

event - - the packet that has been recieved.

onPacketSending

public void onPacketSending(PacketEvent event)

Description copied from interface: PacketListener

Invoked right before a packet is transmitted from the server to the client.

Note that the packet may be replaced, if needed.

This method is executed on the main thread, and thus the Bukkit API is safe to use.

Specified by:

onPacketSending in interface PacketListener

Parameters:

event - - the packet that should be sent.

getReceivingWhitelist

public ListeningWhitelist getReceivingWhitelist()

Description copied from interface: PacketListener

Retrieve which packets sent by the client this listener will observe.

Specified by:

getReceivingWhitelist in interface PacketListener

Returns:

List of server packets to observe, along with the priority.

getSendingWhitelist

public ListeningWhitelist getSendingWhitelist()

Description copied from interface: PacketListener

Retrieve which packets sent by the server this listener will observe.

Specified by:

getSendingWhitelist in interface PacketListener

Returns:

List of server packets to observe, along with the priority.

getPlugin

public Plugin getPlugin()

Description copied from interface: PacketListener

Retrieve the plugin that created list packet listener.

Specified by:

getPlugin in interface PacketListener

Returns:

The plugin, or NULL if not available.

getPluginName

public static java.lang.String getPluginName(PacketListener listener)

Retrieves the name of the plugin that has been associated with the listener.

Parameters:

listener - - the listener.

Returns:

Name of the associated plugin.

getPluginName

public static java.lang.String getPluginName(Plugin plugin)

Retrieves the name of the given plugin.

Parameters:

plugin - - the plugin.

Returns:

Name of the given plugin.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object