diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-06-17 08:12:18 +0300 |
| commit | dc3df3edd5843bde0c1335d6a8e460b2c832aa48 (patch) | |
| tree | af13bfeee567f2351e35e1ef176d168fe37c8aac /javadoc/net/minecraftforge/common/ForgeChunkManager.html | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/net/minecraftforge/common/ForgeChunkManager.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/ForgeChunkManager.html | 694 |
1 files changed, 694 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.html new file mode 100644 index 0000000..0550c95 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.html @@ -0,0 +1,694 @@ +<!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 (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 (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/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html" title="class 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.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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">net.minecraftforge.common</div> +<h2 title="Class ForgeChunkManager" class="title">Class ForgeChunkManager</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeChunkManager</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ForgeChunkManager</span> +extends java.lang.Object</pre> +<div class="block">Manages chunkloading for mods. + + The basic principle is a ticket based system. + 1. Mods register a callback <a href="../../../net/minecraftforge/common/ForgeChunkManager.html#setForcedChunkLoadingCallback(java.lang.Object,%20net.minecraftforge.common.ForgeChunkManager.LoadingCallback)"><code>setForcedChunkLoadingCallback(Object, LoadingCallback)</code></a> + 2. Mods ask for a ticket <a href="../../../net/minecraftforge/common/ForgeChunkManager.html#requestTicket(java.lang.Object,%20net.minecraft.world.World,%20net.minecraftforge.common.ForgeChunkManager.Type)"><code>requestTicket(Object, World, Type)</code></a> and then hold on to that ticket. + 3. Mods request chunks to stay loaded <a href="../../../net/minecraftforge/common/ForgeChunkManager.html#forceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)"><code>forceChunk(Ticket, ChunkCoordIntPair)</code></a> or remove chunks from force loading <a href="../../../net/minecraftforge/common/ForgeChunkManager.html#unforceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)"><code>unforceChunk(Ticket, ChunkCoordIntPair)</code></a>. + 4. When a world unloads, the tickets associated with that world are saved by the chunk manager. + 5. When a world loads, saved tickets are offered to the mods associated with the tickets. The <a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#getModData()"><code>ForgeChunkManager.Ticket.getModData()</code></a> that is set by the mod should be used to re-register + chunks to stay loaded (and maybe take other actions). + + The chunkloading is configurable at runtime. The file "config/forgeChunkLoading.cfg" contains both default configuration for chunkloading, and a sample individual mod + specific override section.</div> +</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"> </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 class </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html" title="class in net.minecraftforge.common">ForgeChunkManager.ForceChunkEvent</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a></strong></code> +<div class="block">All mods requiring chunkloading need to implement this to handle the + re-registration of chunk tickets at world loading time</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.OrderedLoadingCallback</a></strong></code> +<div class="block">This is a special LoadingCallback that can be implemented as well as the + LoadingCallback to provide access to additional behaviour.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.PlayerOrderedLoadingCallback</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html" title="class in net.minecraftforge.common">ForgeChunkManager.UnforceChunkEvent</a></strong></code> </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"> </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 java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#MOD_PROP_ORDER">MOD_PROP_ORDER</a></strong></code> </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"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#ForgeChunkManager()">ForgeChunkManager</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 void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#addConfigProperty(java.lang.Object,%20java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type)">addConfigProperty</a></strong>(java.lang.Object mod, + java.lang.String propertyName, + java.lang.String value, + <a href="../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/world/chunk/Chunk.html" title="class in net.minecraft.world.chunk">Chunk</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#fetchDormantChunk(long,%20net.minecraft.world.World)">fetchDormantChunk</a></strong>(long coords, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#forceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)">forceChunk</a></strong>(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket, + <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> chunk)</code> +<div class="block">Force the supplied chunk coordinate to be loaded by the supplied ticket.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#getConfig()">getConfig</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#getConfigFor(java.lang.Object)">getConfigFor</a></strong>(java.lang.Object mod)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#getDefaultsCategory()">getDefaultsCategory</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#getMaxChunkDepthFor(java.lang.String)">getMaxChunkDepthFor</a></strong>(java.lang.String modId)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#getMaxTicketLengthFor(java.lang.String)">getMaxTicketLengthFor</a></strong>(java.lang.String modId)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.List<<a href="../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#getModCategories()">getModCategories</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static com.google.common.collect.ImmutableSetMultimap<<a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>,<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.html#getPersistentChunksFor(net.minecraft.world.World)">getPersistentChunksFor</a></strong>(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</code> +<div class="block">The list of persistent chunks in the world.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#putDormantChunk(long,%20net.minecraft.world.chunk.Chunk)">putDormantChunk</a></strong>(long coords, + <a href="../../../net/minecraft/world/chunk/Chunk.html" title="class in net.minecraft.world.chunk">Chunk</a> chunk)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#releaseTicket(net.minecraftforge.common.ForgeChunkManager.Ticket)">releaseTicket</a></strong>(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket)</code> +<div class="block">Release the ticket back to the system.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#reorderChunk(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)">reorderChunk</a></strong>(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket, + <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> chunk)</code> +<div class="block">Reorganize the internal chunk list so that the chunk supplied is at the *end* of the list + This helps if you wish to guarantee a certain "automatic unload ordering" for the chunks + in the ticket list</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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.html#requestPlayerTicket(java.lang.Object,%20java.lang.String,%20net.minecraft.world.World,%20net.minecraftforge.common.ForgeChunkManager.Type)">requestPlayerTicket</a></strong>(java.lang.Object mod, + java.lang.String player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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.html#requestTicket(java.lang.Object,%20net.minecraft.world.World,%20net.minecraftforge.common.ForgeChunkManager.Type)">requestTicket</a></strong>(java.lang.Object mod, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> type)</code> +<div class="block">Request a chunkloading ticket of the appropriate type for the supplied mod</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#savedWorldHasForcedChunkTickets(java.io.File)">savedWorldHasForcedChunkTickets</a></strong>(java.io.File chunkDir)</code> +<div class="block">Allows dynamically loading world mods to test if there are chunk tickets in the world + Mods that add dynamically generated worlds (like Mystcraft) should call this method + to determine if the world should be loaded during server starting.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#setForcedChunkLoadingCallback(java.lang.Object,%20net.minecraftforge.common.ForgeChunkManager.LoadingCallback)">setForcedChunkLoadingCallback</a></strong>(java.lang.Object mod, + <a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a> callback)</code> +<div class="block">Set a chunkloading callback for the supplied mod object</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#syncConfigDefaults()">syncConfigDefaults</a></strong>()</code> +<div class="block">Synchronizes the local fields with the values in the Configuration object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#ticketCountAvailableFor(java.lang.Object,%20net.minecraft.world.World)">ticketCountAvailableFor</a></strong>(java.lang.Object mod, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</code> +<div class="block">Discover the available tickets for the mod in the world</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#ticketCountAvailableFor(java.lang.String)">ticketCountAvailableFor</a></strong>(java.lang.String username)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.html#unforceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)">unforceChunk</a></strong>(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket, + <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> chunk)</code> +<div class="block">Unforce the supplied chunk, allowing it to be unloaded and stop ticking.</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="MOD_PROP_ORDER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MOD_PROP_ORDER</h4> +<pre>public static final java.util.List<java.lang.String> MOD_PROP_ORDER</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ForgeChunkManager()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeChunkManager</h4> +<pre>public ForgeChunkManager()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="savedWorldHasForcedChunkTickets(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>savedWorldHasForcedChunkTickets</h4> +<pre>public static boolean savedWorldHasForcedChunkTickets(java.io.File chunkDir)</pre> +<div class="block">Allows dynamically loading world mods to test if there are chunk tickets in the world + Mods that add dynamically generated worlds (like Mystcraft) should call this method + to determine if the world should be loaded during server starting.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>chunkDir</code> - The chunk directory to test: should be equivalent to <a href="../../../net/minecraft/world/WorldServer.html#getChunkSaveLocation()"><code>WorldServer.getChunkSaveLocation()</code></a></dd> +<dt><span class="strong">Returns:</span></dt><dd>if there are tickets outstanding for this world or not</dd></dl> +</li> +</ul> +<a name="setForcedChunkLoadingCallback(java.lang.Object, net.minecraftforge.common.ForgeChunkManager.LoadingCallback)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForcedChunkLoadingCallback</h4> +<pre>public static void setForcedChunkLoadingCallback(java.lang.Object mod, + <a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a> callback)</pre> +<div class="block">Set a chunkloading callback for the supplied mod object</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mod</code> - The mod instance registering the callback</dd><dd><code>callback</code> - The code to call back when forced chunks are loaded</dd></dl> +</li> +</ul> +<a name="ticketCountAvailableFor(java.lang.Object, net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ticketCountAvailableFor</h4> +<pre>public static int ticketCountAvailableFor(java.lang.Object mod, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</pre> +<div class="block">Discover the available tickets for the mod in the world</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mod</code> - The mod that will own the tickets</dd><dd><code>world</code> - The world</dd> +<dt><span class="strong">Returns:</span></dt><dd>The count of tickets left for the mod in the supplied world</dd></dl> +</li> +</ul> +<a name="getMaxTicketLengthFor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxTicketLengthFor</h4> +<pre>public static int getMaxTicketLengthFor(java.lang.String modId)</pre> +</li> +</ul> +<a name="getMaxChunkDepthFor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxChunkDepthFor</h4> +<pre>public static int getMaxChunkDepthFor(java.lang.String modId)</pre> +</li> +</ul> +<a name="ticketCountAvailableFor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ticketCountAvailableFor</h4> +<pre>public static int ticketCountAvailableFor(java.lang.String username)</pre> +</li> +</ul> +<a name="requestPlayerTicket(java.lang.Object, java.lang.String, net.minecraft.world.World, net.minecraftforge.common.ForgeChunkManager.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requestPlayerTicket</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> requestPlayerTicket(java.lang.Object mod, + java.lang.String player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> type)</pre> +</li> +</ul> +<a name="requestTicket(java.lang.Object, net.minecraft.world.World, net.minecraftforge.common.ForgeChunkManager.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requestTicket</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> requestTicket(java.lang.Object mod, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> type)</pre> +<div class="block">Request a chunkloading ticket of the appropriate type for the supplied mod</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mod</code> - The mod requesting a ticket</dd><dd><code>world</code> - The world in which it is requesting the ticket</dd><dd><code>type</code> - The type of ticket</dd> +<dt><span class="strong">Returns:</span></dt><dd>A ticket with which to register chunks for loading, or null if no further tickets are available</dd></dl> +</li> +</ul> +<a name="releaseTicket(net.minecraftforge.common.ForgeChunkManager.Ticket)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>releaseTicket</h4> +<pre>public static void releaseTicket(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket)</pre> +<div class="block">Release the ticket back to the system. This will also unforce any chunks held by the ticket so that they can be unloaded and/or stop ticking.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ticket</code> - The ticket to release</dd></dl> +</li> +</ul> +<a name="forceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket, net.minecraft.world.ChunkCoordIntPair)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forceChunk</h4> +<pre>public static void forceChunk(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket, + <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> chunk)</pre> +<div class="block">Force the supplied chunk coordinate to be loaded by the supplied ticket. If the ticket's <a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html#maxDepth"><code>ForgeChunkManager.Ticket.maxDepth</code></a> is exceeded, the least + recently registered chunk is unforced and may be unloaded. + It is safe to force the chunk several times for a ticket, it will not generate duplication or change the ordering.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ticket</code> - The ticket registering the chunk</dd><dd><code>chunk</code> - The chunk to force</dd></dl> +</li> +</ul> +<a name="reorderChunk(net.minecraftforge.common.ForgeChunkManager.Ticket, net.minecraft.world.ChunkCoordIntPair)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reorderChunk</h4> +<pre>public static void reorderChunk(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket, + <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> chunk)</pre> +<div class="block">Reorganize the internal chunk list so that the chunk supplied is at the *end* of the list + This helps if you wish to guarantee a certain "automatic unload ordering" for the chunks + in the ticket list</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ticket</code> - The ticket holding the chunk list</dd><dd><code>chunk</code> - The chunk you wish to push to the end (so that it would be unloaded last)</dd></dl> +</li> +</ul> +<a name="unforceChunk(net.minecraftforge.common.ForgeChunkManager.Ticket, net.minecraft.world.ChunkCoordIntPair)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unforceChunk</h4> +<pre>public static void unforceChunk(<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket, + <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> chunk)</pre> +<div class="block">Unforce the supplied chunk, allowing it to be unloaded and stop ticking.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ticket</code> - The ticket holding the chunk</dd><dd><code>chunk</code> - The chunk to unforce</dd></dl> +</li> +</ul> +<a name="getPersistentChunksFor(net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPersistentChunksFor</h4> +<pre>public static com.google.common.collect.ImmutableSetMultimap<<a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>,<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a>> getPersistentChunksFor(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</pre> +<div class="block">The list of persistent chunks in the world. This set is immutable.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>world</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>the list of persistent chunks in the world</dd></dl> +</li> +</ul> +<a name="putDormantChunk(long, net.minecraft.world.chunk.Chunk)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putDormantChunk</h4> +<pre>public static void putDormantChunk(long coords, + <a href="../../../net/minecraft/world/chunk/Chunk.html" title="class in net.minecraft.world.chunk">Chunk</a> chunk)</pre> +</li> +</ul> +<a name="fetchDormantChunk(long, net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fetchDormantChunk</h4> +<pre>public static <a href="../../../net/minecraft/world/chunk/Chunk.html" title="class in net.minecraft.world.chunk">Chunk</a> fetchDormantChunk(long coords, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</pre> +</li> +</ul> +<a name="syncConfigDefaults()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>syncConfigDefaults</h4> +<pre>public static void syncConfigDefaults()</pre> +<div class="block">Synchronizes the local fields with the values in the Configuration object.</div> +</li> +</ul> +<a name="getConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfig</h4> +<pre>public static <a href="../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> getConfig()</pre> +</li> +</ul> +<a name="getDefaultsCategory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultsCategory</h4> +<pre>public static <a href="../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> getDefaultsCategory()</pre> +</li> +</ul> +<a name="getModCategories()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getModCategories</h4> +<pre>public static java.util.List<<a href="../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a>> getModCategories()</pre> +</li> +</ul> +<a name="getConfigFor(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigFor</h4> +<pre>public static <a href="../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> getConfigFor(java.lang.Object mod)</pre> +</li> +</ul> +<a name="addConfigProperty(java.lang.Object, java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>addConfigProperty</h4> +<pre>public static void addConfigProperty(java.lang.Object mod, + java.lang.String propertyName, + java.lang.String value, + <a href="../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</pre> +</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/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html" title="class 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.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> |