mirror of
https://github.com/dmulloy2/ProtocolLib.git
synced 2024-12-01 07:03:41 +01:00
366 lines
17 KiB
HTML
366 lines
17 KiB
HTML
<!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 Dec 27 17:42:38 CET 2012 -->
|
|
<title>BukkitConverters</title>
|
|
<meta name="date" content="2012-12-27">
|
|
<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="BukkitConverters";
|
|
}
|
|
//-->
|
|
</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/BukkitConverters.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>Prev Class</li>
|
|
<li><a href="../../../../com/comphenix/protocol/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/wrappers/BukkitConverters.html" target="_top">Frames</a></li>
|
|
<li><a href="BukkitConverters.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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </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.wrappers</div>
|
|
<h2 title="Class BukkitConverters" class="title">Class BukkitConverters</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.comphenix.protocol.wrappers.BukkitConverters</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">BukkitConverters</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">Contains several useful equivalent converters for normal Bukkit types.</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">
|
|
<!-- ======== 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"> </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/wrappers/BukkitConverters.html#BukkitConverters()">BukkitConverters</a></strong>()</code> </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"> </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/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><<a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html" title="class in com.comphenix.protocol.wrappers">WrappedDataWatcher</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getDataWatcherConverter()">getDataWatcherConverter</a></strong>()</code>
|
|
<div class="block">Retrieve a converter for the NMS DataWatcher class and our wrapper.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><org.bukkit.entity.Entity></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getEntityConverter(org.bukkit.World)">getEntityConverter</a></strong>(org.bukkit.World world)</code>
|
|
<div class="block">Retrieve a converter for NMS entities and Bukkit entities.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <TType> <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><TType></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getIgnoreNull(com.comphenix.protocol.reflect.EquivalentConverter)">getIgnoreNull</a></strong>(<a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><TType> delegate)</code>
|
|
<div class="block">Wraps a given equivalent converter in NULL checks, ensuring that such values are ignored.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><org.bukkit.inventory.ItemStack></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getItemStackConverter()">getItemStackConverter</a></strong>()</code>
|
|
<div class="block">Retrieve the converter used to convert NMS ItemStacks to Bukkit's ItemStack.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <T> <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><java.util.List<T>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getListConverter(java.lang.Class, com.comphenix.protocol.reflect.EquivalentConverter)">getListConverter</a></strong>(java.lang.Class<?> genericItemType,
|
|
<a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><T> itemConverter)</code> </td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getWatchableObjectConverter()">getWatchableObjectConverter</a></strong>()</code>
|
|
<div class="block">Retrieve a converter for watchable objects and the respective wrapper.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><org.bukkit.WorldType></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/BukkitConverters.html#getWorldTypeConverter()">getWorldTypeConverter</a></strong>()</code>
|
|
<div class="block">Retrieve a converter for Bukkit's world type enum and the NMS equivalent.</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 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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="BukkitConverters()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>BukkitConverters</h4>
|
|
<pre>public BukkitConverters()</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getListConverter(java.lang.Class, com.comphenix.protocol.reflect.EquivalentConverter)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getListConverter</h4>
|
|
<pre>public static <T> <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><java.util.List<T>> getListConverter(java.lang.Class<?> genericItemType,
|
|
<a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><T> itemConverter)</pre>
|
|
</li>
|
|
</ul>
|
|
<a name="getWatchableObjectConverter()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getWatchableObjectConverter</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><<a href="../../../../com/comphenix/protocol/wrappers/WrappedWatchableObject.html" title="class in com.comphenix.protocol.wrappers">WrappedWatchableObject</a>> getWatchableObjectConverter()</pre>
|
|
<div class="block">Retrieve a converter for watchable objects and the respective wrapper.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>A watchable object converter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDataWatcherConverter()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDataWatcherConverter</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><<a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.html" title="class in com.comphenix.protocol.wrappers">WrappedDataWatcher</a>> getDataWatcherConverter()</pre>
|
|
<div class="block">Retrieve a converter for the NMS DataWatcher class and our wrapper.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>A DataWatcher converter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getWorldTypeConverter()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getWorldTypeConverter</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><org.bukkit.WorldType> getWorldTypeConverter()</pre>
|
|
<div class="block">Retrieve a converter for Bukkit's world type enum and the NMS equivalent.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>A world type enum converter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEntityConverter(org.bukkit.World)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEntityConverter</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><org.bukkit.entity.Entity> getEntityConverter(org.bukkit.World world)</pre>
|
|
<div class="block">Retrieve a converter for NMS entities and Bukkit entities.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>world</code> - - the current world.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>A converter between the underlying NMS entity and Bukkit's wrapper.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getItemStackConverter()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getItemStackConverter</h4>
|
|
<pre>public static <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><org.bukkit.inventory.ItemStack> getItemStackConverter()</pre>
|
|
<div class="block">Retrieve the converter used to convert NMS ItemStacks to Bukkit's ItemStack.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Item stack converter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getIgnoreNull(com.comphenix.protocol.reflect.EquivalentConverter)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getIgnoreNull</h4>
|
|
<pre>public static <TType> <a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><TType> getIgnoreNull(<a href="../../../../com/comphenix/protocol/reflect/EquivalentConverter.html" title="interface in com.comphenix.protocol.reflect">EquivalentConverter</a><TType> delegate)</pre>
|
|
<div class="block">Wraps a given equivalent converter in NULL checks, ensuring that such values are ignored.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>delegate</code> - - the underlying equivalent converter.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>A equivalent converter that ignores NULL values.</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/BukkitConverters.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>Prev Class</li>
|
|
<li><a href="../../../../com/comphenix/protocol/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?com/comphenix/protocol/wrappers/BukkitConverters.html" target="_top">Frames</a></li>
|
|
<li><a href="BukkitConverters.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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|