diff options
Diffstat (limited to 'javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html | 244 |
1 files changed, 244 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html new file mode 100644 index 0000000..9a4eff4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html @@ -0,0 +1,244 @@ +<!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.OrderedLoadingCallback (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.OrderedLoadingCallback (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.LoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface 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.OrderedLoadingCallback.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.OrderedLoadingCallback.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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="Interface ForgeChunkManager.OrderedLoadingCallback" class="title">Interface ForgeChunkManager.OrderedLoadingCallback</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a></dd> +</dl> +<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 interface <span class="strong">ForgeChunkManager.OrderedLoadingCallback</span> +extends <a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a></pre> +<div class="block">This is a special LoadingCallback that can be implemented as well as the + LoadingCallback to provide access to additional behaviour. + Specifically, this callback will fire prior to Forge dropping excess + tickets. Tickets in the returned list are presumed ordered and excess will + be truncated from the returned list. + This allows the mod to control not only if they actually <em>want</em> a ticket but + also their preferred ticket ordering.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>java.util.List<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html#ticketsLoaded(java.util.List,%20net.minecraft.world.World,%20int)">ticketsLoaded</a></strong>(java.util.List<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a>> tickets, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int maxTicketCount)</code> +<div class="block">Called back when tickets are loaded from the world to allow the + mod to decide if it wants the ticket still, and prioritise overflow + based on the ticket count.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_net.minecraftforge.common.ForgeChunkManager.LoadingCallback"> +<!-- --> +</a> +<h3>Methods inherited from interface net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a></h3> +<code><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html#ticketsLoaded(java.util.List,%20net.minecraft.world.World)">ticketsLoaded</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="ticketsLoaded(java.util.List, net.minecraft.world.World, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ticketsLoaded</h4> +<pre>java.util.List<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a>> ticketsLoaded(java.util.List<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a>> tickets, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int maxTicketCount)</pre> +<div class="block">Called back when tickets are loaded from the world to allow the + mod to decide if it wants the ticket still, and prioritise overflow + based on the ticket count. + WARNING: You cannot force chunks in this callback, it is strictly for allowing the mod + to be more selective in which tickets it wishes to preserve in an overflow situation</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tickets</code> - The tickets that you will want to select from. The list is immutable and cannot be manipulated directly. Copy it first.</dd><dd><code>world</code> - The world</dd><dd><code>maxTicketCount</code> - The maximum number of tickets that will be allowed.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A list of the tickets this mod wishes to continue using. This list will be truncated + to "maxTicketCount" size after the call returns and then offered to the other callback + method</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="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.LoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface 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.OrderedLoadingCallback.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.OrderedLoadingCallback.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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> |