Upstream/ProtocolLib
1
0
Fork 0
mirror of https://github.com/dmulloy2/ProtocolLib.git synced 2024-12-01 23:23:34 +01:00
Code Issues Projects Releases Wiki Activity
1d1f96cda4
ProtocolLib/Javadoc/com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html
Kristian S. Stangeland 2a86a4cbc5 Updated documentation to 1.6.0
2012-11-13 17:54:42 +01:00

526 lines
20 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 Tue Nov 13 17:51:10 CET 2012 -->
<title>WrappedChunkCoordinate</title>
<meta name="date" content="2012-11-13">
<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="WrappedChunkCoordinate";
}
//-->
</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/WrappedChunkCoordinate.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/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.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/WrappedChunkCoordinate.html" target="_top">Frames</a></li>
<li><a href="WrappedChunkCoordinate.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.wrappers</div>
<h2 title="Class WrappedChunkCoordinate" class="title">Class WrappedChunkCoordinate</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.comphenix.protocol.wrappers.WrappedChunkCoordinate</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Comparable&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">WrappedChunkCoordinate</span>
extends java.lang.Object
implements java.lang.Comparable&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a>&gt;</pre>
<div class="block">Allows access to a chunk coordinate.</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 net.minecraft.server.ChunkCoordinates</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#handle">handle</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/wrappers/WrappedChunkCoordinate.html#WrappedChunkCoordinate()">WrappedChunkCoordinate</a></strong>()</code>
<div class="block">Create a new empty wrapper.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#WrappedChunkCoordinate(net.minecraft.server.ChunkCoordinates)">WrappedChunkCoordinate</a></strong>(net.minecraft.server.ChunkCoordinates&nbsp;handle)</code>
<div class="block">Create a wrapper for a specific chunk coordinates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#WrappedChunkCoordinate(com.comphenix.protocol.wrappers.ChunkPosition)">WrappedChunkCoordinate</a></strong>(<a href="../../../../com/comphenix/protocol/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers">ChunkPosition</a>&nbsp;position)</code>
<div class="block">Create a chunk coordinate wrapper from a given position.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#WrappedChunkCoordinate(int, int, int)">WrappedChunkCoordinate</a></strong>(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</code>
<div class="block">Create a wrapper with specific values.</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#compareTo(com.comphenix.protocol.wrappers.WrappedChunkCoordinate)">compareTo</a></strong>(<a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a>&nbsp;other)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object&nbsp;other)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>net.minecraft.server.ChunkCoordinates</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#getHandle()">getHandle</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#getX()">getX</a></strong>()</code>
<div class="block">Retrieve the x coordinate of the underlying coordiate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#getY()">getY</a></strong>()</code>
<div class="block">Retrieve the y coordinate of the underlying coordiate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#getZ()">getZ</a></strong>()</code>
<div class="block">Retrieve the z coordinate of the underlying coordiate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#hashCode()">hashCode</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#setX(int)">setX</a></strong>(int&nbsp;newX)</code>
<div class="block">Set the x coordinate of the underlying coordiate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#setY(int)">setY</a></strong>(int&nbsp;newY)</code>
<div class="block">Set the y coordinate of the underlying coordiate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#setZ(int)">setZ</a></strong>(int&nbsp;newZ)</code>
<div class="block">Set the z coordinate of the underlying coordiate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/comphenix/protocol/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers">ChunkPosition</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html#toPosition()">toPosition</a></strong>()</code>
<div class="block">Create an immutable chunk position from this coordinate.</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, finalize, getClass, 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="handle">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>handle</h4>
<pre>protected&nbsp;net.minecraft.server.ChunkCoordinates handle</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WrappedChunkCoordinate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WrappedChunkCoordinate</h4>
<pre>public&nbsp;WrappedChunkCoordinate()</pre>
<div class="block">Create a new empty wrapper.</div>
</li>
</ul>
<a name="WrappedChunkCoordinate(net.minecraft.server.ChunkCoordinates)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WrappedChunkCoordinate</h4>
<pre>public&nbsp;WrappedChunkCoordinate(net.minecraft.server.ChunkCoordinates&nbsp;handle)</pre>
<div class="block">Create a wrapper for a specific chunk coordinates.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handle</code> - - the NMS chunk coordinates.</dd></dl>
</li>
</ul>
<a name="WrappedChunkCoordinate(int, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WrappedChunkCoordinate</h4>
<pre>public&nbsp;WrappedChunkCoordinate(int&nbsp;x,
int&nbsp;y,
int&nbsp;z)</pre>
<div class="block">Create a wrapper with specific values.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - - the x coordinate.</dd><dd><code>y</code> - - the y coordinate.</dd><dd><code>z</code> - - the z coordinate.</dd></dl>
</li>
</ul>
<a name="WrappedChunkCoordinate(com.comphenix.protocol.wrappers.ChunkPosition)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WrappedChunkCoordinate</h4>
<pre>public&nbsp;WrappedChunkCoordinate(<a href="../../../../com/comphenix/protocol/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers">ChunkPosition</a>&nbsp;position)</pre>
<div class="block">Create a chunk coordinate wrapper from a given position.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>position</code> - - the given position.</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="getHandle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHandle</h4>
<pre>public&nbsp;net.minecraft.server.ChunkCoordinates&nbsp;getHandle()</pre>
</li>
</ul>
<a name="getX()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getX</h4>
<pre>public&nbsp;int&nbsp;getX()</pre>
<div class="block">Retrieve the x coordinate of the underlying coordiate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The x coordinate.</dd></dl>
</li>
</ul>
<a name="setX(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setX</h4>
<pre>public&nbsp;void&nbsp;setX(int&nbsp;newX)</pre>
<div class="block">Set the x coordinate of the underlying coordiate.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newX</code> - - the new x coordinate.</dd></dl>
</li>
</ul>
<a name="getY()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getY</h4>
<pre>public&nbsp;int&nbsp;getY()</pre>
<div class="block">Retrieve the y coordinate of the underlying coordiate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The y coordinate.</dd></dl>
</li>
</ul>
<a name="setY(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setY</h4>
<pre>public&nbsp;void&nbsp;setY(int&nbsp;newY)</pre>
<div class="block">Set the y coordinate of the underlying coordiate.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newY</code> - - the new y coordinate.</dd></dl>
</li>
</ul>
<a name="getZ()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getZ</h4>
<pre>public&nbsp;int&nbsp;getZ()</pre>
<div class="block">Retrieve the z coordinate of the underlying coordiate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The z coordinate.</dd></dl>
</li>
</ul>
<a name="toPosition()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPosition</h4>
<pre>public&nbsp;<a href="../../../../com/comphenix/protocol/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers">ChunkPosition</a>&nbsp;toPosition()</pre>
<div class="block">Create an immutable chunk position from this coordinate.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The new immutable chunk position.</dd></dl>
</li>
</ul>
<a name="setZ(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setZ</h4>
<pre>public&nbsp;void&nbsp;setZ(int&nbsp;newZ)</pre>
<div class="block">Set the z coordinate of the underlying coordiate.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newZ</code> - - the new z coordinate.</dd></dl>
</li>
</ul>
<a name="compareTo(com.comphenix.protocol.wrappers.WrappedChunkCoordinate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public&nbsp;int&nbsp;compareTo(<a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a>&nbsp;other)</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>compareTo</code>&nbsp;in interface&nbsp;<code>java.lang.Comparable&lt;<a href="../../../../com/comphenix/protocol/wrappers/WrappedChunkCoordinate.html" title="class in com.comphenix.protocol.wrappers">WrappedChunkCoordinate</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;other)</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="hashCode()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>hashCode</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/WrappedChunkCoordinate.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/wrappers/ChunkPosition.html" title="class in com.comphenix.protocol.wrappers"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../com/comphenix/protocol/wrappers/WrappedDataWatcher.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/WrappedChunkCoordinate.html" target="_top">Frames</a></li>
<li><a href="WrappedChunkCoordinate.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