Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-11-25 12:15:58 +01:00
Code Issues Projects Releases Wiki Activity
77c707923f
ProtocolLib/Javadoc/com/comphenix/protocol/injector/PacketConstructor.html
Kristian S. Stangeland 77c707923f Updating JavaDoc for 1.5.1
2012-11-04 03:50:58 +01:00

368 lines
16 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 Sun Nov 04 03:47:21 CET 2012 -->
<title>PacketConstructor</title>
<meta name="date" content="2012-11-04">
<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="PacketConstructor";
}
//-->
</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/PacketConstructor.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/injector/ListenerInvoker.html" title="interface in com.comphenix.protocol.injector"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/injector/PacketConstructor.html" target="_top">Frames</a></li>
<li><a href="PacketConstructor.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>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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.injector</div>
<h2 title="Class PacketConstructor" class="title">Class PacketConstructor</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.injector.PacketConstructor</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">PacketConstructor</span>
extends java.lang.Object</pre>
<div class="block">A packet constructor that uses an internal Minecraft.</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 interface&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector">PacketConstructor.Unwrapper</a></strong></code>
<div class="block">Represents a unwrapper for a constructor parameter.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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 <a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html" title="class in com.comphenix.protocol.injector">PacketConstructor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html#DEFAULT">DEFAULT</a></strong></code>
<div class="block">A packet constructor that automatically converts Bukkit types to their NMS conterpart.</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><a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html#createPacket(java.lang.Object...)">createPacket</a></strong>(java.lang.Object...&nbsp;values)</code>
<div class="block">Construct a packet using the special builtin Minecraft constructors.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html#getPacketID()">getPacketID</a></strong>()</code>
<div class="block">Retrieve the id of the packets this constructor creates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector">PacketConstructor.Unwrapper</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html#getUnwrappers()">getUnwrappers</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html" title="class in com.comphenix.protocol.injector">PacketConstructor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html#withPacket(int, java.lang.Object[])">withPacket</a></strong>(int&nbsp;id,
java.lang.Object[]&nbsp;values)</code>
<div class="block">Create a packet constructor that creates packets using the given types.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html" title="class in com.comphenix.protocol.injector">PacketConstructor</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html#withUnwrappers(java.util.List)">withUnwrappers</a></strong>(java.util.List&lt;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector">PacketConstructor.Unwrapper</a>&gt;&nbsp;unwrappers)</code>
<div class="block">Return a copy of the current constructor with a different list of unwrappers.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static&nbsp;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html" title="class in com.comphenix.protocol.injector">PacketConstructor</a> DEFAULT</pre>
<div class="block">A packet constructor that automatically converts Bukkit types to their NMS conterpart.
<p>
Remember to call withPacket().</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getUnwrappers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnwrappers</h4>
<pre>public&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector">PacketConstructor.Unwrapper</a>&gt;&nbsp;getUnwrappers()</pre>
</li>
</ul>
<a name="getPacketID()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPacketID</h4>
<pre>public&nbsp;int&nbsp;getPacketID()</pre>
<div class="block">Retrieve the id of the packets this constructor creates.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The ID of the packets this constructor will create.</dd></dl>
</li>
</ul>
<a name="withUnwrappers(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withUnwrappers</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html" title="class in com.comphenix.protocol.injector">PacketConstructor</a>&nbsp;withUnwrappers(java.util.List&lt;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector">PacketConstructor.Unwrapper</a>&gt;&nbsp;unwrappers)</pre>
<div class="block">Return a copy of the current constructor with a different list of unwrappers.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>unwrappers</code> - - list of unwrappers that convert Bukkit wrappers into the equivalent NMS classes.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A constructor with a different set of unwrappers.</dd></dl>
</li>
</ul>
<a name="withPacket(int, java.lang.Object[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPacket</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/injector/PacketConstructor.html" title="class in com.comphenix.protocol.injector">PacketConstructor</a>&nbsp;withPacket(int&nbsp;id,
java.lang.Object[]&nbsp;values)</pre>
<div class="block">Create a packet constructor that creates packets using the given types.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - - packet ID.</dd><dd><code>values</code> - - types to create.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A packet constructor with these types.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - If no packet constructor could be created with these types.</dd></dl>
</li>
</ul>
<a name="createPacket(java.lang.Object...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createPacket</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/events/PacketContainer.html" title="class in com.comphenix.protocol.events">PacketContainer</a>&nbsp;createPacket(java.lang.Object...&nbsp;values)
throws <a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></pre>
<div class="block">Construct a packet using the special builtin Minecraft constructors.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>values</code> - - values containing Bukkit wrapped items to pass to Minecraft.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The created packet.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../com/comphenix/protocol/reflect/FieldAccessException.html" title="class in com.comphenix.protocol.reflect">FieldAccessException</a></code> - Failure due to a security limitation.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - Arguments doesn't match the constructor.</dd>
<dd><code>java.lang.RuntimeException</code> - Minecraft threw an exception.</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/PacketConstructor.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/injector/ListenerInvoker.html" title="interface in com.comphenix.protocol.injector"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/injector/PacketConstructor.Unwrapper.html" title="interface in com.comphenix.protocol.injector"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/comphenix/protocol/injector/PacketConstructor.html" target="_top">Frames</a></li>
<li><a href="PacketConstructor.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>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&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