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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PacketAdapter.AdapterParameteters Represents a builder for passing parameters to the packet adapter constructor.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PacketAdapter(PacketAdapter.AdapterParameteters params) Initialize a packet adapter using a collection of parameters.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, GamePhase gamePhase, java.lang.Integer... packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, GamePhase gamePhase, java.util.Set<java.lang.Integer> packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, java.lang.Integer... packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, ListenerOptions[] options, java.lang.Integer... packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, GamePhase gamePhase, java.lang.Integer... packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, GamePhase gamePhase, ListenerOptions[] options, java.lang.Integer... packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, GamePhase gamePhase, java.util.Set<java.lang.Integer> packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, java.lang.Integer... packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ConnectionSide connectionSide, ListenerPriority listenerPriority, java.util.Set<java.lang.Integer> packets) Deprecated.
PacketAdapter(org.bukkit.plugin.Plugin plugin, java.lang.Iterable<? extends PacketType> types) Initialize a packet listener with the given parameters.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ListenerPriority listenerPriority, java.lang.Iterable<? extends PacketType> types) Initialize a packet listener with the given parameters.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ListenerPriority listenerPriority, java.lang.Iterable<? extends PacketType> types, ListenerOptions... options) Initialize a packet listener with the given parameters.
PacketAdapter(org.bukkit.plugin.Plugin plugin, ListenerPriority listenerPriority, PacketType... types) Initialize a packet listener with the given parameters.
PacketAdapter(org.bukkit.plugin.Plugin plugin, PacketType... types) Initialize a packet listener with the given parameters.

Method Summary

Methods

Modifier and Type	Method and Description
org.bukkit.plugin.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(org.bukkit.plugin.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 received packet from a client is being processed.
void	onPacketSending(PacketEvent event) Invoked right before a packet is transmitted from the server to the client.
static PacketAdapter.AdapterParameteters	params() Construct a helper object for passing parameters to the packet adapter.
static PacketAdapter.AdapterParameteters	params(org.bukkit.plugin.Plugin plugin, java.lang.Integer... packets) Deprecated.
static PacketAdapter.AdapterParameteters	params(org.bukkit.plugin.Plugin plugin, PacketType... packets) Construct a helper object for passing parameters to the packet adapter.
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 org.bukkit.plugin.Plugin plugin

connectionSide

protected ConnectionSide connectionSide

receivingWhitelist

protected ListeningWhitelist receivingWhitelist

sendingWhitelist

protected ListeningWhitelist sendingWhitelist

Constructor Detail

PacketAdapter

public PacketAdapter(@Nonnull
             PacketAdapter.AdapterParameteters params)

Initialize a packet adapter using a collection of parameters. Use params() to get an instance to this builder.

Parameters:

params - - the parameters.

PacketAdapter

public PacketAdapter(org.bukkit.plugin.Plugin plugin,
             PacketType... types)

Initialize a packet listener with the given parameters.

Parameters:

plugin - - the plugin.

listenerPriority - - the priority.

types - - the packet types.

PacketAdapter

public PacketAdapter(org.bukkit.plugin.Plugin plugin,
             java.lang.Iterable<? extends PacketType> types)

Initialize a packet listener with the given parameters.

Parameters:

plugin - - the plugin.

types - - the packet types.

PacketAdapter

public PacketAdapter(org.bukkit.plugin.Plugin plugin,
             ListenerPriority listenerPriority,
             java.lang.Iterable<? extends PacketType> types)

Initialize a packet listener with the given parameters.

Parameters:

plugin - - the plugin.

listenerPriority - - the priority.

types - - the packet types.

PacketAdapter

public PacketAdapter(org.bukkit.plugin.Plugin plugin,
             ListenerPriority listenerPriority,
             java.lang.Iterable<? extends PacketType> types,
             ListenerOptions... options)

Initialize a packet listener with the given parameters.

Parameters:

plugin - - the plugin.

listenerPriority - - the priority.

types - - the packet types.

options - - the options.

PacketAdapter

public PacketAdapter(org.bukkit.plugin.Plugin plugin,
             ListenerPriority listenerPriority,
             PacketType... types)

Initialize a packet listener with the given parameters.

Parameters:

plugin - - the plugin.

listenerPriority - - the priority.

types - - the packet types.

PacketAdapter

@Deprecated
public PacketAdapter(org.bukkit.plugin.Plugin plugin,
                        ConnectionSide connectionSide,
                        java.lang.Integer... packets)

Deprecated.

Initialize a packet listener with default priority.

Deprecated: Use params() instead.

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

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

Deprecated.

Initialize a packet listener for a single connection side.

Deprecated: Use params() instead.

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

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

Deprecated.

Initialize a packet listener for a single connection side.

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

Deprecated: Use params() instead.

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

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

Deprecated.

Initialize a packet listener for a single connection side.

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

Deprecated: Use params() instead.

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

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

Deprecated.

Initialize a packet listener for a single connection side.

Deprecated: Use params() instead.

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

@Deprecated
public PacketAdapter(org.bukkit.plugin.Plugin plugin,
                        ConnectionSide connectionSide,
                        ListenerOptions[] options,
                        java.lang.Integer... packets)

Deprecated.

Initialize a packet listener for a single connection side.

Deprecated: Use params() instead.

Parameters:

plugin - - the plugin that spawned this listener.

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

options - - which listener options to use.

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

PacketAdapter

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

Deprecated.

Initialize a packet listener for a single connection side.

Deprecated: Use params() instead.

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

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

Deprecated.

Initialize a packet listener for a single connection side.

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

Deprecated: Use params() instead.

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

@Deprecated
public PacketAdapter(org.bukkit.plugin.Plugin plugin,
                        ConnectionSide connectionSide,
                        ListenerPriority listenerPriority,
                        GamePhase gamePhase,
                        ListenerOptions[] options,
                        java.lang.Integer... packets)

Deprecated.

Initialize a packet listener for a single connection side.

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

Listener options must be specified in order for NetworkMarker.getInputBuffer() to function correctly.

Deprecated: Use params() instead.

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.

options - - which listener options to use.

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 received 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 received.

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 in 1.6.4 and earlier, and thus the Bukkit API is safe to use.

In Minecraft 1.7.2 and later, this method MAY be executed asynchronously, but only if ListenerOptions.ASYNC have been specified in the listener. This is off by default.

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 org.bukkit.plugin.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(org.bukkit.plugin.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

params

public static PacketAdapter.AdapterParameteters params()

Construct a helper object for passing parameters to the packet adapter.

This is often simpler and better than passing them directly to each constructor.

Returns:

Helper object.

params

@Deprecated
public static PacketAdapter.AdapterParameteters params(org.bukkit.plugin.Plugin plugin,
                                                  java.lang.Integer... packets)

Deprecated.

Construct a helper object for passing parameters to the packet adapter.

This is often simpler and better than passing them directly to each constructor. Deprecated: Use params(Plugin, PacketType...) instead.

Parameters:

plugin - - the plugin that spawned this listener.

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

Returns:

Helper object.

params

public static PacketAdapter.AdapterParameteters params(org.bukkit.plugin.Plugin plugin,
                                       PacketType... packets)

Construct a helper object for passing parameters to the packet adapter.

This is often simpler and better than passing them directly to each constructor.

Parameters:

plugin - - the plugin that spawned this listener.

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

Returns:

Helper object.