ProtocolLib/Javadoc/com/comphenix/protocol/Packets.html

384 lines
14 KiB
HTML
Raw Normal View History

2012-10-17 08:07:20 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
2013-02-05 23:35:15 +01:00
<!-- Generated by javadoc (version 1.7.0_07) on Tue Feb 05 23:33:34 CET 2013 -->
2012-10-17 08:07:20 +02:00
<title>Packets</title>
2013-02-05 23:35:15 +01:00
<meta name="date" content="2013-02-05">
2012-10-17 08:07:20 +02:00
<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="Packets";
}
//-->
</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/Packets.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/AsynchronousManager.html" title="interface in com.comphenix.protocol"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/comphenix/protocol/Packets.Client.html" title="class in com.comphenix.protocol"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/comphenix/protocol/Packets.html" target="_top">Frames</a></li>
<li><a href="Packets.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
2013-02-05 23:35:15 +01:00
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
2012-10-17 08:07:20 +02:00
<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>
2013-02-05 23:35:15 +01:00
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
2012-10-17 08:07:20 +02:00
<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</div>
<h2 title="Class Packets" class="title">Class Packets</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.Packets</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">Packets</span>
extends java.lang.Object</pre>
<div class="block">List of known packet IDs since 1.3.2.</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">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/Packets.Client.html" title="class in com.comphenix.protocol">Packets.Client</a></strong></code>
<div class="block">List of packets sent by the client.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/Packets.Server.html" title="class in com.comphenix.protocol">Packets.Server</a></strong></code>
<div class="block">List of packets sent only by the server.</div>
</td>
</tr>
</table>
</li>
</ul>
2013-02-05 23:35:15 +01:00
<!-- =========== 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>static int</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/Packets.html#MAXIMUM_PACKET_ID">MAXIMUM_PACKET_ID</a></strong></code>
<div class="block">The highest possible packet ID.</div>
</td>
</tr>
</table>
</li>
</ul>
2012-10-17 08:07:20 +02:00
<!-- ======== 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/Packets.html#Packets()">Packets</a></strong>()</code>&nbsp;</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>static <a href="../../../com/comphenix/protocol/Packets.Client.html" title="class in com.comphenix.protocol">Packets.Client</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/Packets.html#getClientRegistry()">getClientRegistry</a></strong>()</code>
<div class="block">A registry that parses between names and packet IDs.</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/Packets.html#getDeclaredName(int)">getDeclaredName</a></strong>(int&nbsp;packetID)</code>
<div class="block">Retrieves the name of a packet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/comphenix/protocol/Packets.Server.html" title="class in com.comphenix.protocol">Packets.Server</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/Packets.html#getServerRegistry()">getServerRegistry</a></strong>()</code>
<div class="block">A registry that parses between names and packet IDs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../com/comphenix/protocol/Packets.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Find a packet by name.</div>
</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, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2013-02-05 23:35:15 +01:00
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MAXIMUM_PACKET_ID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MAXIMUM_PACKET_ID</h4>
<pre>public static final&nbsp;int MAXIMUM_PACKET_ID</pre>
<div class="block">The highest possible packet ID. It's unlikely that this value will ever change.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#com.comphenix.protocol.Packets.MAXIMUM_PACKET_ID">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
2012-10-17 08:07:20 +02:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Packets()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Packets</h4>
<pre>public&nbsp;Packets()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getServerRegistry()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getServerRegistry</h4>
<pre>public static&nbsp;<a href="../../../com/comphenix/protocol/Packets.Server.html" title="class in com.comphenix.protocol">Packets.Server</a>&nbsp;getServerRegistry()</pre>
<div class="block">A registry that parses between names and packet IDs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current client registry.</dd></dl>
</li>
</ul>
<a name="getClientRegistry()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getClientRegistry</h4>
<pre>public static&nbsp;<a href="../../../com/comphenix/protocol/Packets.Client.html" title="class in com.comphenix.protocol">Packets.Client</a>&nbsp;getClientRegistry()</pre>
<div class="block">A registry that parses between names and packet IDs.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The current server registry.</dd></dl>
</li>
</ul>
<a name="valueOf(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>valueOf</h4>
<pre>public static&nbsp;int&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
<div class="block">Find a packet by name. Must be capitalized and use underscores.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - name of packet to find.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The packet ID found.</dd></dl>
</li>
</ul>
<a name="getDeclaredName(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDeclaredName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getDeclaredName(int&nbsp;packetID)</pre>
<div class="block">Retrieves the name of a packet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>packetID</code> - - packet to retrieve name.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The name, or NULL if unable to find such a packet.</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/Packets.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/AsynchronousManager.html" title="interface in com.comphenix.protocol"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/comphenix/protocol/Packets.Client.html" title="class in com.comphenix.protocol"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/comphenix/protocol/Packets.html" target="_top">Frames</a></li>
<li><a href="Packets.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><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
2013-02-05 23:35:15 +01:00
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
2012-10-17 08:07:20 +02:00
<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>
2013-02-05 23:35:15 +01:00
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
2012-10-17 08:07:20 +02:00
<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>