Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-11-28 21:56:01 +01:00
Code Issues Projects Releases Wiki Activity
a6755d0ddd
ProtocolLib/Javadoc/com/comphenix/protocol/events/PacketAdapter.html
Kristian S. Stangeland a6755d0ddd Updated JavaDoc for 2.0.0
2013-01-10 00:58:34 +01:00

646 lines
37 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_07) on Thu Jan 10 00:56:15 CET 2013 -->
<title>PacketAdapter</title>
<meta name="date" content="2013-01-10">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PacketAdapter";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PacketAdapter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/comphenix/protocol/events/MonitorAdapter.html" title="class in com.comphenix.protocol.events"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/events/PacketAdapter.html" target="_top">Frames</a></li>
<li><a href="PacketAdapter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.comphenix.protocol.events</div>
<h2 title="Class PacketAdapter" class="title">Class PacketAdapter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.events.PacketAdapter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">PacketAdapter</span>
extends java.lang.Object
implements <a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></pre>
<div class="block">Represents a packet listener with useful constructors.
<p>
Remember to override onPacketReceiving() and onPacketSending(), depending on the ConnectionSide.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Kristian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#connectionSide">connectionSide</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected org.bukkit.plugin.Plugin</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#plugin">plugin</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#receivingWhitelist">receivingWhitelist</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#sendingWhitelist">sendingWhitelist</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.injector.GamePhase, java.lang.Integer...)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.lang.Integer...&nbsp;packets)</code>
<div class="block">Initialize a packet listener for a single connection side.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.injector.GamePhase, java.util.Set)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;packets)</code>
<div class="block">Initialize a packet listener for a single connection side.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, java.lang.Integer...)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
java.lang.Integer...&nbsp;packets)</code>
<div class="block">Initialize a packet listener with default priority.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, com.comphenix.protocol.injector.GamePhase, java.lang.Integer...)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.lang.Integer...&nbsp;packets)</code>
<div class="block">Initialize a packet listener for a single connection side.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, com.comphenix.protocol.injector.GamePhase, java.util.Set)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;packets)</code>
<div class="block">Initialize a packet listener for a single connection side.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, java.lang.Integer...)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
java.lang.Integer...&nbsp;packets)</code>
<div class="block">Initialize a packet listener for a single connection side.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, java.util.Set)">PacketAdapter</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;packets)</code>
<div class="block">Initialize a packet listener for a single connection side.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.bukkit.plugin.Plugin</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#getPlugin()">getPlugin</a></strong>()</code>
<div class="block">Retrieve the plugin that created list packet listener.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#getPluginName(com.comphenix.protocol.events.PacketListener)">getPluginName</a></strong>(<a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a>&nbsp;listener)</code>
<div class="block">Retrieves the name of the plugin that has been associated with the listener.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#getPluginName(org.bukkit.plugin.Plugin)">getPluginName</a></strong>(org.bukkit.plugin.Plugin&nbsp;plugin)</code>
<div class="block">Retrieves the name of the given plugin.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#getReceivingWhitelist()">getReceivingWhitelist</a></strong>()</code>
<div class="block">Retrieve which packets sent by the client this listener will observe.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#getSendingWhitelist()">getSendingWhitelist</a></strong>()</code>
<div class="block">Retrieve which packets sent by the server this listener will observe.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">onPacketReceiving</a></strong>(<a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a>&nbsp;event)</code>
<div class="block">Invoked right before a recieved packet from a client is being processed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#onPacketSending(com.comphenix.protocol.events.PacketEvent)">onPacketSending</a></strong>(<a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a>&nbsp;event)</code>
<div class="block">Invoked right before a packet is transmitted from the server to the client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/events/PacketAdapter.html#toString()">toString</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="plugin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plugin</h4>
<pre>protected&nbsp;org.bukkit.plugin.Plugin plugin</pre>
</li>
</ul>
<a name="connectionSide">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>connectionSide</h4>
<pre>protected&nbsp;<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a> connectionSide</pre>
</li>
</ul>
<a name="receivingWhitelist">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>receivingWhitelist</h4>
<pre>protected&nbsp;<a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a> receivingWhitelist</pre>
</li>
</ul>
<a name="sendingWhitelist">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sendingWhitelist</h4>
<pre>protected&nbsp;<a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a> sendingWhitelist</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, java.lang.Integer...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
java.lang.Integer...&nbsp;packets)</pre>
<div class="block">Initialize a packet listener with default priority.</div>
<dl><dt><span class="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>
</li>
</ul>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;packets)</pre>
<div class="block">Initialize a packet listener for a single connection side.</div>
<dl><dt><span class="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>
</li>
</ul>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.injector.GamePhase, java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;packets)</pre>
<div class="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><span class="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>
</li>
</ul>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, com.comphenix.protocol.injector.GamePhase, java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.util.Set&lt;java.lang.Integer&gt;&nbsp;packets)</pre>
<div class="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><span class="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>
</li>
</ul>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, java.lang.Integer...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
java.lang.Integer...&nbsp;packets)</pre>
<div class="block">Initialize a packet listener for a single connection side.</div>
<dl><dt><span class="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>
</li>
</ul>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.injector.GamePhase, java.lang.Integer...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.lang.Integer...&nbsp;packets)</pre>
<div class="block">Initialize a packet listener for a single connection side.</div>
<dl><dt><span class="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>
</li>
</ul>
<a name="PacketAdapter(org.bukkit.plugin.Plugin, com.comphenix.protocol.events.ConnectionSide, com.comphenix.protocol.events.ListenerPriority, com.comphenix.protocol.injector.GamePhase, java.lang.Integer...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PacketAdapter</h4>
<pre>public&nbsp;PacketAdapter(org.bukkit.plugin.Plugin&nbsp;plugin,
<a href="../../../../com/comphenix/protocol/events/ConnectionSide.html" title="enum in com.comphenix.protocol.events">ConnectionSide</a>&nbsp;connectionSide,
<a href="../../../../com/comphenix/protocol/events/ListenerPriority.html" title="enum in com.comphenix.protocol.events">ListenerPriority</a>&nbsp;listenerPriority,
<a href="../../../../com/comphenix/protocol/injector/GamePhase.html" title="enum in com.comphenix.protocol.injector">GamePhase</a>&nbsp;gamePhase,
java.lang.Integer...&nbsp;packets)</pre>
<div class="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><span class="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>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onPacketReceiving</h4>
<pre>public&nbsp;void&nbsp;onPacketReceiving(<a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a>&nbsp;event)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">PacketListener</a></code></strong></div>
<div class="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
thread using <code>scheduleSyncDelayedTask</code>
if you need to call the Bukkit API.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketReceiving(com.comphenix.protocol.events.PacketEvent)">onPacketReceiving</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>event</code> - - the packet that has been recieved.</dd></dl>
</li>
</ul>
<a name="onPacketSending(com.comphenix.protocol.events.PacketEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onPacketSending</h4>
<pre>public&nbsp;void&nbsp;onPacketSending(<a href="../../../../com/comphenix/protocol/events/PacketEvent.html" title="class in com.comphenix.protocol.events">PacketEvent</a>&nbsp;event)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketSending(com.comphenix.protocol.events.PacketEvent)">PacketListener</a></code></strong></div>
<div class="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><a href="../../../../com/comphenix/protocol/events/PacketListener.html#onPacketSending(com.comphenix.protocol.events.PacketEvent)">onPacketSending</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>event</code> - - the packet that should be sent.</dd></dl>
</li>
</ul>
<a name="getReceivingWhitelist()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReceivingWhitelist</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a>&nbsp;getReceivingWhitelist()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#getReceivingWhitelist()">PacketListener</a></code></strong></div>
<div class="block">Retrieve which packets sent by the client this listener will observe.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#getReceivingWhitelist()">getReceivingWhitelist</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>List of server packets to observe, along with the priority.</dd></dl>
</li>
</ul>
<a name="getSendingWhitelist()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSendingWhitelist</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/events/ListeningWhitelist.html" title="class in com.comphenix.protocol.events">ListeningWhitelist</a>&nbsp;getSendingWhitelist()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#getSendingWhitelist()">PacketListener</a></code></strong></div>
<div class="block">Retrieve which packets sent by the server this listener will observe.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#getSendingWhitelist()">getSendingWhitelist</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>List of server packets to observe, along with the priority.</dd></dl>
</li>
</ul>
<a name="getPlugin()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlugin</h4>
<pre>public&nbsp;org.bukkit.plugin.Plugin&nbsp;getPlugin()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#getPlugin()">PacketListener</a></code></strong></div>
<div class="block">Retrieve the plugin that created list packet listener.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../com/comphenix/protocol/events/PacketListener.html#getPlugin()">getPlugin</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The plugin, or NULL if not available.</dd></dl>
</li>
</ul>
<a name="getPluginName(com.comphenix.protocol.events.PacketListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getPluginName(<a href="../../../../com/comphenix/protocol/events/PacketListener.html" title="interface in com.comphenix.protocol.events">PacketListener</a>&nbsp;listener)</pre>
<div class="block">Retrieves the name of the plugin that has been associated with the listener.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - - the listener.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Name of the associated plugin.</dd></dl>
</li>
</ul>
<a name="getPluginName(org.bukkit.plugin.Plugin)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPluginName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getPluginName(org.bukkit.plugin.Plugin&nbsp;plugin)</pre>
<div class="block">Retrieves the name of the given plugin.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plugin</code> - - the plugin.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Name of the given plugin.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PacketAdapter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/comphenix/protocol/events/MonitorAdapter.html" title="class in com.comphenix.protocol.events"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/events/PacketAdapter.html" target="_top">Frames</a></li>
<li><a href="PacketAdapter.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink