<li><ahref="../../../../com/comphenix/protocol/events/MonitorAdapter.html"title="class in com.comphenix.protocol.events"><spanclass="strong">Prev Class</span></a></li>
<li><ahref="../../../../com/comphenix/protocol/events/PacketContainer.html"title="class in com.comphenix.protocol.events"><spanclass="strong">Next Class</span></a></li>
<dd><ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <spanclass="strong">PacketAdapter</span>
extends java.lang.Object
implements <ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></pre>
<divclass="block">Represents a packet listener with useful constructors.
<p>
Remember to override onPacketReceiving() and onPacketSending(), depending on the ConnectionSide.</div>
<dl><dt><spanclass="strong">Author:</span></dt>
<dd>Kristian</dd></dl>
</li>
</ul>
</div>
<divclass="summary">
<ulclass="blockList">
<liclass="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ulclass="blockList">
<liclass="blockList"><aname="field_summary">
<!---->
</a>
<h3>Field Summary</h3>
<tableclass="overviewSummary"border="0"cellpadding="3"cellspacing="0"summary="Field Summary table, listing fields, and an explanation">
<thclass="colFirst"scope="col">Modifier and Type</th>
<thclass="colLast"scope="col">Field and Description</th>
</tr>
<trclass="altColor">
<tdclass="colFirst"><code>protected <ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a></code></td>
<tdclass="colFirst"><code>protected <ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<tdclass="colFirst"><code>protected <ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
java.lang.Integer... packets)</code>
<divclass="block">Initialize a packet listener with default priority.</div>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
java.lang.Integer... packets)</code>
<divclass="block">Initialize a packet listener for a single connection side.</div>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
<tdclass="colLast"><code><strong><ahref="../../../../com/comphenix/protocol/events/PacketAdapter.html#getPluginName(com.comphenix.protocol.events.PacketListener)">getPluginName</a></strong>(<ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a> listener)</code>
<divclass="block">Retrieves the name of the plugin that has been associated with the listener.</div>
<tdclass="colFirst"><code><ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<tdclass="colFirst"><code><ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<tdclass="colLast"><code><strong><ahref="../../../../com/comphenix/protocol/events/PacketAdapter.html#onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">onPacketReceiving</a></strong>(<ahref="../../../../com/comphenix/protocol/events/PacketEvent.html"title="class in com.comphenix.protocol.events">PacketEvent</a> event)</code>
<divclass="block">Invoked right before a recieved packet from a client is being processed.</div>
<tdclass="colLast"><code><strong><ahref="../../../../com/comphenix/protocol/events/PacketAdapter.html#onPacketSending(com.comphenix.protocol.events.PacketEvent)">onPacketSending</a></strong>(<ahref="../../../../com/comphenix/protocol/events/PacketEvent.html"title="class in com.comphenix.protocol.events">PacketEvent</a> event)</code>
<divclass="block">Invoked right before a packet is transmitted from the server to the client.</div>
<pre>protected <ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide</pre>
</li>
</ul>
<aname="receivingWhitelist">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>receivingWhitelist</h4>
<pre>protected <ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a> receivingWhitelist</pre>
</li>
</ul>
<aname="sendingWhitelist">
<!---->
</a>
<ulclass="blockListLast">
<liclass="blockList">
<h4>sendingWhitelist</h4>
<pre>protected <ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a> sendingWhitelist</pre>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
java.lang.Integer... packets)</pre>
<divclass="block">Initialize a packet listener with default priority.</div>
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
<divclass="block">Initialize a packet listener for a single connection side.</div>
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>listenerPriority</code> - - the event priority.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<divclass="block">Initialize a packet listener for a single connection side.
<p>
The game phase is used to optmize performance. A listener should only choose BOTH or LOGIN if it's absolutely necessary.</div>
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>gamePhase</code> - - which game phase this listener is active under.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
<divclass="block">Initialize a packet listener for a single connection side.
<p>
The game phase is used to optmize performance. A listener should only choose BOTH or LOGIN if it's absolutely necessary.</div>
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>listenerPriority</code> - - the event priority.</dd><dd><code>gamePhase</code> - - which game phase this listener is active under.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
java.lang.Integer... packets)</pre>
<divclass="block">Initialize a packet listener for a single connection side.</div>
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>listenerPriority</code> - - the event priority.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>gamePhase</code> - - which game phase this listener is active under.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<ahref="../../../../com/comphenix/protocol/events/ConnectionSide.html"title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide,
<ahref="../../../../com/comphenix/protocol/events/ListenerPriority.html"title="enum in com.comphenix.protocol.events">ListenerPriority</a> listenerPriority,
<divclass="block">Initialize a packet listener for a single connection side.
<p>
The game phase is used to optmize performance. A listener should only choose BOTH or LOGIN if it's absolutely necessary.</div>
<dl><dt><spanclass="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin that spawned this listener.</dd><dd><code>connectionSide</code> - - the packet type the listener is looking for.</dd><dd><code>listenerPriority</code> - - the event priority.</dd><dd><code>gamePhase</code> - - which game phase this listener is active under.</dd><dd><code>packets</code> - - the packet IDs the listener is looking for.</dd></dl>
<pre>public void onPacketReceiving(<ahref="../../../../com/comphenix/protocol/events/PacketEvent.html"title="class in com.comphenix.protocol.events">PacketEvent</a> event)</pre>
<divclass="block"><strong>Description copied from interface: <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">PacketListener</a></code></strong></div>
<divclass="block">Invoked right before a recieved packet from a client is being processed.
<p>
<b>WARNING</b>: </br>
This method will be called <i>asynchronously</i>! You should synchronize with the main
<dd><code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">onPacketReceiving</a></code> in interface <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><spanclass="strong">Parameters:</span></dt><dd><code>event</code> - - the packet that has been recieved.</dd></dl>
<pre>public void onPacketSending(<ahref="../../../../com/comphenix/protocol/events/PacketEvent.html"title="class in com.comphenix.protocol.events">PacketEvent</a> event)</pre>
<divclass="block"><strong>Description copied from interface: <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketSending(com.comphenix.protocol.events.PacketEvent)">PacketListener</a></code></strong></div>
<divclass="block">Invoked right before a packet is transmitted from the server to the client.
<p>
Note that the packet may be replaced, if needed.
<p>
This method is executed on the main thread, and thus the Bukkit API is safe to use.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketSending(com.comphenix.protocol.events.PacketEvent)">onPacketSending</a></code> in interface <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><spanclass="strong">Parameters:</span></dt><dd><code>event</code> - - the packet that should be sent.</dd></dl>
</li>
</ul>
<aname="getReceivingWhitelist()">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getReceivingWhitelist</h4>
<pre>public <ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a> getReceivingWhitelist()</pre>
<divclass="block"><strong>Description copied from interface: <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#getReceivingWhitelist()">PacketListener</a></code></strong></div>
<divclass="block">Retrieve which packets sent by the client this listener will observe.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#getReceivingWhitelist()">getReceivingWhitelist</a></code> in interface <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><spanclass="strong">Returns:</span></dt><dd>List of server packets to observe, along with the priority.</dd></dl>
</li>
</ul>
<aname="getSendingWhitelist()">
<!---->
</a>
<ulclass="blockList">
<liclass="blockList">
<h4>getSendingWhitelist</h4>
<pre>public <ahref="../../../../com/comphenix/protocol/events/ListeningWhitelist.html"title="class in com.comphenix.protocol.events">ListeningWhitelist</a> getSendingWhitelist()</pre>
<divclass="block"><strong>Description copied from interface: <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#getSendingWhitelist()">PacketListener</a></code></strong></div>
<divclass="block">Retrieve which packets sent by the server this listener will observe.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#getSendingWhitelist()">getSendingWhitelist</a></code> in interface <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><spanclass="strong">Returns:</span></dt><dd>List of server packets to observe, along with the priority.</dd></dl>
<divclass="block"><strong>Description copied from interface: <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#getPlugin()">PacketListener</a></code></strong></div>
<divclass="block">Retrieve the plugin that created list packet listener.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html#getPlugin()">getPlugin</a></code> in interface <code><ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><spanclass="strong">Returns:</span></dt><dd>The plugin, or NULL if not available.</dd></dl>
<pre>public static java.lang.String getPluginName(<ahref="../../../../com/comphenix/protocol/events/PacketListener.html"title="interface in com.comphenix.protocol.events">PacketListener</a> listener)</pre>
<divclass="block">Retrieves the name of the plugin that has been associated with the listener.</div>
<li><ahref="../../../../com/comphenix/protocol/events/MonitorAdapter.html"title="class in com.comphenix.protocol.events"><spanclass="strong">Prev Class</span></a></li>
<li><ahref="../../../../com/comphenix/protocol/events/PacketContainer.html"title="class in com.comphenix.protocol.events"><spanclass="strong">Next Class</span></a></li>