diff options
Diffstat (limited to 'javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html | 435 |
1 files changed, 435 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html new file mode 100644 index 0000000..181e4eb --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html @@ -0,0 +1,435 @@ +<!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_65) on Thu Feb 05 20:10:17 EST 2015 --> +<title>ForgeChunkManager.Ticket (Forge API)</title> +<meta name="date" content="2015-02-05"> +<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="ForgeChunkManager.Ticket (Forge API)"; + } +//--> +</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="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/ForgeChunkManager.Ticket.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.Ticket.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </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">net.minecraftforge.common</div> +<h2 title="Class ForgeChunkManager.Ticket" class="title">Class ForgeChunkManager.Ticket</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeChunkManager.Ticket</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/ForgeChunkManager.html" title="class in net.minecraftforge.common">ForgeChunkManager</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ForgeChunkManager.Ticket</span> +extends java.lang.Object</pre> +</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"> </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><a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#world">world</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#bindEntity(net.minecraft.entity.Entity)">bindEntity</a></strong>(<a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> entity)</code> +<div class="block">Bind the entity to the ticket for <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html#ENTITY"><code>ForgeChunkManager.Type.ENTITY</code></a> type tickets.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>com.google.common.collect.ImmutableSet<<a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getChunkList()">getChunkList</a></strong>()</code> +<div class="block">Gets a list of requested chunks for this ticket.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getChunkListDepth()">getChunkListDepth</a></strong>()</code> +<div class="block">Gets the current max depth for this ticket.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getEntity()">getEntity</a></strong>()</code> +<div class="block">Get the entity associated with this <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html#ENTITY"><code>ForgeChunkManager.Type.ENTITY</code></a> type ticket</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getMaxChunkListDepth()">getMaxChunkListDepth</a></strong>()</code> +<div class="block">Get the maximum chunk depth size</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getModData()">getModData</a></strong>()</code> +<div class="block">Retrieve the <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt"><code>NBTTagCompound</code></a> that stores mod specific data for the chunk ticket.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getModId()">getModId</a></strong>()</code> +<div class="block">Get the associated mod id</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getPlayerName()">getPlayerName</a></strong>()</code> +<div class="block">Get the player associated with this ticket</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getType()">getType</a></strong>()</code> +<div class="block">Gets the ticket type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#isPlayerTicket()">isPlayerTicket</a></strong>()</code> +<div class="block">Is this a player associated ticket rather than a mod associated ticket?</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#setChunkListDepth(int)">setChunkListDepth</a></strong>(int depth)</code> +<div class="block">The chunk list depth can be manipulated up to the maximal grant allowed for the mod.</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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="world"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>world</h4> +<pre>public final <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setChunkListDepth(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setChunkListDepth</h4> +<pre>public void setChunkListDepth(int depth)</pre> +<div class="block">The chunk list depth can be manipulated up to the maximal grant allowed for the mod. This value is configurable. Once the maximum is reached, + the least recently forced chunk, by original registration time, is removed from the forced chunk list.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>depth</code> - The new depth to set</dd></dl> +</li> +</ul> +<a name="getChunkListDepth()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChunkListDepth</h4> +<pre>public int getChunkListDepth()</pre> +<div class="block">Gets the current max depth for this ticket. + Should be the same as getMaxChunkListDepth() + unless setChunkListDepth has been called.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Current max depth</dd></dl> +</li> +</ul> +<a name="getMaxChunkListDepth()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxChunkListDepth</h4> +<pre>public int getMaxChunkListDepth()</pre> +<div class="block">Get the maximum chunk depth size</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The maximum chunk depth size</dd></dl> +</li> +</ul> +<a name="bindEntity(net.minecraft.entity.Entity)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bindEntity</h4> +<pre>public void bindEntity(<a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> entity)</pre> +<div class="block">Bind the entity to the ticket for <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html#ENTITY"><code>ForgeChunkManager.Type.ENTITY</code></a> type tickets. Other types will throw a runtime exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - The entity to bind</dd></dl> +</li> +</ul> +<a name="getModData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getModData</h4> +<pre>public <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> getModData()</pre> +<div class="block">Retrieve the <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt"><code>NBTTagCompound</code></a> that stores mod specific data for the chunk ticket. + Example data to store would be a TileEntity or Block location. This is persisted with the ticket and + provided to the <a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common"><code>ForgeChunkManager.LoadingCallback</code></a> for the mod. It is recommended to use this to recover + useful state information for the forced chunks.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The custom compound tag for mods to store additional chunkloading data</dd></dl> +</li> +</ul> +<a name="getEntity()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEntity</h4> +<pre>public <a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> getEntity()</pre> +<div class="block">Get the entity associated with this <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html#ENTITY"><code>ForgeChunkManager.Type.ENTITY</code></a> type ticket</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the entity</dd></dl> +</li> +</ul> +<a name="isPlayerTicket()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPlayerTicket</h4> +<pre>public boolean isPlayerTicket()</pre> +<div class="block">Is this a player associated ticket rather than a mod associated ticket?</div> +</li> +</ul> +<a name="getPlayerName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPlayerName</h4> +<pre>public java.lang.String getPlayerName()</pre> +<div class="block">Get the player associated with this ticket</div> +</li> +</ul> +<a name="getModId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getModId</h4> +<pre>public java.lang.String getModId()</pre> +<div class="block">Get the associated mod id</div> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> getType()</pre> +<div class="block">Gets the ticket type</div> +</li> +</ul> +<a name="getChunkList()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getChunkList</h4> +<pre>public com.google.common.collect.ImmutableSet<<a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>> getChunkList()</pre> +<div class="block">Gets a list of requested chunks for this ticket.</div> +</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="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/ForgeChunkManager.Ticket.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.Ticket.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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |