diff options
Diffstat (limited to 'javadoc/net/minecraftforge/common/BiomeDictionary.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/BiomeDictionary.html | 442 |
1 files changed, 442 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/BiomeDictionary.html b/javadoc/net/minecraftforge/common/BiomeDictionary.html new file mode 100644 index 0000000..9fdfc67 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeDictionary.html @@ -0,0 +1,442 @@ +<!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>BiomeDictionary (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="BiomeDictionary (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/AchievementPage.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeDictionary.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/BiomeDictionary.html" target="_top">Frames</a></li> +<li><a href="BiomeDictionary.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>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">net.minecraftforge.common</div> +<h2 title="Class BiomeDictionary" class="title">Class BiomeDictionary</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.BiomeDictionary</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">BiomeDictionary</span> +extends java.lang.Object</pre> +</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/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</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/BiomeDictionary.html#BiomeDictionary()">BiomeDictionary</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 boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#areBiomesEquivalent(net.minecraft.world.biome.BiomeGenBase,%20net.minecraft.world.biome.BiomeGenBase)">areBiomesEquivalent</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biomeA, + <a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biomeB)</code> +<div class="block">Checks to see if two biomes are registered as having the same type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#getBiomesForType(net.minecraftforge.common.BiomeDictionary.Type)">getBiomesForType</a></strong>(<a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> type)</code> +<div class="block">Returns a list of biomes registered with a specific type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#getTypesForBiome(net.minecraft.world.biome.BiomeGenBase)">getTypesForBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> +<div class="block">Gets a list of Types that a specific biome is registered with</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#isBiomeOfType(net.minecraft.world.biome.BiomeGenBase,%20net.minecraftforge.common.BiomeDictionary.Type)">isBiomeOfType</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> type)</code> +<div class="block">Checks to see if the given biome is registered as being a specific type</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#isBiomeRegistered(net.minecraft.world.biome.BiomeGenBase)">isBiomeRegistered</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> +<div class="block">Checks to see if the given biome has been registered as being of any type</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#isBiomeRegistered(int)">isBiomeRegistered</a></strong>(int biomeID)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#makeBestGuess(net.minecraft.world.biome.BiomeGenBase)">makeBestGuess</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> +<div class="block">Automatically looks for and registers a given biome with appropriate tags + This method is called automatically if a biome has not been registered with any tags, + And another method requests information about it</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#registerAllBiomes()">registerAllBiomes</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#registerAllBiomesAndGenerateEvents()">registerAllBiomesAndGenerateEvents</a></strong>()</code> +<div class="block">Loops through the biome list and automatically adds tags to any biome that does not have any + This is called by Forge at postinit time.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.html#registerBiomeType(net.minecraft.world.biome.BiomeGenBase,%20net.minecraftforge.common.BiomeDictionary.Type...)">registerBiomeType</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>... types)</code> +<div class="block">Registers a biome with a specific biome type</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="BiomeDictionary()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BiomeDictionary</h4> +<pre>public BiomeDictionary()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="registerBiomeType(net.minecraft.world.biome.BiomeGenBase, net.minecraftforge.common.BiomeDictionary.Type...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerBiomeType</h4> +<pre>public static boolean registerBiomeType(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>... types)</pre> +<div class="block">Registers a biome with a specific biome type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>biome</code> - the biome to be registered</dd><dd><code>type</code> - the type to register the biome as</dd> +<dt><span class="strong">Returns:</span></dt><dd>returns true if the biome was registered successfully</dd></dl> +</li> +</ul> +<a name="getBiomesForType(net.minecraftforge.common.BiomeDictionary.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBiomesForType</h4> +<pre>public static <a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a>[] getBiomesForType(<a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> type)</pre> +<div class="block">Returns a list of biomes registered with a specific type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - the Type to look for</dd> +<dt><span class="strong">Returns:</span></dt><dd>a list of biomes of the specified type, null if there are none</dd></dl> +</li> +</ul> +<a name="getTypesForBiome(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTypesForBiome</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>[] getTypesForBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +<div class="block">Gets a list of Types that a specific biome is registered with</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>biome</code> - the biome to check</dd> +<dt><span class="strong">Returns:</span></dt><dd>the list of types, null if there are none</dd></dl> +</li> +</ul> +<a name="areBiomesEquivalent(net.minecraft.world.biome.BiomeGenBase, net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>areBiomesEquivalent</h4> +<pre>public static boolean areBiomesEquivalent(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biomeA, + <a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biomeB)</pre> +<div class="block">Checks to see if two biomes are registered as having the same type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>biomeA</code> - </dd><dd><code>biomeB</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>returns true if a common type is found, false otherwise</dd></dl> +</li> +</ul> +<a name="isBiomeOfType(net.minecraft.world.biome.BiomeGenBase, net.minecraftforge.common.BiomeDictionary.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBiomeOfType</h4> +<pre>public static boolean isBiomeOfType(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> type)</pre> +<div class="block">Checks to see if the given biome is registered as being a specific type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>biome</code> - the biome to be considered</dd><dd><code>type</code> - the type to check for</dd> +<dt><span class="strong">Returns:</span></dt><dd>returns true if the biome is registered as being of type type, false otherwise</dd></dl> +</li> +</ul> +<a name="isBiomeRegistered(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBiomeRegistered</h4> +<pre>public static boolean isBiomeRegistered(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +<div class="block">Checks to see if the given biome has been registered as being of any type</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>biome</code> - the biome to consider</dd> +<dt><span class="strong">Returns:</span></dt><dd>returns true if the biome has been registered, false otherwise</dd></dl> +</li> +</ul> +<a name="isBiomeRegistered(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBiomeRegistered</h4> +<pre>public static boolean isBiomeRegistered(int biomeID)</pre> +</li> +</ul> +<a name="registerAllBiomes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerAllBiomes</h4> +<pre>public static void registerAllBiomes()</pre> +</li> +</ul> +<a name="registerAllBiomesAndGenerateEvents()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerAllBiomesAndGenerateEvents</h4> +<pre>public static void registerAllBiomesAndGenerateEvents()</pre> +<div class="block">Loops through the biome list and automatically adds tags to any biome that does not have any + This is called by Forge at postinit time. It will additionally dispatch any deferred decorator + creation events. + + DO NOT call this during world generation</div> +</li> +</ul> +<a name="makeBestGuess(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>makeBestGuess</h4> +<pre>public static void makeBestGuess(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +<div class="block">Automatically looks for and registers a given biome with appropriate tags + This method is called automatically if a biome has not been registered with any tags, + And another method requests information about it</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>biome</code> - the biome to be considered</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/AchievementPage.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeDictionary.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/BiomeDictionary.html" target="_top">Frames</a></li> +<li><a href="BiomeDictionary.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>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> |