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 | |
| parent | 1da8dcd58647e34c9af94ceeecaeaf3b0d08c48c (diff) | |
full project files
Diffstat (limited to 'javadoc/net/minecraftforge/common')
76 files changed, 29543 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/AchievementPage.html b/javadoc/net/minecraftforge/common/AchievementPage.html new file mode 100644 index 0000000..18ab6dc --- /dev/null +++ b/javadoc/net/minecraftforge/common/AchievementPage.html @@ -0,0 +1,369 @@ +<!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>AchievementPage (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="AchievementPage (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>Prev Class</li> +<li><a href="../../../net/minecraftforge/common/BiomeDictionary.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/AchievementPage.html" target="_top">Frames</a></li> +<li><a href="AchievementPage.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><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 AchievementPage" class="title">Class AchievementPage</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.AchievementPage</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">AchievementPage</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/AchievementPage.html#AchievementPage(java.lang.String,%20net.minecraft.stats.Achievement...)">AchievementPage</a></strong>(java.lang.String name, + <a href="../../../net/minecraft/stats/Achievement.html" title="class in net.minecraft.stats">Achievement</a>... achievements)</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 <a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#getAchievementPage(int)">getAchievementPage</a></strong>(int index)</code> +<div class="block">Will return an achievement page by its index on the list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#getAchievementPage(java.lang.String)">getAchievementPage</a></strong>(java.lang.String name)</code> +<div class="block">Will return an achievement page by its name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Set<<a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#getAchievementPages()">getAchievementPages</a></strong>()</code> +<div class="block">Will return the list of achievement pages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../net/minecraft/stats/Achievement.html" title="class in net.minecraft.stats">Achievement</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#getAchievements()">getAchievements</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#getTitle(int)">getTitle</a></strong>(int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#isAchievementInPages(net.minecraft.stats.Achievement)">isAchievementInPages</a></strong>(<a href="../../../net/minecraft/stats/Achievement.html" title="class in net.minecraft.stats">Achievement</a> achievement)</code> +<div class="block">Will return whether an achievement is in any page or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/AchievementPage.html#registerAchievementPage(net.minecraftforge.common.AchievementPage)">registerAchievementPage</a></strong>(<a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a> page)</code> +<div class="block">Registers an achievement page.</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="AchievementPage(java.lang.String, net.minecraft.stats.Achievement...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AchievementPage</h4> +<pre>public AchievementPage(java.lang.String name, + <a href="../../../net/minecraft/stats/Achievement.html" title="class in net.minecraft.stats">Achievement</a>... achievements)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +</li> +</ul> +<a name="getAchievements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAchievements</h4> +<pre>public java.util.List<<a href="../../../net/minecraft/stats/Achievement.html" title="class in net.minecraft.stats">Achievement</a>> getAchievements()</pre> +</li> +</ul> +<a name="registerAchievementPage(net.minecraftforge.common.AchievementPage)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerAchievementPage</h4> +<pre>public static void registerAchievementPage(<a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a> page)</pre> +<div class="block">Registers an achievement page.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>page</code> - The page.</dd></dl> +</li> +</ul> +<a name="getAchievementPage(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAchievementPage</h4> +<pre>public static <a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a> getAchievementPage(int index)</pre> +<div class="block">Will return an achievement page by its index on the list.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The page's index.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the achievement page corresponding to the index or null if invalid index</dd></dl> +</li> +</ul> +<a name="getAchievementPage(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAchievementPage</h4> +<pre>public static <a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a> getAchievementPage(java.lang.String name)</pre> +<div class="block">Will return an achievement page by its name.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The page's name.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the achievement page with the given name or null if no such page</dd></dl> +</li> +</ul> +<a name="getAchievementPages()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAchievementPages</h4> +<pre>public static java.util.Set<<a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a>> getAchievementPages()</pre> +<div class="block">Will return the list of achievement pages.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the list's size</dd></dl> +</li> +</ul> +<a name="isAchievementInPages(net.minecraft.stats.Achievement)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAchievementInPages</h4> +<pre>public static boolean isAchievementInPages(<a href="../../../net/minecraft/stats/Achievement.html" title="class in net.minecraft.stats">Achievement</a> achievement)</pre> +<div class="block">Will return whether an achievement is in any page or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>achievement</code> - The achievement.</dd></dl> +</li> +</ul> +<a name="getTitle(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTitle</h4> +<pre>public static java.lang.String getTitle(int index)</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>Prev Class</li> +<li><a href="../../../net/minecraftforge/common/BiomeDictionary.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/AchievementPage.html" target="_top">Frames</a></li> +<li><a href="AchievementPage.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><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> diff --git a/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html b/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html new file mode 100644 index 0000000..a0ab768 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html @@ -0,0 +1,712 @@ +<!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.Type (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.Type (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/BiomeDictionary.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeManager.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/BiomeDictionary.Type.html" target="_top">Frames</a></li> +<li><a href="BiomeDictionary.Type.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum BiomeDictionary.Type" class="title">Enum BiomeDictionary.Type</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.BiomeDictionary.Type</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/BiomeDictionary.html" title="class in net.minecraftforge.common">BiomeDictionary</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">BiomeDictionary.Type</span> +extends java.lang.Enum<<a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#BEACH">BEACH</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#COLD">COLD</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#CONIFEROUS">CONIFEROUS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#DEAD">DEAD</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#DENSE">DENSE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#DESERT">DESERT</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#DRY">DRY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#END">END</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#FOREST">FOREST</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#FROZEN">FROZEN</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#HILLS">HILLS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#HOT">HOT</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#JUNGLE">JUNGLE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#LUSH">LUSH</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#MAGICAL">MAGICAL</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#MESA">MESA</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#MOUNTAIN">MOUNTAIN</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#MUSHROOM">MUSHROOM</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#NETHER">NETHER</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#OCEAN">OCEAN</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#PLAINS">PLAINS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#RIVER">RIVER</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#SANDY">SANDY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#SAVANNA">SAVANNA</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#SNOWY">SNOWY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#SPARSE">SPARSE</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#SPOOKY">SPOOKY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#SWAMP">SWAMP</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#WASTELAND">WASTELAND</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#WATER">WATER</a></strong></code> +<div class="block">A general tag for all water-based biomes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html#WET">WET</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 <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.Type.html#getType(java.lang.String,%20net.minecraftforge.common.BiomeDictionary.Type...)">getType</a></strong>(java.lang.String name, + <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>... subTypes)</code> +<div class="block">Retrieves a Type value by name, + if one does not exist already it creates one.</div> +</td> +</tr> +<tr class="rowColor"> +<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.Type.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</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.Type.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="HOT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HOT</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> HOT</pre> +</li> +</ul> +<a name="COLD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COLD</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> COLD</pre> +</li> +</ul> +<a name="SPARSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SPARSE</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> SPARSE</pre> +</li> +</ul> +<a name="DENSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DENSE</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> DENSE</pre> +</li> +</ul> +<a name="WET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WET</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> WET</pre> +</li> +</ul> +<a name="DRY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DRY</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> DRY</pre> +</li> +</ul> +<a name="SAVANNA"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SAVANNA</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> SAVANNA</pre> +</li> +</ul> +<a name="CONIFEROUS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CONIFEROUS</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> CONIFEROUS</pre> +</li> +</ul> +<a name="JUNGLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>JUNGLE</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> JUNGLE</pre> +</li> +</ul> +<a name="SPOOKY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SPOOKY</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> SPOOKY</pre> +</li> +</ul> +<a name="DEAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEAD</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> DEAD</pre> +</li> +</ul> +<a name="LUSH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LUSH</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> LUSH</pre> +</li> +</ul> +<a name="NETHER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NETHER</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> NETHER</pre> +</li> +</ul> +<a name="END"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>END</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> END</pre> +</li> +</ul> +<a name="MUSHROOM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MUSHROOM</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> MUSHROOM</pre> +</li> +</ul> +<a name="MAGICAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MAGICAL</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> MAGICAL</pre> +</li> +</ul> +<a name="OCEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OCEAN</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> OCEAN</pre> +</li> +</ul> +<a name="RIVER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RIVER</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> RIVER</pre> +</li> +</ul> +<a name="WATER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WATER</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> WATER</pre> +<div class="block">A general tag for all water-based biomes. Shown as present if OCEAN or RIVER are.</div> +</li> +</ul> +<a name="MESA"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MESA</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> MESA</pre> +</li> +</ul> +<a name="FOREST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FOREST</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> FOREST</pre> +</li> +</ul> +<a name="PLAINS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PLAINS</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> PLAINS</pre> +</li> +</ul> +<a name="MOUNTAIN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MOUNTAIN</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> MOUNTAIN</pre> +</li> +</ul> +<a name="HILLS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HILLS</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> HILLS</pre> +</li> +</ul> +<a name="SWAMP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SWAMP</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> SWAMP</pre> +</li> +</ul> +<a name="SANDY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SANDY</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> SANDY</pre> +</li> +</ul> +<a name="SNOWY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SNOWY</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> SNOWY</pre> +</li> +</ul> +<a name="WASTELAND"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WASTELAND</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> WASTELAND</pre> +</li> +</ul> +<a name="BEACH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BEACH</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> BEACH</pre> +</li> +</ul> +<a name="DESERT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DESERT</h4> +<pre>@Deprecated +public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> DESERT</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="FROZEN"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FROZEN</h4> +<pre>@Deprecated +public static final <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> FROZEN</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (BiomeDictionary.Type c : BiomeDictionary.Type.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="getType(java.lang.String, net.minecraftforge.common.BiomeDictionary.Type...)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getType</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a> getType(java.lang.String name, + <a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a>... subTypes)</pre> +<div class="block">Retrieves a Type value by name, + if one does not exist already it creates one. + This can be used as interm measure for modders to + add there own category of Biome. + + There are NO naming conventions besides: + MUST be all upper case (enforced by name.toUpper()) + NO Special characters. {Unenforced, just don't be a pain, if it becomes a issue I WILL + make this RTE with no worry about backwards compatibility} + + Note: For performance sake, the return value of this function SHOULD be cached. + Two calls with the same name SHOULD return the same value.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of this Type</dd> +<dt><span class="strong">Returns:</span></dt><dd>An instance of Type for this name.</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/BiomeDictionary.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeManager.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/BiomeDictionary.Type.html" target="_top">Frames</a></li> +<li><a href="BiomeDictionary.Type.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> 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> diff --git a/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html b/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html new file mode 100644 index 0000000..e07bed1 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html @@ -0,0 +1,280 @@ +<!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>BiomeManager.BiomeEntry (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="BiomeManager.BiomeEntry (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/BiomeManager.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.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/BiomeManager.BiomeEntry.html" target="_top">Frames</a></li> +<li><a href="BiomeManager.BiomeEntry.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">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>Method</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 BiomeManager.BiomeEntry" class="title">Class BiomeManager.BiomeEntry</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util">net.minecraft.util.WeightedRandom.Item</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.BiomeManager.BiomeEntry</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/BiomeManager.html" title="class in net.minecraftforge.common">BiomeManager</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">BiomeManager.BiomeEntry</span> +extends <a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util">WeightedRandom.Item</a></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/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html#biome">biome</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.util.WeightedRandom.Item"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.util.<a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util">WeightedRandom.Item</a></h3> +<code><a href="../../../net/minecraft/util/WeightedRandom.Item.html#itemWeight">itemWeight</a></code></li> +</ul> +</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/BiomeManager.BiomeEntry.html#BiomeManager.BiomeEntry(net.minecraft.world.biome.BiomeGenBase,%20int)">BiomeManager.BiomeEntry</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + int weight)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="biome"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>biome</h4> +<pre>public final <a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BiomeManager.BiomeEntry(net.minecraft.world.biome.BiomeGenBase, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BiomeManager.BiomeEntry</h4> +<pre>public BiomeManager.BiomeEntry(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + int weight)</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/BiomeManager.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.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/BiomeManager.BiomeEntry.html" target="_top">Frames</a></li> +<li><a href="BiomeManager.BiomeEntry.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">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>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html b/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html new file mode 100644 index 0000000..5345773 --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html @@ -0,0 +1,358 @@ +<!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>BiomeManager.BiomeType (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="BiomeManager.BiomeType (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/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ChestGenHooks.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/BiomeManager.BiomeType.html" target="_top">Frames</a></li> +<li><a href="BiomeManager.BiomeType.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum BiomeManager.BiomeType" class="title">Enum BiomeManager.BiomeType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.BiomeManager.BiomeType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/BiomeManager.html" title="class in net.minecraftforge.common">BiomeManager</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">BiomeManager.BiomeType</span> +extends java.lang.Enum<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#COOL">COOL</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#DESERT">DESERT</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#ICY">ICY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#WARM">WARM</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 <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#getType(java.lang.String)">getType</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="DESERT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DESERT</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> DESERT</pre> +</li> +</ul> +<a name="WARM"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WARM</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> WARM</pre> +</li> +</ul> +<a name="COOL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COOL</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> COOL</pre> +</li> +</ul> +<a name="ICY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ICY</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> ICY</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (BiomeManager.BiomeType c : BiomeManager.BiomeType.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="getType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getType</h4> +<pre>public static <a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> getType(java.lang.String name)</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/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ChestGenHooks.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/BiomeManager.BiomeType.html" target="_top">Frames</a></li> +<li><a href="BiomeManager.BiomeType.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/BiomeManager.html b/javadoc/net/minecraftforge/common/BiomeManager.html new file mode 100644 index 0000000..cdb41ab --- /dev/null +++ b/javadoc/net/minecraftforge/common/BiomeManager.html @@ -0,0 +1,530 @@ +<!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>BiomeManager (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="BiomeManager (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/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.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/BiomeManager.html" target="_top">Frames</a></li> +<li><a href="BiomeManager.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 BiomeManager" class="title">Class BiomeManager</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.BiomeManager</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">BiomeManager</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/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</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/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</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<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#coolBiomes">coolBiomes</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#desertBiomes">desertBiomes</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#icyBiomes">icyBiomes</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.List<<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/BiomeManager.html#oceanBiomes">oceanBiomes</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.ArrayList<<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/BiomeManager.html#strongHoldBiomes">strongHoldBiomes</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.util.ArrayList<<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/BiomeManager.html#strongHoldBiomesBlackList">strongHoldBiomesBlackList</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#warmBiomes">warmBiomes</a></strong></code> +<div class="block"><strong>Deprecated.</strong> </div> +</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/BiomeManager.html#BiomeManager()">BiomeManager</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/BiomeManager.html#addBiome(net.minecraftforge.common.BiomeManager.BiomeType,%20net.minecraftforge.common.BiomeManager.BiomeEntry)">addBiome</a></strong>(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type, + <a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a> entry)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#addSpawnBiome(net.minecraft.world.biome.BiomeGenBase)">addSpawnBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#addStrongholdBiome(net.minecraft.world.biome.BiomeGenBase)">addStrongholdBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#addVillageBiome(net.minecraft.world.biome.BiomeGenBase,%20boolean)">addVillageBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + boolean canSpawn)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static com.google.common.collect.ImmutableList<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#getBiomes(net.minecraftforge.common.BiomeManager.BiomeType)">getBiomes</a></strong>(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#isTypeListModded(net.minecraftforge.common.BiomeManager.BiomeType)">isTypeListModded</a></strong>(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#removeBiome(net.minecraftforge.common.BiomeManager.BiomeType,%20net.minecraftforge.common.BiomeManager.BiomeEntry)">removeBiome</a></strong>(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type, + <a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a> entry)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#removeSpawnBiome(net.minecraft.world.biome.BiomeGenBase)">removeSpawnBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#removeStrongholdBiome(net.minecraft.world.biome.BiomeGenBase)">removeStrongholdBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/BiomeManager.html#removeVillageBiome(net.minecraft.world.biome.BiomeGenBase)">removeVillageBiome</a></strong>(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</code> </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="desertBiomes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>desertBiomes</h4> +<pre>@Deprecated +public static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>> desertBiomes</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="warmBiomes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>warmBiomes</h4> +<pre>@Deprecated +public static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>> warmBiomes</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="coolBiomes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>coolBiomes</h4> +<pre>@Deprecated +public static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>> coolBiomes</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="icyBiomes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>icyBiomes</h4> +<pre>@Deprecated +public static java.util.List<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>> icyBiomes</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +</li> +</ul> +<a name="oceanBiomes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>oceanBiomes</h4> +<pre>public static java.util.List<<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a>> oceanBiomes</pre> +</li> +</ul> +<a name="strongHoldBiomes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>strongHoldBiomes</h4> +<pre>public static java.util.ArrayList<<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a>> strongHoldBiomes</pre> +</li> +</ul> +<a name="strongHoldBiomesBlackList"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>strongHoldBiomesBlackList</h4> +<pre>public static java.util.ArrayList<<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a>> strongHoldBiomesBlackList</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BiomeManager()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BiomeManager</h4> +<pre>public BiomeManager()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addVillageBiome(net.minecraft.world.biome.BiomeGenBase, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addVillageBiome</h4> +<pre>public static void addVillageBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome, + boolean canSpawn)</pre> +</li> +</ul> +<a name="removeVillageBiome(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeVillageBiome</h4> +<pre>public static void removeVillageBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +</li> +</ul> +<a name="addStrongholdBiome(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addStrongholdBiome</h4> +<pre>public static void addStrongholdBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +</li> +</ul> +<a name="removeStrongholdBiome(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeStrongholdBiome</h4> +<pre>public static void removeStrongholdBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +</li> +</ul> +<a name="addSpawnBiome(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSpawnBiome</h4> +<pre>public static void addSpawnBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +</li> +</ul> +<a name="removeSpawnBiome(net.minecraft.world.biome.BiomeGenBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeSpawnBiome</h4> +<pre>public static void removeSpawnBiome(<a href="../../../net/minecraft/world/biome/BiomeGenBase.html" title="class in net.minecraft.world.biome">BiomeGenBase</a> biome)</pre> +</li> +</ul> +<a name="addBiome(net.minecraftforge.common.BiomeManager.BiomeType, net.minecraftforge.common.BiomeManager.BiomeEntry)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addBiome</h4> +<pre>public static void addBiome(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type, + <a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a> entry)</pre> +</li> +</ul> +<a name="removeBiome(net.minecraftforge.common.BiomeManager.BiomeType, net.minecraftforge.common.BiomeManager.BiomeEntry)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeBiome</h4> +<pre>public static void removeBiome(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type, + <a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a> entry)</pre> +</li> +</ul> +<a name="getBiomes(net.minecraftforge.common.BiomeManager.BiomeType)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBiomes</h4> +<pre>public static com.google.common.collect.ImmutableList<<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a>> getBiomes(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a> type)</pre> +</li> +</ul> +<a name="isTypeListModded(net.minecraftforge.common.BiomeManager.BiomeType)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isTypeListModded</h4> +<pre>public static boolean isTypeListModded(<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</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/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.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/BiomeManager.html" target="_top">Frames</a></li> +<li><a href="BiomeManager.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> diff --git a/javadoc/net/minecraftforge/common/ChestGenHooks.html b/javadoc/net/minecraftforge/common/ChestGenHooks.html new file mode 100644 index 0000000..366a209 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ChestGenHooks.html @@ -0,0 +1,683 @@ +<!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>ChestGenHooks (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="ChestGenHooks (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/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/DimensionManager.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/ChestGenHooks.html" target="_top">Frames</a></li> +<li><a href="ChestGenHooks.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><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 ChestGenHooks" class="title">Class ChestGenHooks</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ChestGenHooks</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ChestGenHooks</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>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#BONUS_CHEST">BONUS_CHEST</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#DUNGEON_CHEST">DUNGEON_CHEST</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#MINESHAFT_CORRIDOR">MINESHAFT_CORRIDOR</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#PYRAMID_DESERT_CHEST">PYRAMID_DESERT_CHEST</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#PYRAMID_JUNGLE_CHEST">PYRAMID_JUNGLE_CHEST</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#PYRAMID_JUNGLE_DISPENSER">PYRAMID_JUNGLE_DISPENSER</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#STRONGHOLD_CORRIDOR">STRONGHOLD_CORRIDOR</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#STRONGHOLD_CROSSING">STRONGHOLD_CROSSING</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#STRONGHOLD_LIBRARY">STRONGHOLD_LIBRARY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#VILLAGE_BLACKSMITH">VILLAGE_BLACKSMITH</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/ChestGenHooks.html#ChestGenHooks(java.lang.String)">ChestGenHooks</a></strong>(java.lang.String category)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#ChestGenHooks(java.lang.String,%20net.minecraft.util.WeightedRandomChestContent[],%20int,%20int)">ChestGenHooks</a></strong>(java.lang.String category, + <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a>[] items, + int min, + int max)</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/ChestGenHooks.html#addItem(java.lang.String,%20net.minecraft.util.WeightedRandomChestContent)">addItem</a></strong>(java.lang.String category, + <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a> item)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#addItem(net.minecraft.util.WeightedRandomChestContent)">addItem</a></strong>(<a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a> item)</code> +<div class="block">Adds a new entry into the possible items to generate.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#generateStacks(java.util.Random,%20net.minecraft.item.ItemStack,%20int,%20int)">generateStacks</a></strong>(java.util.Random rand, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> source, + int min, + int max)</code> +<div class="block">Generates an array of items based on the input min/max count.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getCount(java.util.Random)">getCount</a></strong>(java.util.Random rand)</code> +<div class="block">Gets a random number between countMin and countMax.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getCount(java.lang.String,%20java.util.Random)">getCount</a></strong>(java.lang.String category, + java.util.Random rand)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/ChestGenHooks.html" title="class in net.minecraftforge.common">ChestGenHooks</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getInfo(java.lang.String)">getInfo</a></strong>(java.lang.String category)</code> +<div class="block">Retrieves, or creates the info class for the specified category.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getItems(java.util.Random)">getItems</a></strong>(java.util.Random rnd)</code> +<div class="block">Gets an array of all random objects that are associated with this category.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getItems(java.lang.String,%20java.util.Random)">getItems</a></strong>(java.lang.String category, + java.util.Random rnd)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getMax()">getMax</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getMin()">getMin</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getOneItem(java.util.Random)">getOneItem</a></strong>(java.util.Random rand)</code> +<div class="block">Returns a single ItemStack from the possible items in this registry, + Useful if you just want a quick and dirty random Item.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#getOneItem(java.lang.String,%20java.util.Random)">getOneItem</a></strong>(java.lang.String category, + java.util.Random rand)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#removeItem(net.minecraft.item.ItemStack)">removeItem</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item)</code> +<div class="block">Removes all items that match the input item stack, Only metadata and item ID are checked.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#removeItem(java.lang.String,%20net.minecraft.item.ItemStack)">removeItem</a></strong>(java.lang.String category, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#setMax(int)">setMax</a></strong>(int value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ChestGenHooks.html#setMin(int)">setMin</a></strong>(int value)</code> </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="MINESHAFT_CORRIDOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MINESHAFT_CORRIDOR</h4> +<pre>public static final java.lang.String MINESHAFT_CORRIDOR</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.MINESHAFT_CORRIDOR">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PYRAMID_DESERT_CHEST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PYRAMID_DESERT_CHEST</h4> +<pre>public static final java.lang.String PYRAMID_DESERT_CHEST</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.PYRAMID_DESERT_CHEST">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PYRAMID_JUNGLE_CHEST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PYRAMID_JUNGLE_CHEST</h4> +<pre>public static final java.lang.String PYRAMID_JUNGLE_CHEST</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.PYRAMID_JUNGLE_CHEST">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="PYRAMID_JUNGLE_DISPENSER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PYRAMID_JUNGLE_DISPENSER</h4> +<pre>public static final java.lang.String PYRAMID_JUNGLE_DISPENSER</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.PYRAMID_JUNGLE_DISPENSER">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="STRONGHOLD_CORRIDOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STRONGHOLD_CORRIDOR</h4> +<pre>public static final java.lang.String STRONGHOLD_CORRIDOR</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.STRONGHOLD_CORRIDOR">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="STRONGHOLD_LIBRARY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STRONGHOLD_LIBRARY</h4> +<pre>public static final java.lang.String STRONGHOLD_LIBRARY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.STRONGHOLD_LIBRARY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="STRONGHOLD_CROSSING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STRONGHOLD_CROSSING</h4> +<pre>public static final java.lang.String STRONGHOLD_CROSSING</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.STRONGHOLD_CROSSING">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="VILLAGE_BLACKSMITH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VILLAGE_BLACKSMITH</h4> +<pre>public static final java.lang.String VILLAGE_BLACKSMITH</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.VILLAGE_BLACKSMITH">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="BONUS_CHEST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BONUS_CHEST</h4> +<pre>public static final java.lang.String BONUS_CHEST</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.BONUS_CHEST">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DUNGEON_CHEST"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DUNGEON_CHEST</h4> +<pre>public static final java.lang.String DUNGEON_CHEST</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ChestGenHooks.DUNGEON_CHEST">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ChestGenHooks(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ChestGenHooks</h4> +<pre>public ChestGenHooks(java.lang.String category)</pre> +</li> +</ul> +<a name="ChestGenHooks(java.lang.String, net.minecraft.util.WeightedRandomChestContent[], int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChestGenHooks</h4> +<pre>public ChestGenHooks(java.lang.String category, + <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a>[] items, + int min, + int max)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInfo(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInfo</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ChestGenHooks.html" title="class in net.minecraftforge.common">ChestGenHooks</a> getInfo(java.lang.String category)</pre> +<div class="block">Retrieves, or creates the info class for the specified category.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - The category name</dd> +<dt><span class="strong">Returns:</span></dt><dd>A instance of ChestGenHooks for the specified category.</dd></dl> +</li> +</ul> +<a name="generateStacks(java.util.Random, net.minecraft.item.ItemStack, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>generateStacks</h4> +<pre>public static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>[] generateStacks(java.util.Random rand, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> source, + int min, + int max)</pre> +<div class="block">Generates an array of items based on the input min/max count. + If the stack can not hold the total amount, it will be split into + stacks of size 1.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rand</code> - A random number generator</dd><dd><code>source</code> - Source item stack</dd><dd><code>min</code> - Minimum number of items</dd><dd><code>max</code> - Maximum number of items</dd> +<dt><span class="strong">Returns:</span></dt><dd>An array containing the generated item stacks</dd></dl> +</li> +</ul> +<a name="getItems(java.lang.String, java.util.Random)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getItems</h4> +<pre>public static <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a>[] getItems(java.lang.String category, + java.util.Random rnd)</pre> +</li> +</ul> +<a name="getCount(java.lang.String, java.util.Random)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCount</h4> +<pre>public static int getCount(java.lang.String category, + java.util.Random rand)</pre> +</li> +</ul> +<a name="addItem(java.lang.String, net.minecraft.util.WeightedRandomChestContent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addItem</h4> +<pre>public static void addItem(java.lang.String category, + <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a> item)</pre> +</li> +</ul> +<a name="removeItem(java.lang.String, net.minecraft.item.ItemStack)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeItem</h4> +<pre>public static void removeItem(java.lang.String category, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item)</pre> +</li> +</ul> +<a name="getOneItem(java.lang.String, java.util.Random)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOneItem</h4> +<pre>public static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> getOneItem(java.lang.String category, + java.util.Random rand)</pre> +</li> +</ul> +<a name="addItem(net.minecraft.util.WeightedRandomChestContent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addItem</h4> +<pre>public void addItem(<a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a> item)</pre> +<div class="block">Adds a new entry into the possible items to generate.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The item to add.</dd></dl> +</li> +</ul> +<a name="removeItem(net.minecraft.item.ItemStack)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeItem</h4> +<pre>public void removeItem(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item)</pre> +<div class="block">Removes all items that match the input item stack, Only metadata and item ID are checked. + If the input item has a metadata of -1, all metadatas will match.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The item to check</dd></dl> +</li> +</ul> +<a name="getItems(java.util.Random)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getItems</h4> +<pre>public <a href="../../../net/minecraft/util/WeightedRandomChestContent.html" title="class in net.minecraft.util">WeightedRandomChestContent</a>[] getItems(java.util.Random rnd)</pre> +<div class="block">Gets an array of all random objects that are associated with this category.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The random objects</dd></dl> +</li> +</ul> +<a name="getCount(java.util.Random)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCount</h4> +<pre>public int getCount(java.util.Random rand)</pre> +<div class="block">Gets a random number between countMin and countMax.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rand</code> - A RNG</dd> +<dt><span class="strong">Returns:</span></dt><dd>A random number where countMin <= num <= countMax</dd></dl> +</li> +</ul> +<a name="getOneItem(java.util.Random)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOneItem</h4> +<pre>public <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> getOneItem(java.util.Random rand)</pre> +<div class="block">Returns a single ItemStack from the possible items in this registry, + Useful if you just want a quick and dirty random Item.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rand</code> - A Random Number gen</dd> +<dt><span class="strong">Returns:</span></dt><dd>A single ItemStack, or null if it could not get one.</dd></dl> +</li> +</ul> +<a name="getMin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMin</h4> +<pre>public int getMin()</pre> +</li> +</ul> +<a name="getMax()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMax</h4> +<pre>public int getMax()</pre> +</li> +</ul> +<a name="setMin(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMin</h4> +<pre>public void setMin(int value)</pre> +</li> +</ul> +<a name="setMax(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setMax</h4> +<pre>public void setMax(int value)</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/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/DimensionManager.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/ChestGenHooks.html" target="_top">Frames</a></li> +<li><a href="ChestGenHooks.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><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> diff --git a/javadoc/net/minecraftforge/common/DimensionManager.html b/javadoc/net/minecraftforge/common/DimensionManager.html new file mode 100644 index 0000000..9e54cb5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/DimensionManager.html @@ -0,0 +1,575 @@ +<!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>DimensionManager (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="DimensionManager (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/ChestGenHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/DungeonHooks.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/DimensionManager.html" target="_top">Frames</a></li> +<li><a href="DimensionManager.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><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 DimensionManager" class="title">Class DimensionManager</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.DimensionManager</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DimensionManager</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/DimensionManager.html#DimensionManager()">DimensionManager</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 <a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#createProviderFor(int)">createProviderFor</a></strong>(int dim)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getCurrentSaveRootDirectory()">getCurrentSaveRootDirectory</a></strong>()</code> +<div class="block">Return the current root directory for the world save.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.Integer[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getIDs()">getIDs</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Integer[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getIDs(boolean)">getIDs</a></strong>(boolean check)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getNextFreeDimId()">getNextFreeDimId</a></strong>()</code> +<div class="block">Return the next free dimension ID.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getProvider(int)">getProvider</a></strong>(int dim)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getProviderType(int)">getProviderType</a></strong>(int dim)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Integer[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getStaticDimensionIDs()">getStaticDimensionIDs</a></strong>()</code> +<div class="block">Not public API: used internally to get dimensions that should load at + server startup</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getWorld(int)">getWorld</a></strong>(int id)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#getWorlds()">getWorlds</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/DimensionManager.html#init()">init</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#initDimension(int)">initDimension</a></strong>(int dim)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#isDimensionRegistered(int)">isDimensionRegistered</a></strong>(int dim)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#loadDimensionDataMap(net.minecraft.nbt.NBTTagCompound)">loadDimensionDataMap</a></strong>(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compoundTag)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#registerDimension(int,%20int)">registerDimension</a></strong>(int id, + int providerType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#registerProviderType(int,%20java.lang.Class,%20boolean)">registerProviderType</a></strong>(int id, + java.lang.Class<? extends <a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a>> provider, + boolean keepLoaded)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/DimensionManager.html#saveDimensionDataMap()">saveDimensionDataMap</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#setWorld(int,%20net.minecraft.world.WorldServer)">setWorld</a></strong>(int id, + <a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#shouldLoadSpawn(int)">shouldLoadSpawn</a></strong>(int dim)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#unloadWorld(int)">unloadWorld</a></strong>(int id)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#unloadWorlds(java.util.Hashtable)">unloadWorlds</a></strong>(java.util.Hashtable<java.lang.Integer,long[]> worldTickTimes)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#unregisterDimension(int)">unregisterDimension</a></strong>(int id)</code> +<div class="block">For unregistering a dimension when the save is changed (disconnected from a server or loaded a new save</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DimensionManager.html#unregisterProviderType(int)">unregisterProviderType</a></strong>(int id)</code> +<div class="block">Unregisters a Provider type, and returns a array of all dimensions that are + registered to this provider 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="DimensionManager()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DimensionManager</h4> +<pre>public DimensionManager()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="registerProviderType(int, java.lang.Class, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerProviderType</h4> +<pre>public static boolean registerProviderType(int id, + java.lang.Class<? extends <a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a>> provider, + boolean keepLoaded)</pre> +</li> +</ul> +<a name="unregisterProviderType(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unregisterProviderType</h4> +<pre>public static int[] unregisterProviderType(int id)</pre> +<div class="block">Unregisters a Provider type, and returns a array of all dimensions that are + registered to this provider type. + If the return size is greater then 0, it is required that the caller either + change those dimensions's registered type, or replace this type before the + world is attempted to load, else the loader will throw an exception.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - The provider type ID to unreigster</dd> +<dt><span class="strong">Returns:</span></dt><dd>An array containing all dimension IDs still registered to this provider type.</dd></dl> +</li> +</ul> +<a name="init()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>init</h4> +<pre>public static void init()</pre> +</li> +</ul> +<a name="registerDimension(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerDimension</h4> +<pre>public static void registerDimension(int id, + int providerType)</pre> +</li> +</ul> +<a name="unregisterDimension(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unregisterDimension</h4> +<pre>public static void unregisterDimension(int id)</pre> +<div class="block">For unregistering a dimension when the save is changed (disconnected from a server or loaded a new save</div> +</li> +</ul> +<a name="isDimensionRegistered(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDimensionRegistered</h4> +<pre>public static boolean isDimensionRegistered(int dim)</pre> +</li> +</ul> +<a name="getProviderType(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProviderType</h4> +<pre>public static int getProviderType(int dim)</pre> +</li> +</ul> +<a name="getProvider(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProvider</h4> +<pre>public static <a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a> getProvider(int dim)</pre> +</li> +</ul> +<a name="getIDs(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIDs</h4> +<pre>public static java.lang.Integer[] getIDs(boolean check)</pre> +</li> +</ul> +<a name="getIDs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIDs</h4> +<pre>public static java.lang.Integer[] getIDs()</pre> +</li> +</ul> +<a name="setWorld(int, net.minecraft.world.WorldServer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWorld</h4> +<pre>public static void setWorld(int id, + <a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world)</pre> +</li> +</ul> +<a name="initDimension(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initDimension</h4> +<pre>public static void initDimension(int dim)</pre> +</li> +</ul> +<a name="getWorld(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorld</h4> +<pre>public static <a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> getWorld(int id)</pre> +</li> +</ul> +<a name="getWorlds()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorlds</h4> +<pre>public static <a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a>[] getWorlds()</pre> +</li> +</ul> +<a name="shouldLoadSpawn(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldLoadSpawn</h4> +<pre>public static boolean shouldLoadSpawn(int dim)</pre> +</li> +</ul> +<a name="getStaticDimensionIDs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStaticDimensionIDs</h4> +<pre>public static java.lang.Integer[] getStaticDimensionIDs()</pre> +<div class="block">Not public API: used internally to get dimensions that should load at + server startup</div> +</li> +</ul> +<a name="createProviderFor(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createProviderFor</h4> +<pre>public static <a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a> createProviderFor(int dim)</pre> +</li> +</ul> +<a name="unloadWorld(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unloadWorld</h4> +<pre>public static void unloadWorld(int id)</pre> +</li> +</ul> +<a name="unloadWorlds(java.util.Hashtable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unloadWorlds</h4> +<pre>public static void unloadWorlds(java.util.Hashtable<java.lang.Integer,long[]> worldTickTimes)</pre> +</li> +</ul> +<a name="getNextFreeDimId()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextFreeDimId</h4> +<pre>public static int getNextFreeDimId()</pre> +<div class="block">Return the next free dimension ID. Note: you are not guaranteed a contiguous + block of free ids. Always call for each individual ID you wish to get.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the next free dimension ID</dd></dl> +</li> +</ul> +<a name="saveDimensionDataMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>saveDimensionDataMap</h4> +<pre>public static <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> saveDimensionDataMap()</pre> +</li> +</ul> +<a name="loadDimensionDataMap(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadDimensionDataMap</h4> +<pre>public static void loadDimensionDataMap(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compoundTag)</pre> +</li> +</ul> +<a name="getCurrentSaveRootDirectory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCurrentSaveRootDirectory</h4> +<pre>public static java.io.File getCurrentSaveRootDirectory()</pre> +<div class="block">Return the current root directory for the world save. Accesses getSaveHandler from the overworld</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the root directory of the save</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/ChestGenHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/DungeonHooks.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/DimensionManager.html" target="_top">Frames</a></li> +<li><a href="DimensionManager.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><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> diff --git a/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html b/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html new file mode 100644 index 0000000..34b645e --- /dev/null +++ b/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html @@ -0,0 +1,312 @@ +<!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>DungeonHooks.DungeonMob (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="DungeonHooks.DungeonMob (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/DungeonHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/EnumPlantType.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/DungeonHooks.DungeonMob.html" target="_top">Frames</a></li> +<li><a href="DungeonHooks.DungeonMob.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><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 DungeonHooks.DungeonMob" class="title">Class DungeonHooks.DungeonMob</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util">net.minecraft.util.WeightedRandom.Item</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.DungeonHooks.DungeonMob</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/DungeonHooks.html" title="class in net.minecraftforge.common">DungeonHooks</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">DungeonHooks.DungeonMob</span> +extends <a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util">WeightedRandom.Item</a></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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DungeonHooks.DungeonMob.html#type">type</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.util.WeightedRandom.Item"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.util.<a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util">WeightedRandom.Item</a></h3> +<code><a href="../../../net/minecraft/util/WeightedRandom.Item.html#itemWeight">itemWeight</a></code></li> +</ul> +</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/DungeonHooks.DungeonMob.html#DungeonHooks.DungeonMob(int,%20java.lang.String)">DungeonHooks.DungeonMob</a></strong>(int weight, + java.lang.String type)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DungeonHooks.DungeonMob.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object target)</code> </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, 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="type"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>type</h4> +<pre>public java.lang.String type</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DungeonHooks.DungeonMob(int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DungeonHooks.DungeonMob</h4> +<pre>public DungeonHooks.DungeonMob(int weight, + java.lang.String type)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object target)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <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="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/DungeonHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/EnumPlantType.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/DungeonHooks.DungeonMob.html" target="_top">Frames</a></li> +<li><a href="DungeonHooks.DungeonMob.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><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> diff --git a/javadoc/net/minecraftforge/common/DungeonHooks.html b/javadoc/net/minecraftforge/common/DungeonHooks.html new file mode 100644 index 0000000..7786fe8 --- /dev/null +++ b/javadoc/net/minecraftforge/common/DungeonHooks.html @@ -0,0 +1,323 @@ +<!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>DungeonHooks (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="DungeonHooks (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/DimensionManager.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/DungeonHooks.DungeonMob.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/DungeonHooks.html" target="_top">Frames</a></li> +<li><a href="DungeonHooks.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 DungeonHooks" class="title">Class DungeonHooks</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.DungeonHooks</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DungeonHooks</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/DungeonHooks.DungeonMob.html" title="class in net.minecraftforge.common">DungeonHooks.DungeonMob</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/DungeonHooks.html#DungeonHooks()">DungeonHooks</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 float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DungeonHooks.html#addDungeonMob(java.lang.String,%20int)">addDungeonMob</a></strong>(java.lang.String name, + int rarity)</code> +<div class="block">Adds a mob to the possible list of creatures the spawner will create.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DungeonHooks.html#getRandomDungeonMob(java.util.Random)">getRandomDungeonMob</a></strong>(java.util.Random rand)</code> +<div class="block">Gets a random mob name from the list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/DungeonHooks.html#removeDungeonMob(java.lang.String)">removeDungeonMob</a></strong>(java.lang.String name)</code> +<div class="block">Will completely remove a Mob from the dungeon spawn list.</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="DungeonHooks()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DungeonHooks</h4> +<pre>public DungeonHooks()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addDungeonMob(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDungeonMob</h4> +<pre>public static float addDungeonMob(java.lang.String name, + int rarity)</pre> +<div class="block">Adds a mob to the possible list of creatures the spawner will create. + If the mob is already in the spawn list, the rarity will be added to the existing one, + causing the mob to be more common.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of the monster, use the same name used when registering the entity.</dd><dd><code>rarity</code> - The rarity of selecting this mob over others. Must be greater then 0. + Vanilla Minecraft has the following mobs: + Spider 100 + Skeleton 100 + Zombie 200 + Meaning, Zombies are twice as common as spiders or skeletons.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The new rarity of the monster,</dd></dl> +</li> +</ul> +<a name="removeDungeonMob(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeDungeonMob</h4> +<pre>public static int removeDungeonMob(java.lang.String name)</pre> +<div class="block">Will completely remove a Mob from the dungeon spawn list.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - The name of the mob to remove</dd> +<dt><span class="strong">Returns:</span></dt><dd>The rarity of the removed mob, prior to being removed.</dd></dl> +</li> +</ul> +<a name="getRandomDungeonMob(java.util.Random)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRandomDungeonMob</h4> +<pre>public static java.lang.String getRandomDungeonMob(java.util.Random rand)</pre> +<div class="block">Gets a random mob name from the list.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rand</code> - World generation random number generator</dd> +<dt><span class="strong">Returns:</span></dt><dd>The mob name</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/DimensionManager.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/DungeonHooks.DungeonMob.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/DungeonHooks.html" target="_top">Frames</a></li> +<li><a href="DungeonHooks.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> diff --git a/javadoc/net/minecraftforge/common/EnumPlantType.html b/javadoc/net/minecraftforge/common/EnumPlantType.html new file mode 100644 index 0000000..5ea8691 --- /dev/null +++ b/javadoc/net/minecraftforge/common/EnumPlantType.html @@ -0,0 +1,377 @@ +<!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>EnumPlantType (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="EnumPlantType (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/DungeonHooks.DungeonMob.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/FishingHooks.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/EnumPlantType.html" target="_top">Frames</a></li> +<li><a href="EnumPlantType.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum EnumPlantType" class="title">Enum EnumPlantType</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.EnumPlantType</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">EnumPlantType</span> +extends java.lang.Enum<<a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Beach">Beach</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Cave">Cave</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Crop">Crop</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Desert">Desert</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Nether">Nether</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Plains">Plains</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#Water">Water</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 <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/EnumPlantType.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="Plains"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Plains</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Plains</pre> +</li> +</ul> +<a name="Desert"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Desert</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Desert</pre> +</li> +</ul> +<a name="Beach"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Beach</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Beach</pre> +</li> +</ul> +<a name="Cave"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Cave</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Cave</pre> +</li> +</ul> +<a name="Water"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Water</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Water</pre> +</li> +</ul> +<a name="Nether"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Nether</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Nether</pre> +</li> +</ul> +<a name="Crop"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Crop</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> Crop</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (EnumPlantType c : EnumPlantType.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/DungeonHooks.DungeonMob.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/FishingHooks.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/EnumPlantType.html" target="_top">Frames</a></li> +<li><a href="EnumPlantType.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html b/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html new file mode 100644 index 0000000..a11e3c9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html @@ -0,0 +1,369 @@ +<!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>FishingHooks.FishableCategory (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="FishingHooks.FishableCategory (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.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.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/FishingHooks.FishableCategory.html" target="_top">Frames</a></li> +<li><a href="FishingHooks.FishableCategory.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="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li><a href="#field_detail">Field</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="Enum FishingHooks.FishableCategory" class="title">Enum FishingHooks.FishableCategory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.FishingHooks.FishableCategory</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/FishingHooks.html" title="class in net.minecraftforge.common">FishingHooks</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">FishingHooks.FishableCategory</span> +extends java.lang.Enum<<a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html#FISH">FISH</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html#JUNK">JUNK</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html#TREASURE">TREASURE</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><a href="../../../net/minecraft/stats/StatBase.html" title="class in net.minecraft.stats">StatBase</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html#stat">stat</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 <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="JUNK"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>JUNK</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a> JUNK</pre> +</li> +</ul> +<a name="TREASURE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TREASURE</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a> TREASURE</pre> +</li> +</ul> +<a name="FISH"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FISH</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a> FISH</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="stat"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stat</h4> +<pre>public final <a href="../../../net/minecraft/stats/StatBase.html" title="class in net.minecraft.stats">StatBase</a> stat</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (FishingHooks.FishableCategory c : FishingHooks.FishableCategory.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/FishingHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.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/FishingHooks.FishableCategory.html" target="_top">Frames</a></li> +<li><a href="FishingHooks.FishableCategory.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="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li><a href="#field_detail">Field</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> diff --git a/javadoc/net/minecraftforge/common/FishingHooks.html b/javadoc/net/minecraftforge/common/FishingHooks.html new file mode 100644 index 0000000..1ba6df5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/FishingHooks.html @@ -0,0 +1,389 @@ +<!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>FishingHooks (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="FishingHooks (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/EnumPlantType.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.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/FishingHooks.html" target="_top">Frames</a></li> +<li><a href="FishingHooks.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 FishingHooks" class="title">Class FishingHooks</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.FishingHooks</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">FishingHooks</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/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</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/FishingHooks.html#FishingHooks()">FishingHooks</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/FishingHooks.html#addFish(net.minecraft.util.WeightedRandomFishable)">addFish</a></strong>(<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a> item)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#addJunk(net.minecraft.util.WeightedRandomFishable)">addJunk</a></strong>(<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a> item)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#addTreasure(net.minecraft.util.WeightedRandomFishable)">addTreasure</a></strong>(<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a> item)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#getFishableCategory(float,%20int,%20int)">getFishableCategory</a></strong>(float chance, + int luck, + int speed)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#getRandomFishable(java.util.Random,%20float)">getRandomFishable</a></strong>(java.util.Random rand, + float chance)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#getRandomFishable(java.util.Random,%20float,%20int,%20int)">getRandomFishable</a></strong>(java.util.Random rand, + float chance, + int luck, + int speed)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#removeFish(com.google.common.base.Predicate)">removeFish</a></strong>(com.google.common.base.Predicate<<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a>> test)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#removeJunk(com.google.common.base.Predicate)">removeJunk</a></strong>(com.google.common.base.Predicate<<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a>> test)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/FishingHooks.html#removeTreasure(com.google.common.base.Predicate)">removeTreasure</a></strong>(com.google.common.base.Predicate<<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a>> test)</code> </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="FishingHooks()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FishingHooks</h4> +<pre>public FishingHooks()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addFish(net.minecraft.util.WeightedRandomFishable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addFish</h4> +<pre>public static void addFish(<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a> item)</pre> +</li> +</ul> +<a name="addJunk(net.minecraft.util.WeightedRandomFishable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addJunk</h4> +<pre>public static void addJunk(<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a> item)</pre> +</li> +</ul> +<a name="addTreasure(net.minecraft.util.WeightedRandomFishable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addTreasure</h4> +<pre>public static void addTreasure(<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a> item)</pre> +</li> +</ul> +<a name="removeFish(com.google.common.base.Predicate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeFish</h4> +<pre>public static void removeFish(com.google.common.base.Predicate<<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a>> test)</pre> +</li> +</ul> +<a name="removeJunk(com.google.common.base.Predicate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeJunk</h4> +<pre>public static void removeJunk(com.google.common.base.Predicate<<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a>> test)</pre> +</li> +</ul> +<a name="removeTreasure(com.google.common.base.Predicate)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeTreasure</h4> +<pre>public static void removeTreasure(com.google.common.base.Predicate<<a href="../../../net/minecraft/util/WeightedRandomFishable.html" title="class in net.minecraft.util">WeightedRandomFishable</a>> test)</pre> +</li> +</ul> +<a name="getRandomFishable(java.util.Random, float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomFishable</h4> +<pre>public static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> getRandomFishable(java.util.Random rand, + float chance)</pre> +</li> +</ul> +<a name="getRandomFishable(java.util.Random, float, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRandomFishable</h4> +<pre>public static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> getRandomFishable(java.util.Random rand, + float chance, + int luck, + int speed)</pre> +</li> +</ul> +<a name="getFishableCategory(float, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFishableCategory</h4> +<pre>public static <a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a> getFishableCategory(float chance, + int luck, + int speed)</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/EnumPlantType.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.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/FishingHooks.html" target="_top">Frames</a></li> +<li><a href="FishingHooks.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> diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html new file mode 100644 index 0000000..1995c7f --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html @@ -0,0 +1,308 @@ +<!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.ForceChunkEvent (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.ForceChunkEvent (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.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.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.ForceChunkEvent.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.ForceChunkEvent.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_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">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>Method</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.ForceChunkEvent" class="title">Class ForgeChunkManager.ForceChunkEvent</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">cpw.mods.fml.common.eventhandler.Event</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeChunkManager.ForceChunkEvent</li> +</ul> +</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.ForceChunkEvent</span> +extends <a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class cpw.mods.fml.common.eventhandler.<a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></h3> +<code><a href="../../../cpw/mods/fml/common/eventhandler/Event.HasResult.html" title="annotation in cpw.mods.fml.common.eventhandler">Event.HasResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.Result.html" title="enum in cpw.mods.fml.common.eventhandler">Event.Result</a></code></li> +</ul> +</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><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.ForceChunkEvent.html#location">location</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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.ForceChunkEvent.html#ticket">ticket</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.ForceChunkEvent.html#ForgeChunkManager.ForceChunkEvent(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)">ForgeChunkManager.ForceChunkEvent</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> location)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event"> +<!-- --> +</a> +<h3>Methods inherited from class cpw.mods.fml.common.eventhandler.<a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></h3> +<code><a href="../../../cpw/mods/fml/common/eventhandler/Event.html#getListenerList()">getListenerList</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#getPhase()">getPhase</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#getResult()">getResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#hasResult()">hasResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#isCancelable()">isCancelable</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#isCanceled()">isCanceled</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setCanceled(boolean)">setCanceled</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setPhase(cpw.mods.fml.common.eventhandler.EventPriority)">setPhase</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setResult(cpw.mods.fml.common.eventhandler.Event.Result)">setResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setup()">setup</a></code></li> +</ul> +<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="ticket"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ticket</h4> +<pre>public final <a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket</pre> +</li> +</ul> +<a name="location"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>location</h4> +<pre>public final <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> location</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.ForceChunkEvent(net.minecraftforge.common.ForgeChunkManager.Ticket, net.minecraft.world.ChunkCoordIntPair)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeChunkManager.ForceChunkEvent</h4> +<pre>public ForgeChunkManager.ForceChunkEvent(<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> location)</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/ForgeChunkManager.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.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.ForceChunkEvent.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.ForceChunkEvent.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_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">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>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html new file mode 100644 index 0000000..8c8a6a1 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html @@ -0,0 +1,225 @@ +<!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.LoadingCallback (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.LoadingCallback (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.ForceChunkEvent.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.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.LoadingCallback.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.LoadingCallback.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.LoadingCallback" class="title">Interface ForgeChunkManager.LoadingCallback</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.OrderedLoadingCallback</a>, <a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.PlayerOrderedLoadingCallback</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.LoadingCallback</span></pre> +<div class="block">All mods requiring chunkloading need to implement this to handle the + re-registration of chunk tickets at world loading time</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html#ticketsLoaded(java.util.List,%20net.minecraft.world.World)">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)</code> +<div class="block">Called back when tickets are loaded from the world to allow the + mod to re-register the chunks associated with those tickets.</div> +</td> +</tr> +</table> +</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)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ticketsLoaded</h4> +<pre>void 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)</pre> +<div class="block">Called back when tickets are loaded from the world to allow the + mod to re-register the chunks associated with those tickets. The list supplied + here is truncated to length prior to use. Tickets unwanted by the + mod must be disposed of manually unless the mod is an OrderedLoadingCallback instance + in which case, they will have been disposed of by the earlier callback.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>tickets</code> - The tickets to re-register. The list is immutable and cannot be manipulated directly. Copy it first.</dd><dd><code>world</code> - the world</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.ForceChunkEvent.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.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.LoadingCallback.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.LoadingCallback.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> 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> diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html new file mode 100644 index 0000000..492868e --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html @@ -0,0 +1,235 @@ +<!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.PlayerOrderedLoadingCallback (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.PlayerOrderedLoadingCallback (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.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.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.PlayerOrderedLoadingCallback.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.PlayerOrderedLoadingCallback.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.PlayerOrderedLoadingCallback" class="title">Interface ForgeChunkManager.PlayerOrderedLoadingCallback</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.PlayerOrderedLoadingCallback</span> +extends <a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a></pre> +</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>com.google.common.collect.ListMultimap<java.lang.String,<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.PlayerOrderedLoadingCallback.html#playerTicketsLoaded(com.google.common.collect.ListMultimap,%20net.minecraft.world.World)">playerTicketsLoaded</a></strong>(com.google.common.collect.ListMultimap<java.lang.String,<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)</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.</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="playerTicketsLoaded(com.google.common.collect.ListMultimap, net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>playerTicketsLoaded</h4> +<pre>com.google.common.collect.ListMultimap<java.lang.String,<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a>> playerTicketsLoaded(com.google.common.collect.ListMultimap<java.lang.String,<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)</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. + This is for player bound tickets rather than mod bound tickets. It is here so mods can + decide they want to dump all player tickets + + 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</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> +<dt><span class="strong">Returns:</span></dt><dd>A list of the tickets this mod wishes to use. This list will subsequently be offered + to the main callback for action</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.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.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.PlayerOrderedLoadingCallback.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.PlayerOrderedLoadingCallback.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> 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> diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html new file mode 100644 index 0000000..a92ba7b --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html @@ -0,0 +1,327 @@ +<!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.Type (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.Type (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.Ticket.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.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.Type.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.Type.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum ForgeChunkManager.Type" class="title">Enum ForgeChunkManager.Type</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeChunkManager.Type</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</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 enum <span class="strong">ForgeChunkManager.Type</span> +extends java.lang.Enum<<a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html#ENTITY">ENTITY</a></strong></code> +<div class="block">For entity registrations</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html#NORMAL">NORMAL</a></strong></code> +<div class="block">For non-entity registrations</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"> </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 <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.Type.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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.Type.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="NORMAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NORMAL</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> NORMAL</pre> +<div class="block">For non-entity registrations</div> +</li> +</ul> +<a name="ENTITY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ENTITY</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> ENTITY</pre> +<div class="block">For entity registrations</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ForgeChunkManager.Type c : ForgeChunkManager.Type.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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.Ticket.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.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.Type.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.Type.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html new file mode 100644 index 0000000..3adfe41 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html @@ -0,0 +1,308 @@ +<!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.UnforceChunkEvent (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.UnforceChunkEvent (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.Type.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeHooks.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.UnforceChunkEvent.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.UnforceChunkEvent.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_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">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>Method</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.UnforceChunkEvent" class="title">Class ForgeChunkManager.UnforceChunkEvent</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">cpw.mods.fml.common.eventhandler.Event</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeChunkManager.UnforceChunkEvent</li> +</ul> +</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.UnforceChunkEvent</span> +extends <a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class cpw.mods.fml.common.eventhandler.<a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></h3> +<code><a href="../../../cpw/mods/fml/common/eventhandler/Event.HasResult.html" title="annotation in cpw.mods.fml.common.eventhandler">Event.HasResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.Result.html" title="enum in cpw.mods.fml.common.eventhandler">Event.Result</a></code></li> +</ul> +</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><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.UnforceChunkEvent.html#location">location</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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.UnforceChunkEvent.html#ticket">ticket</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.UnforceChunkEvent.html#ForgeChunkManager.UnforceChunkEvent(net.minecraftforge.common.ForgeChunkManager.Ticket,%20net.minecraft.world.ChunkCoordIntPair)">ForgeChunkManager.UnforceChunkEvent</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> location)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event"> +<!-- --> +</a> +<h3>Methods inherited from class cpw.mods.fml.common.eventhandler.<a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler">Event</a></h3> +<code><a href="../../../cpw/mods/fml/common/eventhandler/Event.html#getListenerList()">getListenerList</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#getPhase()">getPhase</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#getResult()">getResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#hasResult()">hasResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#isCancelable()">isCancelable</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#isCanceled()">isCanceled</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setCanceled(boolean)">setCanceled</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setPhase(cpw.mods.fml.common.eventhandler.EventPriority)">setPhase</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setResult(cpw.mods.fml.common.eventhandler.Event.Result)">setResult</a>, <a href="../../../cpw/mods/fml/common/eventhandler/Event.html#setup()">setup</a></code></li> +</ul> +<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="ticket"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ticket</h4> +<pre>public final <a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a> ticket</pre> +</li> +</ul> +<a name="location"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>location</h4> +<pre>public final <a href="../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> location</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.UnforceChunkEvent(net.minecraftforge.common.ForgeChunkManager.Ticket, net.minecraft.world.ChunkCoordIntPair)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeChunkManager.UnforceChunkEvent</h4> +<pre>public ForgeChunkManager.UnforceChunkEvent(<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> location)</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/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeHooks.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.UnforceChunkEvent.html" target="_top">Frames</a></li> +<li><a href="ForgeChunkManager.UnforceChunkEvent.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_classes_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_cpw.mods.fml.common.eventhandler.Event">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>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> 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> diff --git a/javadoc/net/minecraftforge/common/ForgeHooks.html b/javadoc/net/minecraftforge/common/ForgeHooks.html new file mode 100644 index 0000000..c94810b --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeHooks.html @@ -0,0 +1,704 @@ +<!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>ForgeHooks (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="ForgeHooks (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.UnforceChunkEvent.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeInternalHandler.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/ForgeHooks.html" target="_top">Frames</a></li> +<li><a href="ForgeHooks.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><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 ForgeHooks" class="title">Class ForgeHooks</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeHooks</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ForgeHooks</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/ForgeHooks.html#ForgeHooks()">ForgeHooks</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 float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#blockStrength(net.minecraft.block.Block,%20net.minecraft.entity.player.EntityPlayer,%20net.minecraft.world.World,%20int,%20int,%20int)">blockStrength</a></strong>(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#canHarvestBlock(net.minecraft.block.Block,%20net.minecraft.entity.player.EntityPlayer,%20int)">canHarvestBlock</a></strong>(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + int metadata)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#canInteractWith(net.minecraft.entity.player.EntityPlayer,%20net.minecraft.inventory.Container)">canInteractWith</a></strong>(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/inventory/Container.html" title="class in net.minecraft.inventory">Container</a> openContainer)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#canToolHarvestBlock(net.minecraft.block.Block,%20int,%20net.minecraft.item.ItemStack)">canToolHarvestBlock</a></strong>(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int metadata, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#getEnchantPower(net.minecraft.world.World,%20int,%20int,%20int)">getEnchantPower</a></strong>(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#getGrassSeed(net.minecraft.world.World)">getGrassSeed</a></strong>(<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 int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#getTotalArmorValue(net.minecraft.entity.player.EntityPlayer)">getTotalArmorValue</a></strong>(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#isLivingOnLadder(net.minecraft.block.Block,%20net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraft.entity.EntityLivingBase)">isLivingOnLadder</a></strong>(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#isToolEffective(net.minecraft.item.ItemStack,%20net.minecraft.block.Block,%20int)">isToolEffective</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack, + <a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int metadata)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/util/IChatComponent.html" title="interface in net.minecraft.util">IChatComponent</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#newChatWithLinks(java.lang.String)">newChatWithLinks</a></strong>(java.lang.String string)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onAnvilChange(net.minecraft.inventory.ContainerRepair,%20net.minecraft.item.ItemStack,%20net.minecraft.item.ItemStack,%20net.minecraft.inventory.IInventory,%20java.lang.String,%20int)">onAnvilChange</a></strong>(<a href="../../../net/minecraft/inventory/ContainerRepair.html" title="class in net.minecraft.inventory">ContainerRepair</a> container, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> left, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> right, + <a href="../../../net/minecraft/inventory/IInventory.html" title="interface in net.minecraft.inventory">IInventory</a> outputSlot, + java.lang.String name, + int baseCost)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onAnvilRepair(net.minecraft.entity.player.EntityPlayer,%20net.minecraft.item.ItemStack,%20net.minecraft.item.ItemStack,%20net.minecraft.item.ItemStack)">onAnvilRepair</a></strong>(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> output, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> left, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> right)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/event/world/BlockEvent.BreakEvent.html" title="class in net.minecraftforge.event.world">BlockEvent.BreakEvent</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onBlockBreakEvent(net.minecraft.world.World,%20net.minecraft.world.WorldSettings.GameType,%20net.minecraft.entity.player.EntityPlayerMP,%20int,%20int,%20int)">onBlockBreakEvent</a></strong>(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../net/minecraft/world/WorldSettings.GameType.html" title="enum in net.minecraft.world">WorldSettings.GameType</a> gameType, + <a href="../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a> entityPlayer, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingAttack(net.minecraft.entity.EntityLivingBase,%20net.minecraft.util.DamageSource,%20float)">onLivingAttack</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> src, + float amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingDeath(net.minecraft.entity.EntityLivingBase,%20net.minecraft.util.DamageSource)">onLivingDeath</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> src)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingDrops(net.minecraft.entity.EntityLivingBase,%20net.minecraft.util.DamageSource,%20java.util.ArrayList,%20int,%20boolean,%20int)">onLivingDrops</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + java.util.ArrayList<<a href="../../../net/minecraft/entity/item/EntityItem.html" title="class in net.minecraft.entity.item">EntityItem</a>> drops, + int lootingLevel, + boolean recentlyHit, + int specialDropValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingFall(net.minecraft.entity.EntityLivingBase,%20float)">onLivingFall</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + float distance)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingHurt(net.minecraft.entity.EntityLivingBase,%20net.minecraft.util.DamageSource,%20float)">onLivingHurt</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> src, + float amount)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingJump(net.minecraft.entity.EntityLivingBase)">onLivingJump</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingSetAttackTarget(net.minecraft.entity.EntityLivingBase,%20net.minecraft.entity.EntityLivingBase)">onLivingSetAttackTarget</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> target)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onLivingUpdate(net.minecraft.entity.EntityLivingBase)">onLivingUpdate</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onNoteChange(net.minecraft.tileentity.TileEntityNote,%20byte)">onNoteChange</a></strong>(<a href="../../../net/minecraft/tileentity/TileEntityNote.html" title="class in net.minecraft.tileentity">TileEntityNote</a> te, + byte old)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onPickBlock(net.minecraft.util.MovingObjectPosition,%20net.minecraft.entity.player.EntityPlayer,%20net.minecraft.world.World)">onPickBlock</a></strong>(<a href="../../../net/minecraft/util/MovingObjectPosition.html" title="class in net.minecraft.util">MovingObjectPosition</a> target, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</code> +<div class="block">Called when a player uses 'pick block', calls new Entity and Block hooks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onPlaceItemIntoWorld(net.minecraft.item.ItemStack,%20net.minecraft.entity.player.EntityPlayer,%20net.minecraft.world.World,%20int,%20int,%20int,%20int,%20float,%20float,%20float)">onPlaceItemIntoWorld</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> itemstack, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + int side, + float hitX, + float hitY, + float hitZ)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/entity/item/EntityItem.html" title="class in net.minecraft.entity.item">EntityItem</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onPlayerTossEvent(net.minecraft.entity.player.EntityPlayer,%20net.minecraft.item.ItemStack,%20boolean)">onPlayerTossEvent</a></strong>(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + boolean includeName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraft/util/ChatComponentTranslation.html" title="class in net.minecraft.util">ChatComponentTranslation</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeHooks.html#onServerChatEvent(net.minecraft.network.NetHandlerPlayServer,%20java.lang.String,%20net.minecraft.util.ChatComponentTranslation)">onServerChatEvent</a></strong>(<a href="../../../net/minecraft/network/NetHandlerPlayServer.html" title="class in net.minecraft.network">NetHandlerPlayServer</a> net, + java.lang.String raw, + <a href="../../../net/minecraft/util/ChatComponentTranslation.html" title="class in net.minecraft.util">ChatComponentTranslation</a> comp)</code> </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="ForgeHooks()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeHooks</h4> +<pre>public ForgeHooks()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getGrassSeed(net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGrassSeed</h4> +<pre>public static <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> getGrassSeed(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</pre> +</li> +</ul> +<a name="canHarvestBlock(net.minecraft.block.Block, net.minecraft.entity.player.EntityPlayer, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canHarvestBlock</h4> +<pre>public static boolean canHarvestBlock(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + int metadata)</pre> +</li> +</ul> +<a name="canToolHarvestBlock(net.minecraft.block.Block, int, net.minecraft.item.ItemStack)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canToolHarvestBlock</h4> +<pre>public static boolean canToolHarvestBlock(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int metadata, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack)</pre> +</li> +</ul> +<a name="blockStrength(net.minecraft.block.Block, net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>blockStrength</h4> +<pre>public static float blockStrength(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</pre> +</li> +</ul> +<a name="isToolEffective(net.minecraft.item.ItemStack, net.minecraft.block.Block, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isToolEffective</h4> +<pre>public static boolean isToolEffective(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack, + <a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int metadata)</pre> +</li> +</ul> +<a name="getTotalArmorValue(net.minecraft.entity.player.EntityPlayer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTotalArmorValue</h4> +<pre>public static int getTotalArmorValue(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player)</pre> +</li> +</ul> +<a name="onPickBlock(net.minecraft.util.MovingObjectPosition, net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onPickBlock</h4> +<pre>public static boolean onPickBlock(<a href="../../../net/minecraft/util/MovingObjectPosition.html" title="class in net.minecraft.util">MovingObjectPosition</a> target, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</pre> +<div class="block">Called when a player uses 'pick block', calls new Entity and Block hooks.</div> +</li> +</ul> +<a name="onLivingSetAttackTarget(net.minecraft.entity.EntityLivingBase, net.minecraft.entity.EntityLivingBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingSetAttackTarget</h4> +<pre>public static void onLivingSetAttackTarget(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> target)</pre> +</li> +</ul> +<a name="onLivingUpdate(net.minecraft.entity.EntityLivingBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingUpdate</h4> +<pre>public static boolean onLivingUpdate(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity)</pre> +</li> +</ul> +<a name="onLivingAttack(net.minecraft.entity.EntityLivingBase, net.minecraft.util.DamageSource, float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingAttack</h4> +<pre>public static boolean onLivingAttack(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> src, + float amount)</pre> +</li> +</ul> +<a name="onLivingHurt(net.minecraft.entity.EntityLivingBase, net.minecraft.util.DamageSource, float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingHurt</h4> +<pre>public static float onLivingHurt(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> src, + float amount)</pre> +</li> +</ul> +<a name="onLivingDeath(net.minecraft.entity.EntityLivingBase, net.minecraft.util.DamageSource)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingDeath</h4> +<pre>public static boolean onLivingDeath(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> src)</pre> +</li> +</ul> +<a name="onLivingDrops(net.minecraft.entity.EntityLivingBase, net.minecraft.util.DamageSource, java.util.ArrayList, int, boolean, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingDrops</h4> +<pre>public static boolean onLivingDrops(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + java.util.ArrayList<<a href="../../../net/minecraft/entity/item/EntityItem.html" title="class in net.minecraft.entity.item">EntityItem</a>> drops, + int lootingLevel, + boolean recentlyHit, + int specialDropValue)</pre> +</li> +</ul> +<a name="onLivingFall(net.minecraft.entity.EntityLivingBase, float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingFall</h4> +<pre>public static float onLivingFall(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + float distance)</pre> +</li> +</ul> +<a name="isLivingOnLadder(net.minecraft.block.Block, net.minecraft.world.World, int, int, int, net.minecraft.entity.EntityLivingBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isLivingOnLadder</h4> +<pre>public static boolean isLivingOnLadder(<a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity)</pre> +</li> +</ul> +<a name="onLivingJump(net.minecraft.entity.EntityLivingBase)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onLivingJump</h4> +<pre>public static void onLivingJump(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity)</pre> +</li> +</ul> +<a name="onPlayerTossEvent(net.minecraft.entity.player.EntityPlayer, net.minecraft.item.ItemStack, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onPlayerTossEvent</h4> +<pre>public static <a href="../../../net/minecraft/entity/item/EntityItem.html" title="class in net.minecraft.entity.item">EntityItem</a> onPlayerTossEvent(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + boolean includeName)</pre> +</li> +</ul> +<a name="getEnchantPower(net.minecraft.world.World, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnchantPower</h4> +<pre>public static float getEnchantPower(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</pre> +</li> +</ul> +<a name="onServerChatEvent(net.minecraft.network.NetHandlerPlayServer, java.lang.String, net.minecraft.util.ChatComponentTranslation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onServerChatEvent</h4> +<pre>public static <a href="../../../net/minecraft/util/ChatComponentTranslation.html" title="class in net.minecraft.util">ChatComponentTranslation</a> onServerChatEvent(<a href="../../../net/minecraft/network/NetHandlerPlayServer.html" title="class in net.minecraft.network">NetHandlerPlayServer</a> net, + java.lang.String raw, + <a href="../../../net/minecraft/util/ChatComponentTranslation.html" title="class in net.minecraft.util">ChatComponentTranslation</a> comp)</pre> +</li> +</ul> +<a name="newChatWithLinks(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newChatWithLinks</h4> +<pre>public static <a href="../../../net/minecraft/util/IChatComponent.html" title="interface in net.minecraft.util">IChatComponent</a> newChatWithLinks(java.lang.String string)</pre> +</li> +</ul> +<a name="canInteractWith(net.minecraft.entity.player.EntityPlayer, net.minecraft.inventory.Container)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canInteractWith</h4> +<pre>public static boolean canInteractWith(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/inventory/Container.html" title="class in net.minecraft.inventory">Container</a> openContainer)</pre> +</li> +</ul> +<a name="onBlockBreakEvent(net.minecraft.world.World, net.minecraft.world.WorldSettings.GameType, net.minecraft.entity.player.EntityPlayerMP, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onBlockBreakEvent</h4> +<pre>public static <a href="../../../net/minecraftforge/event/world/BlockEvent.BreakEvent.html" title="class in net.minecraftforge.event.world">BlockEvent.BreakEvent</a> onBlockBreakEvent(<a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../net/minecraft/world/WorldSettings.GameType.html" title="enum in net.minecraft.world">WorldSettings.GameType</a> gameType, + <a href="../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a> entityPlayer, + int x, + int y, + int z)</pre> +</li> +</ul> +<a name="onPlaceItemIntoWorld(net.minecraft.item.ItemStack, net.minecraft.entity.player.EntityPlayer, net.minecraft.world.World, int, int, int, int, float, float, float)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onPlaceItemIntoWorld</h4> +<pre>public static boolean onPlaceItemIntoWorld(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> itemstack, + <a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + int side, + float hitX, + float hitY, + float hitZ)</pre> +</li> +</ul> +<a name="onAnvilChange(net.minecraft.inventory.ContainerRepair, net.minecraft.item.ItemStack, net.minecraft.item.ItemStack, net.minecraft.inventory.IInventory, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onAnvilChange</h4> +<pre>public static boolean onAnvilChange(<a href="../../../net/minecraft/inventory/ContainerRepair.html" title="class in net.minecraft.inventory">ContainerRepair</a> container, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> left, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> right, + <a href="../../../net/minecraft/inventory/IInventory.html" title="interface in net.minecraft.inventory">IInventory</a> outputSlot, + java.lang.String name, + int baseCost)</pre> +</li> +</ul> +<a name="onAnvilRepair(net.minecraft.entity.player.EntityPlayer, net.minecraft.item.ItemStack, net.minecraft.item.ItemStack, net.minecraft.item.ItemStack)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onAnvilRepair</h4> +<pre>public static float onAnvilRepair(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> output, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> left, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> right)</pre> +</li> +</ul> +<a name="onNoteChange(net.minecraft.tileentity.TileEntityNote, byte)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onNoteChange</h4> +<pre>public static boolean onNoteChange(<a href="../../../net/minecraft/tileentity/TileEntityNote.html" title="class in net.minecraft.tileentity">TileEntityNote</a> te, + byte old)</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/ForgeChunkManager.UnforceChunkEvent.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeInternalHandler.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/ForgeHooks.html" target="_top">Frames</a></li> +<li><a href="ForgeHooks.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><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> diff --git a/javadoc/net/minecraftforge/common/ForgeInternalHandler.html b/javadoc/net/minecraftforge/common/ForgeInternalHandler.html new file mode 100644 index 0000000..8f38de5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeInternalHandler.html @@ -0,0 +1,293 @@ +<!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>ForgeInternalHandler (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="ForgeInternalHandler (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/ForgeHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeModContainer.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/ForgeInternalHandler.html" target="_top">Frames</a></li> +<li><a href="ForgeInternalHandler.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><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 ForgeInternalHandler" class="title">Class ForgeInternalHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeInternalHandler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ForgeInternalHandler</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/ForgeInternalHandler.html#ForgeInternalHandler()">ForgeInternalHandler</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/ForgeInternalHandler.html#onDimensionLoad(net.minecraftforge.event.world.WorldEvent.Load)">onDimensionLoad</a></strong>(<a href="../../../net/minecraftforge/event/world/WorldEvent.Load.html" title="class in net.minecraftforge.event.world">WorldEvent.Load</a> event)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeInternalHandler.html#onDimensionSave(net.minecraftforge.event.world.WorldEvent.Save)">onDimensionSave</a></strong>(<a href="../../../net/minecraftforge/event/world/WorldEvent.Save.html" title="class in net.minecraftforge.event.world">WorldEvent.Save</a> event)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeInternalHandler.html#onDimensionUnload(net.minecraftforge.event.world.WorldEvent.Unload)">onDimensionUnload</a></strong>(<a href="../../../net/minecraftforge/event/world/WorldEvent.Unload.html" title="class in net.minecraftforge.event.world">WorldEvent.Unload</a> event)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeInternalHandler.html#onEntityJoinWorld(net.minecraftforge.event.entity.EntityJoinWorldEvent)">onEntityJoinWorld</a></strong>(<a href="../../../net/minecraftforge/event/entity/EntityJoinWorldEvent.html" title="class in net.minecraftforge.event.entity">EntityJoinWorldEvent</a> event)</code> </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="ForgeInternalHandler()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeInternalHandler</h4> +<pre>public ForgeInternalHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="onEntityJoinWorld(net.minecraftforge.event.entity.EntityJoinWorldEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onEntityJoinWorld</h4> +<pre>public void onEntityJoinWorld(<a href="../../../net/minecraftforge/event/entity/EntityJoinWorldEvent.html" title="class in net.minecraftforge.event.entity">EntityJoinWorldEvent</a> event)</pre> +</li> +</ul> +<a name="onDimensionLoad(net.minecraftforge.event.world.WorldEvent.Load)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onDimensionLoad</h4> +<pre>public void onDimensionLoad(<a href="../../../net/minecraftforge/event/world/WorldEvent.Load.html" title="class in net.minecraftforge.event.world">WorldEvent.Load</a> event)</pre> +</li> +</ul> +<a name="onDimensionSave(net.minecraftforge.event.world.WorldEvent.Save)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onDimensionSave</h4> +<pre>public void onDimensionSave(<a href="../../../net/minecraftforge/event/world/WorldEvent.Save.html" title="class in net.minecraftforge.event.world">WorldEvent.Save</a> event)</pre> +</li> +</ul> +<a name="onDimensionUnload(net.minecraftforge.event.world.WorldEvent.Unload)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onDimensionUnload</h4> +<pre>public void onDimensionUnload(<a href="../../../net/minecraftforge/event/world/WorldEvent.Unload.html" title="class in net.minecraftforge.event.world">WorldEvent.Unload</a> event)</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/ForgeHooks.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeModContainer.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/ForgeInternalHandler.html" target="_top">Frames</a></li> +<li><a href="ForgeInternalHandler.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><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> diff --git a/javadoc/net/minecraftforge/common/ForgeModContainer.html b/javadoc/net/minecraftforge/common/ForgeModContainer.html new file mode 100644 index 0000000..eafdcdd --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeModContainer.html @@ -0,0 +1,733 @@ +<!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>ForgeModContainer (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="ForgeModContainer (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/ForgeInternalHandler.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeVersion.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/ForgeModContainer.html" target="_top">Frames</a></li> +<li><a href="ForgeModContainer.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><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 ForgeModContainer" class="title">Class ForgeModContainer</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">cpw.mods.fml.common.DummyModContainer</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeModContainer</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a>, <a href="../../../cpw/mods/fml/common/WorldAccessContainer.html" title="interface in cpw.mods.fml.common">WorldAccessContainer</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ForgeModContainer</span> +extends <a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a> +implements <a href="../../../cpw/mods/fml/common/WorldAccessContainer.html" title="interface in cpw.mods.fml.common">WorldAccessContainer</a></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_cpw.mods.fml.common.ModContainer"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface cpw.mods.fml.common.<a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></h3> +<code><a href="../../../cpw/mods/fml/common/ModContainer.Disableable.html" title="enum in cpw.mods.fml.common">ModContainer.Disableable</a></code></li> +</ul> +</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 int[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#blendRanges">blendRanges</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#clumpingThreshold">clumpingThreshold</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/ForgeModContainer.html#defaultSpawnFuzz">defaultSpawnFuzz</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#disableStitchedFileSaving">disableStitchedFileSaving</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#disableVersionCheck">disableVersionCheck</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#forceDuplicateFluidBlockCrash">forceDuplicateFluidBlockCrash</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#fullBoundingBoxLadders">fullBoundingBoxLadders</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#removeErroringEntities">removeErroringEntities</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#removeErroringTileEntities">removeErroringTileEntities</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#shouldSortRecipies">shouldSortRecipies</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#zombieBabyChance">zombieBabyChance</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static double</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#zombieSummonBaseChance">zombieSummonBaseChance</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_cpw.mods.fml.common.ModContainer"> +<!-- --> +</a> +<h3>Fields inherited from interface cpw.mods.fml.common.<a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></h3> +<code><a href="../../../cpw/mods/fml/common/ModContainer.html#EMPTY_PROPERTIES">EMPTY_PROPERTIES</a></code></li> +</ul> +</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/ForgeModContainer.html#ForgeModContainer()">ForgeModContainer</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 <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/ForgeModContainer.html#getConfig()">getConfig</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#getCustomResourcePackClass()">getCustomResourcePackClass</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<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/ForgeModContainer.html#getDataForWriting(net.minecraft.world.storage.SaveHandler,%20net.minecraft.world.storage.WorldInfo)">getDataForWriting</a></strong>(<a href="../../../net/minecraft/world/storage/SaveHandler.html" title="class in net.minecraft.world.storage">SaveHandler</a> handler, + <a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> info)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#getGuiClassName()">getGuiClassName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#getOwnedPackages()">getOwnedPackages</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#getSource()">getSource</a></strong>()</code> +<div class="block">The location on the file system which this mod came from</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#mappingChanged(cpw.mods.fml.common.event.FMLModIdMappingEvent)">mappingChanged</a></strong>(<a href="../../../cpw/mods/fml/common/event/FMLModIdMappingEvent.html" title="class in cpw.mods.fml.common.event">FMLModIdMappingEvent</a> evt)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#modConstruction(cpw.mods.fml.common.event.FMLConstructionEvent)">modConstruction</a></strong>(<a href="../../../cpw/mods/fml/common/event/FMLConstructionEvent.html" title="class in cpw.mods.fml.common.event">FMLConstructionEvent</a> evt)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#onAvailable(cpw.mods.fml.common.event.FMLLoadCompleteEvent)">onAvailable</a></strong>(<a href="../../../cpw/mods/fml/common/event/FMLLoadCompleteEvent.html" title="class in cpw.mods.fml.common.event">FMLLoadCompleteEvent</a> evt)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#onConfigChanged(cpw.mods.fml.client.event.ConfigChangedEvent.OnConfigChangedEvent)">onConfigChanged</a></strong>(<a href="../../../cpw/mods/fml/client/event/ConfigChangedEvent.OnConfigChangedEvent.html" title="class in cpw.mods.fml.client.event">ConfigChangedEvent.OnConfigChangedEvent</a> event)</code> +<div class="block">By subscribing to the OnConfigChangedEvent we are able to execute code when our config screens are closed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#playerLogin(cpw.mods.fml.common.gameevent.PlayerEvent.PlayerLoggedInEvent)">playerLogin</a></strong>(<a href="../../../cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedInEvent.html" title="class in cpw.mods.fml.common.gameevent">PlayerEvent.PlayerLoggedInEvent</a> event)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#postInit(cpw.mods.fml.common.event.FMLPostInitializationEvent)">postInit</a></strong>(<a href="../../../cpw/mods/fml/common/event/FMLPostInitializationEvent.html" title="class in cpw.mods.fml.common.event">FMLPostInitializationEvent</a> evt)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#preInit(cpw.mods.fml.common.event.FMLPreInitializationEvent)">preInit</a></strong>(<a href="../../../cpw/mods/fml/common/event/FMLPreInitializationEvent.html" title="class in cpw.mods.fml.common.event">FMLPreInitializationEvent</a> evt)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#readData(net.minecraft.world.storage.SaveHandler,%20net.minecraft.world.storage.WorldInfo,%20java.util.Map,%20net.minecraft.nbt.NBTTagCompound)">readData</a></strong>(<a href="../../../net/minecraft/world/storage/SaveHandler.html" title="class in net.minecraft.world.storage">SaveHandler</a> handler, + <a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> info, + java.util.Map<java.lang.String,<a href="../../../net/minecraft/nbt/NBTBase.html" title="class in net.minecraft.nbt">NBTBase</a>> propertyMap, + <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#registerBus(com.google.common.eventbus.EventBus,%20cpw.mods.fml.common.LoadController)">registerBus</a></strong>(com.google.common.eventbus.EventBus bus, + <a href="../../../cpw/mods/fml/common/LoadController.html" title="class in cpw.mods.fml.common">LoadController</a> controller)</code> +<div class="block">Register the event bus for the mod and the controller for error handling + Returns if this bus was successfully registered - disabled mods and other + mods that don't need real events should return false and avoid further + processing</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeModContainer.html#serverStarting(cpw.mods.fml.common.event.FMLServerStartingEvent)">serverStarting</a></strong>(<a href="../../../cpw/mods/fml/common/event/FMLServerStartingEvent.html" title="class in cpw.mods.fml.common.event">FMLServerStartingEvent</a> evt)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_cpw.mods.fml.common.DummyModContainer"> +<!-- --> +</a> +<h3>Methods inherited from class cpw.mods.fml.common.<a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></h3> +<code><a href="../../../cpw/mods/fml/common/DummyModContainer.html#acceptableMinecraftVersionRange()">acceptableMinecraftVersionRange</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#bindMetadata(cpw.mods.fml.common.MetadataCollection)">bindMetadata</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#canBeDisabled()">canBeDisabled</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getCustomModProperties()">getCustomModProperties</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getDependants()">getDependants</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getDependencies()">getDependencies</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getDisplayVersion()">getDisplayVersion</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getMetadata()">getMetadata</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getMod()">getMod</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getModId()">getModId</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getName()">getName</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getProcessedVersion()">getProcessedVersion</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getRequirements()">getRequirements</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getSharedModDescriptor()">getSharedModDescriptor</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getSigningCertificate()">getSigningCertificate</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getSortingRules()">getSortingRules</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#getVersion()">getVersion</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#isImmutable()">isImmutable</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#matches(java.lang.Object)">matches</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#setEnabledState(boolean)">setEnabledState</a>, <a href="../../../cpw/mods/fml/common/DummyModContainer.html#toString()">toString</a></code></li> +</ul> +<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, 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="clumpingThreshold"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clumpingThreshold</h4> +<pre>public static int clumpingThreshold</pre> +</li> +</ul> +<a name="removeErroringEntities"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeErroringEntities</h4> +<pre>public static boolean removeErroringEntities</pre> +</li> +</ul> +<a name="removeErroringTileEntities"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeErroringTileEntities</h4> +<pre>public static boolean removeErroringTileEntities</pre> +</li> +</ul> +<a name="disableStitchedFileSaving"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disableStitchedFileSaving</h4> +<pre>public static boolean disableStitchedFileSaving</pre> +</li> +</ul> +<a name="forceDuplicateFluidBlockCrash"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forceDuplicateFluidBlockCrash</h4> +<pre>public static boolean forceDuplicateFluidBlockCrash</pre> +</li> +</ul> +<a name="fullBoundingBoxLadders"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fullBoundingBoxLadders</h4> +<pre>public static boolean fullBoundingBoxLadders</pre> +</li> +</ul> +<a name="zombieSummonBaseChance"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>zombieSummonBaseChance</h4> +<pre>public static double zombieSummonBaseChance</pre> +</li> +</ul> +<a name="blendRanges"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>blendRanges</h4> +<pre>public static int[] blendRanges</pre> +</li> +</ul> +<a name="zombieBabyChance"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>zombieBabyChance</h4> +<pre>public static float zombieBabyChance</pre> +</li> +</ul> +<a name="shouldSortRecipies"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldSortRecipies</h4> +<pre>public static boolean shouldSortRecipies</pre> +</li> +</ul> +<a name="disableVersionCheck"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disableVersionCheck</h4> +<pre>public static boolean disableVersionCheck</pre> +</li> +</ul> +<a name="defaultSpawnFuzz"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>defaultSpawnFuzz</h4> +<pre>public static int defaultSpawnFuzz</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ForgeModContainer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeModContainer</h4> +<pre>public ForgeModContainer()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getGuiClassName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getGuiClassName</h4> +<pre>public java.lang.String getGuiClassName()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/ModContainer.html#getGuiClassName()">getGuiClassName</a></code> in interface <code><a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/DummyModContainer.html#getGuiClassName()">getGuiClassName</a></code> in class <code><a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></code></dd> +</dl> +</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="onConfigChanged(cpw.mods.fml.client.event.ConfigChangedEvent.OnConfigChangedEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onConfigChanged</h4> +<pre>public void onConfigChanged(<a href="../../../cpw/mods/fml/client/event/ConfigChangedEvent.OnConfigChangedEvent.html" title="class in cpw.mods.fml.client.event">ConfigChangedEvent.OnConfigChangedEvent</a> event)</pre> +<div class="block">By subscribing to the OnConfigChangedEvent we are able to execute code when our config screens are closed. + This implementation uses the optional configID string to handle multiple Configurations using one event handler.</div> +</li> +</ul> +<a name="playerLogin(cpw.mods.fml.common.gameevent.PlayerEvent.PlayerLoggedInEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>playerLogin</h4> +<pre>public void playerLogin(<a href="../../../cpw/mods/fml/common/gameevent/PlayerEvent.PlayerLoggedInEvent.html" title="class in cpw.mods.fml.common.gameevent">PlayerEvent.PlayerLoggedInEvent</a> event)</pre> +</li> +</ul> +<a name="registerBus(com.google.common.eventbus.EventBus, cpw.mods.fml.common.LoadController)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>registerBus</h4> +<pre>public boolean registerBus(com.google.common.eventbus.EventBus bus, + <a href="../../../cpw/mods/fml/common/LoadController.html" title="class in cpw.mods.fml.common">LoadController</a> controller)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../cpw/mods/fml/common/ModContainer.html#registerBus(com.google.common.eventbus.EventBus,%20cpw.mods.fml.common.LoadController)">ModContainer</a></code></strong></div> +<div class="block">Register the event bus for the mod and the controller for error handling + Returns if this bus was successfully registered - disabled mods and other + mods that don't need real events should return false and avoid further + processing</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/ModContainer.html#registerBus(com.google.common.eventbus.EventBus,%20cpw.mods.fml.common.LoadController)">registerBus</a></code> in interface <code><a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/DummyModContainer.html#registerBus(com.google.common.eventbus.EventBus,%20cpw.mods.fml.common.LoadController)">registerBus</a></code> in class <code><a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></code></dd> +</dl> +</li> +</ul> +<a name="modConstruction(cpw.mods.fml.common.event.FMLConstructionEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>modConstruction</h4> +<pre>public void modConstruction(<a href="../../../cpw/mods/fml/common/event/FMLConstructionEvent.html" title="class in cpw.mods.fml.common.event">FMLConstructionEvent</a> evt)</pre> +</li> +</ul> +<a name="preInit(cpw.mods.fml.common.event.FMLPreInitializationEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>preInit</h4> +<pre>public void preInit(<a href="../../../cpw/mods/fml/common/event/FMLPreInitializationEvent.html" title="class in cpw.mods.fml.common.event">FMLPreInitializationEvent</a> evt)</pre> +</li> +</ul> +<a name="postInit(cpw.mods.fml.common.event.FMLPostInitializationEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>postInit</h4> +<pre>public void postInit(<a href="../../../cpw/mods/fml/common/event/FMLPostInitializationEvent.html" title="class in cpw.mods.fml.common.event">FMLPostInitializationEvent</a> evt)</pre> +</li> +</ul> +<a name="onAvailable(cpw.mods.fml.common.event.FMLLoadCompleteEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onAvailable</h4> +<pre>public void onAvailable(<a href="../../../cpw/mods/fml/common/event/FMLLoadCompleteEvent.html" title="class in cpw.mods.fml.common.event">FMLLoadCompleteEvent</a> evt)</pre> +</li> +</ul> +<a name="serverStarting(cpw.mods.fml.common.event.FMLServerStartingEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>serverStarting</h4> +<pre>public void serverStarting(<a href="../../../cpw/mods/fml/common/event/FMLServerStartingEvent.html" title="class in cpw.mods.fml.common.event">FMLServerStartingEvent</a> evt)</pre> +</li> +</ul> +<a name="getDataForWriting(net.minecraft.world.storage.SaveHandler, net.minecraft.world.storage.WorldInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataForWriting</h4> +<pre>public <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> getDataForWriting(<a href="../../../net/minecraft/world/storage/SaveHandler.html" title="class in net.minecraft.world.storage">SaveHandler</a> handler, + <a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> info)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/WorldAccessContainer.html#getDataForWriting(net.minecraft.world.storage.SaveHandler,%20net.minecraft.world.storage.WorldInfo)">getDataForWriting</a></code> in interface <code><a href="../../../cpw/mods/fml/common/WorldAccessContainer.html" title="interface in cpw.mods.fml.common">WorldAccessContainer</a></code></dd> +</dl> +</li> +</ul> +<a name="readData(net.minecraft.world.storage.SaveHandler, net.minecraft.world.storage.WorldInfo, java.util.Map, net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readData</h4> +<pre>public void readData(<a href="../../../net/minecraft/world/storage/SaveHandler.html" title="class in net.minecraft.world.storage">SaveHandler</a> handler, + <a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> info, + java.util.Map<java.lang.String,<a href="../../../net/minecraft/nbt/NBTBase.html" title="class in net.minecraft.nbt">NBTBase</a>> propertyMap, + <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/WorldAccessContainer.html#readData(net.minecraft.world.storage.SaveHandler,%20net.minecraft.world.storage.WorldInfo,%20java.util.Map,%20net.minecraft.nbt.NBTTagCompound)">readData</a></code> in interface <code><a href="../../../cpw/mods/fml/common/WorldAccessContainer.html" title="interface in cpw.mods.fml.common">WorldAccessContainer</a></code></dd> +</dl> +</li> +</ul> +<a name="mappingChanged(cpw.mods.fml.common.event.FMLModIdMappingEvent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>mappingChanged</h4> +<pre>public void mappingChanged(<a href="../../../cpw/mods/fml/common/event/FMLModIdMappingEvent.html" title="class in cpw.mods.fml.common.event">FMLModIdMappingEvent</a> evt)</pre> +</li> +</ul> +<a name="getSource()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSource</h4> +<pre>public java.io.File getSource()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../cpw/mods/fml/common/ModContainer.html#getSource()">ModContainer</a></code></strong></div> +<div class="block">The location on the file system which this mod came from</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/ModContainer.html#getSource()">getSource</a></code> in interface <code><a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/DummyModContainer.html#getSource()">getSource</a></code> in class <code><a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></code></dd> +</dl> +</li> +</ul> +<a name="getCustomResourcePackClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCustomResourcePackClass</h4> +<pre>public java.lang.Class<?> getCustomResourcePackClass()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/ModContainer.html#getCustomResourcePackClass()">getCustomResourcePackClass</a></code> in interface <code><a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/DummyModContainer.html#getCustomResourcePackClass()">getCustomResourcePackClass</a></code> in class <code><a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></code></dd> +</dl> +</li> +</ul> +<a name="getOwnedPackages()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getOwnedPackages</h4> +<pre>public java.util.List<java.lang.String> getOwnedPackages()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/ModContainer.html#getOwnedPackages()">getOwnedPackages</a></code> in interface <code><a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../cpw/mods/fml/common/DummyModContainer.html#getOwnedPackages()">getOwnedPackages</a></code> in class <code><a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common">DummyModContainer</a></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="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/ForgeInternalHandler.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeVersion.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/ForgeModContainer.html" target="_top">Frames</a></li> +<li><a href="ForgeModContainer.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><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> diff --git a/javadoc/net/minecraftforge/common/ForgeVersion.Status.html b/javadoc/net/minecraftforge/common/ForgeVersion.Status.html new file mode 100644 index 0000000..b7f1714 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeVersion.Status.html @@ -0,0 +1,381 @@ +<!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>ForgeVersion.Status (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="ForgeVersion.Status (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/ForgeVersion.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IExtendedEntityProperties.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/ForgeVersion.Status.html" target="_top">Frames</a></li> +<li><a href="ForgeVersion.Status.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum ForgeVersion.Status" class="title">Enum ForgeVersion.Status</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeVersion.Status</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../net/minecraftforge/common/ForgeVersion.html" title="class in net.minecraftforge.common">ForgeVersion</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">ForgeVersion.Status</span> +extends java.lang.Enum<<a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#AHEAD">AHEAD</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#BETA">BETA</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#BETA_OUTDATED">BETA_OUTDATED</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#FAILED">FAILED</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#OUTDATED">OUTDATED</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#PENDING">PENDING</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#UP_TO_DATE">UP_TO_DATE</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 <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="PENDING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PENDING</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> PENDING</pre> +</li> +</ul> +<a name="FAILED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FAILED</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> FAILED</pre> +</li> +</ul> +<a name="UP_TO_DATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UP_TO_DATE</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> UP_TO_DATE</pre> +</li> +</ul> +<a name="OUTDATED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OUTDATED</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> OUTDATED</pre> +</li> +</ul> +<a name="AHEAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AHEAD</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> AHEAD</pre> +</li> +</ul> +<a name="BETA"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BETA</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> BETA</pre> +</li> +</ul> +<a name="BETA_OUTDATED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BETA_OUTDATED</h4> +<pre>public static final <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> BETA_OUTDATED</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ForgeVersion.Status c : ForgeVersion.Status.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</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/ForgeVersion.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IExtendedEntityProperties.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/ForgeVersion.Status.html" target="_top">Frames</a></li> +<li><a href="ForgeVersion.Status.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/ForgeVersion.html b/javadoc/net/minecraftforge/common/ForgeVersion.html new file mode 100644 index 0000000..be1e4f8 --- /dev/null +++ b/javadoc/net/minecraftforge/common/ForgeVersion.html @@ -0,0 +1,443 @@ +<!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>ForgeVersion (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="ForgeVersion (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/ForgeModContainer.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeVersion.Status.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/ForgeVersion.html" target="_top">Frames</a></li> +<li><a href="ForgeVersion.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 ForgeVersion" class="title">Class ForgeVersion</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ForgeVersion</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ForgeVersion</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/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</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 int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#buildVersion">buildVersion</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#majorVersion">majorVersion</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/ForgeVersion.html#minorVersion">minorVersion</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#revisionVersion">revisionVersion</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/ForgeVersion.html#ForgeVersion()">ForgeVersion</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 int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#getBuildVersion()">getBuildVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#getMajorVersion()">getMajorVersion</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/ForgeVersion.html#getMinorVersion()">getMinorVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#getRevisionVersion()">getRevisionVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#getStatus()">getStatus</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#getTarget()">getTarget</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#getVersion()">getVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ForgeVersion.html#startVersionCheck()">startVersionCheck</a></strong>()</code> </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="majorVersion"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>majorVersion</h4> +<pre>public static final int majorVersion</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ForgeVersion.majorVersion">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="minorVersion"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>minorVersion</h4> +<pre>public static final int minorVersion</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ForgeVersion.minorVersion">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="revisionVersion"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>revisionVersion</h4> +<pre>public static final int revisionVersion</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ForgeVersion.revisionVersion">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="buildVersion"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>buildVersion</h4> +<pre>public static final int buildVersion</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.ForgeVersion.buildVersion">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ForgeVersion()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeVersion</h4> +<pre>public ForgeVersion()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMajorVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMajorVersion</h4> +<pre>public static int getMajorVersion()</pre> +</li> +</ul> +<a name="getMinorVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinorVersion</h4> +<pre>public static int getMinorVersion()</pre> +</li> +</ul> +<a name="getRevisionVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRevisionVersion</h4> +<pre>public static int getRevisionVersion()</pre> +</li> +</ul> +<a name="getBuildVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBuildVersion</h4> +<pre>public static int getBuildVersion()</pre> +</li> +</ul> +<a name="getStatus()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatus</h4> +<pre>public static <a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a> getStatus()</pre> +</li> +</ul> +<a name="getTarget()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTarget</h4> +<pre>public static java.lang.String getTarget()</pre> +</li> +</ul> +<a name="getVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersion</h4> +<pre>public static java.lang.String getVersion()</pre> +</li> +</ul> +<a name="startVersionCheck()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>startVersionCheck</h4> +<pre>public static void startVersionCheck()</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/ForgeModContainer.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ForgeVersion.Status.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/ForgeVersion.html" target="_top">Frames</a></li> +<li><a href="ForgeVersion.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> diff --git a/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html b/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html new file mode 100644 index 0000000..efb8871 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html @@ -0,0 +1,253 @@ +<!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>IExtendedEntityProperties (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="IExtendedEntityProperties (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/ForgeVersion.Status.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.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/IExtendedEntityProperties.html" target="_top">Frames</a></li> +<li><a href="IExtendedEntityProperties.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 IExtendedEntityProperties" class="title">Interface IExtendedEntityProperties</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">IExtendedEntityProperties</span></pre> +<div class="block">Allows for custom entity data and logic to be hooked to existing entity classes.</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IExtendedEntityProperties.html#init(net.minecraft.entity.Entity,%20net.minecraft.world.World)">init</a></strong>(<a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> entity, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</code> +<div class="block">Used to initialize the extended properties with the entity that this is attached to, as well + as the world object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IExtendedEntityProperties.html#loadNBTData(net.minecraft.nbt.NBTTagCompound)">loadNBTData</a></strong>(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compound)</code> +<div class="block">Called when the entity that this class is attached to is loaded.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IExtendedEntityProperties.html#saveNBTData(net.minecraft.nbt.NBTTagCompound)">saveNBTData</a></strong>(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compound)</code> +<div class="block">Called when the entity that this class is attached to is saved.</div> +</td> +</tr> +</table> +</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="saveNBTData(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>saveNBTData</h4> +<pre>void saveNBTData(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compound)</pre> +<div class="block">Called when the entity that this class is attached to is saved. + Any custom entity data that needs saving should be saved here.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>compound</code> - The compound to save to.</dd></dl> +</li> +</ul> +<a name="loadNBTData(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadNBTData</h4> +<pre>void loadNBTData(<a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compound)</pre> +<div class="block">Called when the entity that this class is attached to is loaded. + In order to hook into this, you will need to subscribe to the EntityConstructing event. + Otherwise, you will need to initialize manually.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>compound</code> - The compound to load from.</dd></dl> +</li> +</ul> +<a name="init(net.minecraft.entity.Entity, net.minecraft.world.World)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>init</h4> +<pre>void init(<a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> entity, + <a href="../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world)</pre> +<div class="block">Used to initialize the extended properties with the entity that this is attached to, as well + as the world object. + Called automatically if you register with the EntityConstructing event. + May be called multiple times if the extended properties is moved over to a new entity. + Such as when a player switches dimension {Minecraft re-creates the player entity}</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - The entity that this extended properties is attached to</dd><dd><code>world</code> - The world in which the entity exists</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/ForgeVersion.Status.html" title="enum in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.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/IExtendedEntityProperties.html" target="_top">Frames</a></li> +<li><a href="IExtendedEntityProperties.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> diff --git a/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html b/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html new file mode 100644 index 0000000..cdc7fd7 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html @@ -0,0 +1,274 @@ +<!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>IMinecartCollisionHandler (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="IMinecartCollisionHandler (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/IExtendedEntityProperties.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IPlantable.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/IMinecartCollisionHandler.html" target="_top">Frames</a></li> +<li><a href="IMinecartCollisionHandler.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 IMinecartCollisionHandler" class="title">Interface IMinecartCollisionHandler</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">IMinecartCollisionHandler</span></pre> +<div class="block">This class defines a replacement for the default minecart collision code. + Only one handler can be registered at a time. It it registered with EntityMinecart.registerCollisionHandler(). + If you use this, make it a configuration option.</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><a href="../../../net/minecraft/util/AxisAlignedBB.html" title="class in net.minecraft.util">AxisAlignedBB</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.html#getBoundingBox(net.minecraft.entity.item.EntityMinecart)">getBoundingBox</a></strong>(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart)</code> +<div class="block">This function replaces the function of the same name in EntityMinecart.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/util/AxisAlignedBB.html" title="class in net.minecraft.util">AxisAlignedBB</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.html#getCollisionBox(net.minecraft.entity.item.EntityMinecart,%20net.minecraft.entity.Entity)">getCollisionBox</a></strong>(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart, + <a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> other)</code> +<div class="block">This function replaced the function of the same name in EntityMinecart.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/util/AxisAlignedBB.html" title="class in net.minecraft.util">AxisAlignedBB</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.html#getMinecartCollisionBox(net.minecraft.entity.item.EntityMinecart)">getMinecartCollisionBox</a></strong>(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart)</code> +<div class="block">This function is used to define the box used for detecting minecart collisions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.html#onEntityCollision(net.minecraft.entity.item.EntityMinecart,%20net.minecraft.entity.Entity)">onEntityCollision</a></strong>(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart, + <a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> other)</code> +<div class="block">This basically replaces the function of the same name in EnityMinecart.</div> +</td> +</tr> +</table> +</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="onEntityCollision(net.minecraft.entity.item.EntityMinecart, net.minecraft.entity.Entity)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onEntityCollision</h4> +<pre>void onEntityCollision(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart, + <a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> other)</pre> +<div class="block">This basically replaces the function of the same name in EnityMinecart. + Code in IMinecartHooks.applyEntityCollisionHook is still run.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cart</code> - The cart that called the collision.</dd><dd><code>other</code> - The object it collided with.</dd></dl> +</li> +</ul> +<a name="getCollisionBox(net.minecraft.entity.item.EntityMinecart, net.minecraft.entity.Entity)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCollisionBox</h4> +<pre><a href="../../../net/minecraft/util/AxisAlignedBB.html" title="class in net.minecraft.util">AxisAlignedBB</a> getCollisionBox(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart, + <a href="../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a> other)</pre> +<div class="block">This function replaced the function of the same name in EntityMinecart. + It is used to define whether minecarts collide with specific entities, + for example items.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cart</code> - The cart for which the collision box was requested.</dd><dd><code>other</code> - The entity requesting the collision box.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The collision box or null.</dd></dl> +</li> +</ul> +<a name="getMinecartCollisionBox(net.minecraft.entity.item.EntityMinecart)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinecartCollisionBox</h4> +<pre><a href="../../../net/minecraft/util/AxisAlignedBB.html" title="class in net.minecraft.util">AxisAlignedBB</a> getMinecartCollisionBox(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart)</pre> +<div class="block">This function is used to define the box used for detecting minecart collisions. + It is generally bigger that the normal collision box.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cart</code> - The cart for which the collision box was requested.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The collision box, cannot be null.</dd></dl> +</li> +</ul> +<a name="getBoundingBox(net.minecraft.entity.item.EntityMinecart)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getBoundingBox</h4> +<pre><a href="../../../net/minecraft/util/AxisAlignedBB.html" title="class in net.minecraft.util">AxisAlignedBB</a> getBoundingBox(<a href="../../../net/minecraft/entity/item/EntityMinecart.html" title="class in net.minecraft.entity.item">EntityMinecart</a> cart)</pre> +<div class="block">This function replaces the function of the same name in EntityMinecart. + It defines whether minecarts are solid to the player.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cart</code> - The cart for which the bounding box was requested.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The bounding box or null.</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/IExtendedEntityProperties.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IPlantable.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/IMinecartCollisionHandler.html" target="_top">Frames</a></li> +<li><a href="IMinecartCollisionHandler.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> diff --git a/javadoc/net/minecraftforge/common/IPlantable.html b/javadoc/net/minecraftforge/common/IPlantable.html new file mode 100644 index 0000000..879c444 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IPlantable.html @@ -0,0 +1,252 @@ +<!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>IPlantable (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="IPlantable (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/IMinecartCollisionHandler.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IShearable.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/IPlantable.html" target="_top">Frames</a></li> +<li><a href="IPlantable.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 IPlantable" class="title">Interface IPlantable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../net/minecraft/block/BlockBush.html" title="class in net.minecraft.block">BlockBush</a>, <a href="../../../net/minecraft/block/BlockCactus.html" title="class in net.minecraft.block">BlockCactus</a>, <a href="../../../net/minecraft/block/BlockCarrot.html" title="class in net.minecraft.block">BlockCarrot</a>, <a href="../../../net/minecraft/block/BlockCrops.html" title="class in net.minecraft.block">BlockCrops</a>, <a href="../../../net/minecraft/block/BlockDeadBush.html" title="class in net.minecraft.block">BlockDeadBush</a>, <a href="../../../net/minecraft/block/BlockDoublePlant.html" title="class in net.minecraft.block">BlockDoublePlant</a>, <a href="../../../net/minecraft/block/BlockFlower.html" title="class in net.minecraft.block">BlockFlower</a>, <a href="../../../net/minecraft/block/BlockLilyPad.html" title="class in net.minecraft.block">BlockLilyPad</a>, <a href="../../../net/minecraft/block/BlockMushroom.html" title="class in net.minecraft.block">BlockMushroom</a>, <a href="../../../net/minecraft/block/BlockNetherWart.html" title="class in net.minecraft.block">BlockNetherWart</a>, <a href="../../../net/minecraft/block/BlockPotato.html" title="class in net.minecraft.block">BlockPotato</a>, <a href="../../../net/minecraft/block/BlockReed.html" title="class in net.minecraft.block">BlockReed</a>, <a href="../../../net/minecraft/block/BlockSapling.html" title="class in net.minecraft.block">BlockSapling</a>, <a href="../../../net/minecraft/block/BlockStem.html" title="class in net.minecraft.block">BlockStem</a>, <a href="../../../net/minecraft/block/BlockTallGrass.html" title="class in net.minecraft.block">BlockTallGrass</a>, <a href="../../../net/minecraft/item/ItemSeedFood.html" title="class in net.minecraft.item">ItemSeedFood</a>, <a href="../../../net/minecraft/item/ItemSeeds.html" title="class in net.minecraft.item">ItemSeeds</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IPlantable</span></pre> +</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><a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IPlantable.html#getPlant(net.minecraft.world.IBlockAccess,%20int,%20int,%20int)">getPlant</a></strong>(<a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IPlantable.html#getPlantMetadata(net.minecraft.world.IBlockAccess,%20int,%20int,%20int)">getPlantMetadata</a></strong>(<a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IPlantable.html#getPlantType(net.minecraft.world.IBlockAccess,%20int,%20int,%20int)">getPlantType</a></strong>(<a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</code> </td> +</tr> +</table> +</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="getPlantType(net.minecraft.world.IBlockAccess, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPlantType</h4> +<pre><a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a> getPlantType(<a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</pre> +</li> +</ul> +<a name="getPlant(net.minecraft.world.IBlockAccess, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPlant</h4> +<pre><a href="../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> getPlant(<a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</pre> +</li> +</ul> +<a name="getPlantMetadata(net.minecraft.world.IBlockAccess, int, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getPlantMetadata</h4> +<pre>int getPlantMetadata(<a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</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/IMinecartCollisionHandler.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/IShearable.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/IPlantable.html" target="_top">Frames</a></li> +<li><a href="IPlantable.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> diff --git a/javadoc/net/minecraftforge/common/IShearable.html b/javadoc/net/minecraftforge/common/IShearable.html new file mode 100644 index 0000000..4c316d5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/IShearable.html @@ -0,0 +1,264 @@ +<!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>IShearable (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="IShearable (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/IPlantable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.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/IShearable.html" target="_top">Frames</a></li> +<li><a href="IShearable.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 IShearable" class="title">Interface IShearable</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../net/minecraft/block/BlockDeadBush.html" title="class in net.minecraft.block">BlockDeadBush</a>, <a href="../../../net/minecraft/block/BlockDoublePlant.html" title="class in net.minecraft.block">BlockDoublePlant</a>, <a href="../../../net/minecraft/block/BlockLeaves.html" title="class in net.minecraft.block">BlockLeaves</a>, <a href="../../../net/minecraft/block/BlockNewLeaf.html" title="class in net.minecraft.block">BlockNewLeaf</a>, <a href="../../../net/minecraft/block/BlockOldLeaf.html" title="class in net.minecraft.block">BlockOldLeaf</a>, <a href="../../../net/minecraft/block/BlockTallGrass.html" title="class in net.minecraft.block">BlockTallGrass</a>, <a href="../../../net/minecraft/block/BlockVine.html" title="class in net.minecraft.block">BlockVine</a>, <a href="../../../net/minecraft/entity/passive/EntityMooshroom.html" title="class in net.minecraft.entity.passive">EntityMooshroom</a>, <a href="../../../net/minecraft/entity/passive/EntitySheep.html" title="class in net.minecraft.entity.passive">EntitySheep</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">IShearable</span></pre> +<div class="block">This allows for mods to create there own Shear-like items + and have them interact with Blocks/Entities without extra work. + Also, if your block/entity supports the Shears, this allows you + to support mod-shears as well.</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IShearable.html#isShearable(net.minecraft.item.ItemStack,%20net.minecraft.world.IBlockAccess,%20int,%20int,%20int)">isShearable</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</code> +<div class="block">Checks if the object is currently shearable + Example: Sheep return false when they have no wool</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.ArrayList<<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/IShearable.html#onSheared(net.minecraft.item.ItemStack,%20net.minecraft.world.IBlockAccess,%20int,%20int,%20int,%20int)">onSheared</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z, + int fortune)</code> +<div class="block">Performs the shear function on this object.</div> +</td> +</tr> +</table> +</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="isShearable(net.minecraft.item.ItemStack, net.minecraft.world.IBlockAccess, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isShearable</h4> +<pre>boolean isShearable(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z)</pre> +<div class="block">Checks if the object is currently shearable + Example: Sheep return false when they have no wool</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The itemstack that is being used, Possible to be null</dd><dd><code>world</code> - The current world</dd><dd><code>x</code> - The X Position</dd><dd><code>y</code> - The Y Position</dd><dd><code>z</code> - The Z Position</dd> +<dt><span class="strong">Returns:</span></dt><dd>If this is shearable, and onSheared should be called.</dd></dl> +</li> +</ul> +<a name="onSheared(net.minecraft.item.ItemStack, net.minecraft.world.IBlockAccess, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onSheared</h4> +<pre>java.util.ArrayList<<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>> onSheared(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> item, + <a href="../../../net/minecraft/world/IBlockAccess.html" title="interface in net.minecraft.world">IBlockAccess</a> world, + int x, + int y, + int z, + int fortune)</pre> +<div class="block">Performs the shear function on this object. + This is called for both client, and server. + The object should perform all actions related to being sheared, + except for dropping of the items, and removal of the block. + As those are handled by ItemShears itself. + + Returns a list of items that resulted from the shearing process. + + For entities, they should trust there internal location information + over the values passed into this function.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - The itemstack that is being used, Possible to be null</dd><dd><code>world</code> - The current world</dd><dd><code>x</code> - The X Position</dd><dd><code>y</code> - The Y Position</dd><dd><code>z</code> - The Z Position</dd><dd><code>fortune</code> - The fortune level of the shears being used</dd> +<dt><span class="strong">Returns:</span></dt><dd>A ArrayList containing all items from this shearing. Possible to be null.</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/IPlantable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.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/IShearable.html" target="_top">Frames</a></li> +<li><a href="IShearable.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> diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html b/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html new file mode 100644 index 0000000..57b3f9a --- /dev/null +++ b/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html @@ -0,0 +1,400 @@ +<!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>ISpecialArmor.ArmorProperties (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="ISpecialArmor.ArmorProperties (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/ISpecialArmor.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/MinecraftForge.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/ISpecialArmor.ArmorProperties.html" target="_top">Frames</a></li> +<li><a href="ISpecialArmor.ArmorProperties.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><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 ISpecialArmor.ArmorProperties" class="title">Class ISpecialArmor.ArmorProperties</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.ISpecialArmor.ArmorProperties</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Comparable<<a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../net/minecraftforge/common/ISpecialArmor.html" title="interface in net.minecraftforge.common">ISpecialArmor</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ISpecialArmor.ArmorProperties</span> +extends java.lang.Object +implements java.lang.Comparable<<a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a>></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>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#AbsorbMax">AbsorbMax</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#AbsorbRatio">AbsorbRatio</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#Priority">Priority</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#Slot">Slot</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/ISpecialArmor.ArmorProperties.html#ISpecialArmor.ArmorProperties(int,%20double,%20int)">ISpecialArmor.ArmorProperties</a></strong>(int priority, + double ratio, + int max)</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 float</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#ApplyArmor(net.minecraft.entity.EntityLivingBase,%20net.minecraft.item.ItemStack[],%20net.minecraft.util.DamageSource,%20double)">ApplyArmor</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>[] inventory, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + double damage)</code> +<div class="block">Gathers and applies armor reduction to damage being dealt to a entity.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#compareTo(net.minecraftforge.common.ISpecialArmor.ArmorProperties)">compareTo</a></strong>(<a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a> o)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#copy()">copy</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html#toString()">toString</a></strong>()</code> </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, 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="Priority"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Priority</h4> +<pre>public int Priority</pre> +</li> +</ul> +<a name="AbsorbMax"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbsorbMax</h4> +<pre>public int AbsorbMax</pre> +</li> +</ul> +<a name="AbsorbRatio"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>AbsorbRatio</h4> +<pre>public double AbsorbRatio</pre> +</li> +</ul> +<a name="Slot"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Slot</h4> +<pre>public int Slot</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ISpecialArmor.ArmorProperties(int, double, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ISpecialArmor.ArmorProperties</h4> +<pre>public ISpecialArmor.ArmorProperties(int priority, + double ratio, + int max)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="ApplyArmor(net.minecraft.entity.EntityLivingBase, net.minecraft.item.ItemStack[], net.minecraft.util.DamageSource, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ApplyArmor</h4> +<pre>public static float ApplyArmor(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a>[] inventory, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + double damage)</pre> +<div class="block">Gathers and applies armor reduction to damage being dealt to a entity.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - The Entity being damage</dd><dd><code>inventory</code> - An array of armor items</dd><dd><code>source</code> - The damage source type</dd><dd><code>damage</code> - The total damage being done</dd> +<dt><span class="strong">Returns:</span></dt><dd>The left over damage that has not been absorbed by the armor</dd></dl> +</li> +</ul> +<a name="compareTo(net.minecraftforge.common.ISpecialArmor.ArmorProperties)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>public int compareTo(<a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a> o)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compareTo</code> in interface <code>java.lang.Comparable<<a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a>></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="copy()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>copy</h4> +<pre>public <a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a> copy()</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/ISpecialArmor.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/MinecraftForge.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/ISpecialArmor.ArmorProperties.html" target="_top">Frames</a></li> +<li><a href="ISpecialArmor.ArmorProperties.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><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> diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.html b/javadoc/net/minecraftforge/common/ISpecialArmor.html new file mode 100644 index 0000000..dbf967a --- /dev/null +++ b/javadoc/net/minecraftforge/common/ISpecialArmor.html @@ -0,0 +1,296 @@ +<!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>ISpecialArmor (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="ISpecialArmor (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/IShearable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.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/ISpecialArmor.html" target="_top">Frames</a></li> +<li><a href="ISpecialArmor.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>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 ISpecialArmor" class="title">Interface ISpecialArmor</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ISpecialArmor</span></pre> +<div class="block">This interface is to be implemented by ItemArmor classes. It will allow to + modify computation of damage and health loss. Computation will be called + before the actual armor computation, which can then be cancelled.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../net/minecraft/item/ItemArmor.html" title="class in net.minecraft.item"><code>ItemArmor</code></a></dd></dl> +</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">Interface 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/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</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/ISpecialArmor.html#damageArmor(net.minecraft.entity.EntityLivingBase,%20net.minecraft.item.ItemStack,%20net.minecraft.util.DamageSource,%20int,%20int)">damageArmor</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + int damage, + int slot)</code> +<div class="block">Applies damage to the ItemStack.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.html#getArmorDisplay(net.minecraft.entity.player.EntityPlayer,%20net.minecraft.item.ItemStack,%20int)">getArmorDisplay</a></strong>(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + int slot)</code> +<div class="block">Get the displayed effective armor.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/ISpecialArmor.html#getProperties(net.minecraft.entity.EntityLivingBase,%20net.minecraft.item.ItemStack,%20net.minecraft.util.DamageSource,%20double,%20int)">getProperties</a></strong>(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + double damage, + int slot)</code> +<div class="block">Retrieves the modifiers to be used when calculating armor damage.</div> +</td> +</tr> +</table> +</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="getProperties(net.minecraft.entity.EntityLivingBase, net.minecraft.item.ItemStack, net.minecraft.util.DamageSource, double, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a> getProperties(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + double damage, + int slot)</pre> +<div class="block">Retrieves the modifiers to be used when calculating armor damage. + + Armor will higher priority will have damage applied to them before + lower priority ones. If there are multiple pieces of armor with the + same priority, damage will be distributed between them based on there + absorption ratio.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>player</code> - The entity wearing the armor.</dd><dd><code>armor</code> - The ItemStack of the armor item itself.</dd><dd><code>source</code> - The source of the damage, which can be used to alter armor + properties based on the type or source of damage.</dd><dd><code>damage</code> - The total damage being applied to the entity</dd><dd><code>slot</code> - The armor slot the item is in.</dd> +<dt><span class="strong">Returns:</span></dt><dd>A ArmorProperties instance holding information about how the armor effects damage.</dd></dl> +</li> +</ul> +<a name="getArmorDisplay(net.minecraft.entity.player.EntityPlayer, net.minecraft.item.ItemStack, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArmorDisplay</h4> +<pre>int getArmorDisplay(<a href="../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> armor, + int slot)</pre> +<div class="block">Get the displayed effective armor.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>player</code> - The player wearing the armor.</dd><dd><code>armor</code> - The ItemStack of the armor item itself.</dd><dd><code>slot</code> - The armor slot the item is in.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The number of armor points for display, 2 per shield.</dd></dl> +</li> +</ul> +<a name="damageArmor(net.minecraft.entity.EntityLivingBase, net.minecraft.item.ItemStack, net.minecraft.util.DamageSource, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>damageArmor</h4> +<pre>void damageArmor(<a href="../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a> entity, + <a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> stack, + <a href="../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source, + int damage, + int slot)</pre> +<div class="block">Applies damage to the ItemStack. The mod is responsible for reducing the + item durability and stack size. If the stack is depleted it will be cleaned + up automatically.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>entity</code> - The entity wearing the armor</dd><dd><code>stack</code> - The ItemStack of the armor item itself.</dd><dd><code>source</code> - The source of the damage, which can be used to alter armor + properties based on the type or source of damage.</dd><dd><code>damage</code> - The amount of damage being applied to the armor</dd><dd><code>slot</code> - The armor slot the item is in.</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/IShearable.html" title="interface in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.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/ISpecialArmor.html" target="_top">Frames</a></li> +<li><a href="ISpecialArmor.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>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> diff --git a/javadoc/net/minecraftforge/common/MinecraftForge.html b/javadoc/net/minecraftforge/common/MinecraftForge.html new file mode 100644 index 0000000..f304d82 --- /dev/null +++ b/javadoc/net/minecraftforge/common/MinecraftForge.html @@ -0,0 +1,375 @@ +<!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>MinecraftForge (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="MinecraftForge (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/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/UsernameCache.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/MinecraftForge.html" target="_top">Frames</a></li> +<li><a href="MinecraftForge.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><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 MinecraftForge" class="title">Class MinecraftForge</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.MinecraftForge</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">MinecraftForge</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>static <a href="../../../cpw/mods/fml/common/eventhandler/EventBus.html" title="class in cpw.mods.fml.common.eventhandler">EventBus</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/MinecraftForge.html#EVENT_BUS">EVENT_BUS</a></strong></code> +<div class="block">The core Forge EventBusses, all events for Forge will be fired on these, + you should use this to register all your listeners.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/MinecraftForge.html#MC_VERSION">MC_VERSION</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../cpw/mods/fml/common/eventhandler/EventBus.html" title="class in cpw.mods.fml.common.eventhandler">EventBus</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/MinecraftForge.html#ORE_GEN_BUS">ORE_GEN_BUS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../cpw/mods/fml/common/eventhandler/EventBus.html" title="class in cpw.mods.fml.common.eventhandler">EventBus</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/MinecraftForge.html#TERRAIN_GEN_BUS">TERRAIN_GEN_BUS</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/MinecraftForge.html#MinecraftForge()">MinecraftForge</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/MinecraftForge.html#addGrassSeed(net.minecraft.item.ItemStack,%20int)">addGrassSeed</a></strong>(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> seed, + int weight)</code> +<div class="block">Register a new seed to be dropped when breaking tall grass.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/MinecraftForge.html#getBrandingVersion()">getBrandingVersion</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/MinecraftForge.html#initialize()">initialize</a></strong>()</code> +<div class="block">Method invoked by FML before any other mods are loaded.</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="EVENT_BUS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVENT_BUS</h4> +<pre>public static final <a href="../../../cpw/mods/fml/common/eventhandler/EventBus.html" title="class in cpw.mods.fml.common.eventhandler">EventBus</a> EVENT_BUS</pre> +<div class="block">The core Forge EventBusses, all events for Forge will be fired on these, + you should use this to register all your listeners. + This replaces every register*Handler() function in the old version of Forge. + TERRAIN_GEN_BUS for terrain gen events + ORE_GEN_BUS for ore gen events + EVENT_BUS for everything else</div> +</li> +</ul> +<a name="TERRAIN_GEN_BUS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TERRAIN_GEN_BUS</h4> +<pre>public static final <a href="../../../cpw/mods/fml/common/eventhandler/EventBus.html" title="class in cpw.mods.fml.common.eventhandler">EventBus</a> TERRAIN_GEN_BUS</pre> +</li> +</ul> +<a name="ORE_GEN_BUS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ORE_GEN_BUS</h4> +<pre>public static final <a href="../../../cpw/mods/fml/common/eventhandler/EventBus.html" title="class in cpw.mods.fml.common.eventhandler">EventBus</a> ORE_GEN_BUS</pre> +</li> +</ul> +<a name="MC_VERSION"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MC_VERSION</h4> +<pre>public static final java.lang.String MC_VERSION</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#net.minecraftforge.common.MinecraftForge.MC_VERSION">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="MinecraftForge()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MinecraftForge</h4> +<pre>public MinecraftForge()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addGrassSeed(net.minecraft.item.ItemStack, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addGrassSeed</h4> +<pre>public static void addGrassSeed(<a href="../../../net/minecraft/item/ItemStack.html" title="class in net.minecraft.item">ItemStack</a> seed, + int weight)</pre> +<div class="block">Register a new seed to be dropped when breaking tall grass.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>seed</code> - The item to drop as a seed.</dd><dd><code>weight</code> - The relative probability of the seeds, + where wheat seeds are 10.</dd></dl> +</li> +</ul> +<a name="initialize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>initialize</h4> +<pre>public static void initialize()</pre> +<div class="block">Method invoked by FML before any other mods are loaded.</div> +</li> +</ul> +<a name="getBrandingVersion()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getBrandingVersion</h4> +<pre>public static java.lang.String getBrandingVersion()</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/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/UsernameCache.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/MinecraftForge.html" target="_top">Frames</a></li> +<li><a href="MinecraftForge.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><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> diff --git a/javadoc/net/minecraftforge/common/UsernameCache.html b/javadoc/net/minecraftforge/common/UsernameCache.html new file mode 100644 index 0000000..055d13a --- /dev/null +++ b/javadoc/net/minecraftforge/common/UsernameCache.html @@ -0,0 +1,339 @@ +<!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>UsernameCache (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="UsernameCache (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/MinecraftForge.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.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/UsernameCache.html" target="_top">Frames</a></li> +<li><a href="UsernameCache.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="Class UsernameCache" class="title">Class UsernameCache</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.UsernameCache</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="strong">UsernameCache</span> +extends java.lang.Object</pre> +<div class="block">Caches player's last known usernames + <p> + Modders should use <a href="../../../net/minecraftforge/common/UsernameCache.html#getLastKnownUsername(java.util.UUID)"><code>getLastKnownUsername(UUID)</code></a> to determine a players + last known username.<br> + For convenience, <a href="../../../net/minecraftforge/common/UsernameCache.html#getMap()"><code>getMap()</code></a> is provided to get an immutable copy of + the caches underlying map.</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>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#containsUUID(java.util.UUID)">containsUUID</a></strong>(java.util.UUID uuid)</code> +<div class="block">Check if the cache contains the given player's username</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#getLastKnownUsername(java.util.UUID)">getLastKnownUsername</a></strong>(java.util.UUID uuid)</code> +<div class="block">Get the player's last known username</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.util.Map<java.util.UUID,java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#getMap()">getMap</a></strong>()</code> +<div class="block">Get an immutable copy of the cache's underlying map</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#load()">load</a></strong>()</code> +<div class="block">Load the cache from file</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#removeUsername(java.util.UUID)">removeUsername</a></strong>(java.util.UUID uuid)</code> +<div class="block">Remove a player's username from the cache</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#save()">save</a></strong>()</code> +<div class="block">Save the cache to file</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/UsernameCache.html#setUsername(java.util.UUID,%20java.lang.String)">setUsername</a></strong>(java.util.UUID uuid, + java.lang.String username)</code> +<div class="block">Set a player's current username</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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setUsername(java.util.UUID, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUsername</h4> +<pre>protected static void setUsername(java.util.UUID uuid, + java.lang.String username)</pre> +<div class="block">Set a player's current username</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd><dd><code>username</code> - the player's username</dd></dl> +</li> +</ul> +<a name="removeUsername(java.util.UUID)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeUsername</h4> +<pre>protected static boolean removeUsername(java.util.UUID uuid)</pre> +<div class="block">Remove a player's username from the cache</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd> +<dt><span class="strong">Returns:</span></dt><dd>if the cache contained the user</dd></dl> +</li> +</ul> +<a name="getLastKnownUsername(java.util.UUID)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastKnownUsername</h4> +<pre>@Nullable +public static java.lang.String getLastKnownUsername(java.util.UUID uuid)</pre> +<div class="block">Get the player's last known username + <p> + <b>May be <code>null</code></b></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the player's last known username, or <code>null</code> if the + cache doesn't have a record of the last username</dd></dl> +</li> +</ul> +<a name="containsUUID(java.util.UUID)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsUUID</h4> +<pre>public static boolean containsUUID(java.util.UUID uuid)</pre> +<div class="block">Check if the cache contains the given player's username</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>uuid</code> - the player's <code>UUID</code></dd> +<dt><span class="strong">Returns:</span></dt><dd>if the cache contains a username for the given player</dd></dl> +</li> +</ul> +<a name="getMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMap</h4> +<pre>public static java.util.Map<java.util.UUID,java.lang.String> getMap()</pre> +<div class="block">Get an immutable copy of the cache's underlying map</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the map</dd></dl> +</li> +</ul> +<a name="save()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>save</h4> +<pre>protected static void save()</pre> +<div class="block">Save the cache to file</div> +</li> +</ul> +<a name="load()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>load</h4> +<pre>protected static void load()</pre> +<div class="block">Load the cache from file</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/MinecraftForge.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.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/UsernameCache.html" target="_top">Frames</a></li> +<li><a href="UsernameCache.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> diff --git a/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html b/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html new file mode 100644 index 0000000..3036b89 --- /dev/null +++ b/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html @@ -0,0 +1,422 @@ +<!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>WorldSpecificSaveHandler (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="WorldSpecificSaveHandler (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/UsernameCache.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/WorldSpecificSaveHandler.html" target="_top">Frames</a></li> +<li><a href="WorldSpecificSaveHandler.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><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 WorldSpecificSaveHandler" class="title">Class WorldSpecificSaveHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.WorldSpecificSaveHandler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">WorldSpecificSaveHandler</span> +extends java.lang.Object +implements <a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/WorldSpecificSaveHandler.html#WorldSpecificSaveHandler(net.minecraft.world.WorldServer,%20net.minecraft.world.storage.ISaveHandler)">WorldSpecificSaveHandler</a></strong>(<a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world, + <a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a> parent)</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/WorldSpecificSaveHandler.html#checkSessionLock()">checkSessionLock</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#flush()">flush</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/world/chunk/storage/IChunkLoader.html" title="interface in net.minecraft.world.chunk.storage">IChunkLoader</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#getChunkLoader(net.minecraft.world.WorldProvider)">getChunkLoader</a></strong>(<a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a> var1)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#getMapFileFromName(java.lang.String)">getMapFileFromName</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/world/storage/IPlayerFileData.html" title="interface in net.minecraft.world.storage">IPlayerFileData</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#getSaveHandler()">getSaveHandler</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#getWorldDirectory()">getWorldDirectory</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#getWorldDirectoryName()">getWorldDirectoryName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a></code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#loadWorldInfo()">loadWorldInfo</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#saveWorldInfo(net.minecraft.world.storage.WorldInfo)">saveWorldInfo</a></strong>(<a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> var1)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html#saveWorldInfoWithPlayer(net.minecraft.world.storage.WorldInfo,%20net.minecraft.nbt.NBTTagCompound)">saveWorldInfoWithPlayer</a></strong>(<a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> var1, + <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> var2)</code> </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="WorldSpecificSaveHandler(net.minecraft.world.WorldServer, net.minecraft.world.storage.ISaveHandler)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>WorldSpecificSaveHandler</h4> +<pre>public WorldSpecificSaveHandler(<a href="../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world, + <a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a> parent)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="loadWorldInfo()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadWorldInfo</h4> +<pre>public <a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> loadWorldInfo()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#loadWorldInfo()">loadWorldInfo</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="checkSessionLock()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>checkSessionLock</h4> +<pre>public void checkSessionLock() + throws <a href="../../../net/minecraft/world/MinecraftException.html" title="class in net.minecraft.world">MinecraftException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#checkSessionLock()">checkSessionLock</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../net/minecraft/world/MinecraftException.html" title="class in net.minecraft.world">MinecraftException</a></code></dd></dl> +</li> +</ul> +<a name="getChunkLoader(net.minecraft.world.WorldProvider)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChunkLoader</h4> +<pre>public <a href="../../../net/minecraft/world/chunk/storage/IChunkLoader.html" title="interface in net.minecraft.world.chunk.storage">IChunkLoader</a> getChunkLoader(<a href="../../../net/minecraft/world/WorldProvider.html" title="class in net.minecraft.world">WorldProvider</a> var1)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#getChunkLoader(net.minecraft.world.WorldProvider)">getChunkLoader</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="saveWorldInfoWithPlayer(net.minecraft.world.storage.WorldInfo, net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>saveWorldInfoWithPlayer</h4> +<pre>public void saveWorldInfoWithPlayer(<a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> var1, + <a href="../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> var2)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#saveWorldInfoWithPlayer(net.minecraft.world.storage.WorldInfo,%20net.minecraft.nbt.NBTTagCompound)">saveWorldInfoWithPlayer</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="saveWorldInfo(net.minecraft.world.storage.WorldInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>saveWorldInfo</h4> +<pre>public void saveWorldInfo(<a href="../../../net/minecraft/world/storage/WorldInfo.html" title="class in net.minecraft.world.storage">WorldInfo</a> var1)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#saveWorldInfo(net.minecraft.world.storage.WorldInfo)">saveWorldInfo</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="getSaveHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSaveHandler</h4> +<pre>public <a href="../../../net/minecraft/world/storage/IPlayerFileData.html" title="interface in net.minecraft.world.storage">IPlayerFileData</a> getSaveHandler()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#getSaveHandler()">getSaveHandler</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="flush()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flush</h4> +<pre>public void flush()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#flush()">flush</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="getWorldDirectoryName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorldDirectoryName</h4> +<pre>public java.lang.String getWorldDirectoryName()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#getWorldDirectoryName()">getWorldDirectoryName</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="getWorldDirectory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorldDirectory</h4> +<pre>public java.io.File getWorldDirectory()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#getWorldDirectory()">getWorldDirectory</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></code></dd> +</dl> +</li> +</ul> +<a name="getMapFileFromName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMapFileFromName</h4> +<pre>public java.io.File getMapFileFromName(java.lang.String name)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../net/minecraft/world/storage/ISaveHandler.html#getMapFileFromName(java.lang.String)">getMapFileFromName</a></code> in interface <code><a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a></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="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/UsernameCache.html" title="class in net.minecraftforge.common"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/WorldSpecificSaveHandler.html" target="_top">Frames</a></li> +<li><a href="WorldSpecificSaveHandler.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><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> diff --git a/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html b/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html new file mode 100644 index 0000000..079f2fb --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html @@ -0,0 +1,330 @@ +<!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:16 EST 2015 --> +<title>ChunkIOExecutor (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="ChunkIOExecutor (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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/chunkio/ChunkIOExecutor.html" target="_top">Frames</a></li> +<li><a href="ChunkIOExecutor.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><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.chunkio</div> +<h2 title="Class ChunkIOExecutor" class="title">Class ChunkIOExecutor</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.chunkio.ChunkIOExecutor</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ChunkIOExecutor</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/chunkio/ChunkIOExecutor.html#ChunkIOExecutor()">ChunkIOExecutor</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/chunkio/ChunkIOExecutor.html#adjustPoolSize(int)">adjustPoolSize</a></strong>(int players)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/chunkio/ChunkIOExecutor.html#dropQueuedChunkLoad(net.minecraft.world.World,%20int,%20int,%20java.lang.Runnable)">dropQueuedChunkLoad</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int z, + java.lang.Runnable runnable)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/chunkio/ChunkIOExecutor.html#queueChunkLoad(net.minecraft.world.World,%20net.minecraft.world.chunk.storage.AnvilChunkLoader,%20net.minecraft.world.gen.ChunkProviderServer,%20int,%20int,%20java.lang.Runnable)">queueChunkLoad</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../../net/minecraft/world/chunk/storage/AnvilChunkLoader.html" title="class in net.minecraft.world.chunk.storage">AnvilChunkLoader</a> loader, + <a href="../../../../net/minecraft/world/gen/ChunkProviderServer.html" title="class in net.minecraft.world.gen">ChunkProviderServer</a> provider, + int x, + int z, + java.lang.Runnable runnable)</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/chunkio/ChunkIOExecutor.html#syncChunkLoad(net.minecraft.world.World,%20net.minecraft.world.chunk.storage.AnvilChunkLoader,%20net.minecraft.world.gen.ChunkProviderServer,%20int,%20int)">syncChunkLoad</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../../net/minecraft/world/chunk/storage/AnvilChunkLoader.html" title="class in net.minecraft.world.chunk.storage">AnvilChunkLoader</a> loader, + <a href="../../../../net/minecraft/world/gen/ChunkProviderServer.html" title="class in net.minecraft.world.gen">ChunkProviderServer</a> provider, + int x, + int z)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/chunkio/ChunkIOExecutor.html#tick()">tick</a></strong>()</code> </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="ChunkIOExecutor()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChunkIOExecutor</h4> +<pre>public ChunkIOExecutor()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="syncChunkLoad(net.minecraft.world.World, net.minecraft.world.chunk.storage.AnvilChunkLoader, net.minecraft.world.gen.ChunkProviderServer, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>syncChunkLoad</h4> +<pre>public static <a href="../../../../net/minecraft/world/chunk/Chunk.html" title="class in net.minecraft.world.chunk">Chunk</a> syncChunkLoad(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../../net/minecraft/world/chunk/storage/AnvilChunkLoader.html" title="class in net.minecraft.world.chunk.storage">AnvilChunkLoader</a> loader, + <a href="../../../../net/minecraft/world/gen/ChunkProviderServer.html" title="class in net.minecraft.world.gen">ChunkProviderServer</a> provider, + int x, + int z)</pre> +</li> +</ul> +<a name="queueChunkLoad(net.minecraft.world.World, net.minecraft.world.chunk.storage.AnvilChunkLoader, net.minecraft.world.gen.ChunkProviderServer, int, int, java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>queueChunkLoad</h4> +<pre>public static void queueChunkLoad(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + <a href="../../../../net/minecraft/world/chunk/storage/AnvilChunkLoader.html" title="class in net.minecraft.world.chunk.storage">AnvilChunkLoader</a> loader, + <a href="../../../../net/minecraft/world/gen/ChunkProviderServer.html" title="class in net.minecraft.world.gen">ChunkProviderServer</a> provider, + int x, + int z, + java.lang.Runnable runnable)</pre> +</li> +</ul> +<a name="dropQueuedChunkLoad(net.minecraft.world.World, int, int, java.lang.Runnable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dropQueuedChunkLoad</h4> +<pre>public static void dropQueuedChunkLoad(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int z, + java.lang.Runnable runnable)</pre> +</li> +</ul> +<a name="adjustPoolSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adjustPoolSize</h4> +<pre>public static void adjustPoolSize(int players)</pre> +</li> +</ul> +<a name="tick()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>tick</h4> +<pre>public static void tick()</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>Prev Class</li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/chunkio/ChunkIOExecutor.html" target="_top">Frames</a></li> +<li><a href="ChunkIOExecutor.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><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> diff --git a/javadoc/net/minecraftforge/common/chunkio/package-frame.html b/javadoc/net/minecraftforge/common/chunkio/package-frame.html new file mode 100644 index 0000000..a6b0808 --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/package-frame.html @@ -0,0 +1,19 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.chunkio (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../net/minecraftforge/common/chunkio/package-summary.html" target="classFrame">net.minecraftforge.common.chunkio</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ChunkIOExecutor.html" title="class in net.minecraftforge.common.chunkio" target="classFrame">ChunkIOExecutor</a></li> +</ul> +</div> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/chunkio/package-summary.html b/javadoc/net/minecraftforge/common/chunkio/package-summary.html new file mode 100644 index 0000000..f969902 --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/package-summary.html @@ -0,0 +1,131 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.chunkio (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="net.minecraftforge.common.chunkio (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 class="navBarCell1Rev">Package</li> +<li>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/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/common/config/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/chunkio/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package net.minecraftforge.common.chunkio</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/chunkio/ChunkIOExecutor.html" title="class in net.minecraftforge.common.chunkio">ChunkIOExecutor</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/common/config/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/chunkio/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/chunkio/package-tree.html b/javadoc/net/minecraftforge/common/chunkio/package-tree.html new file mode 100644 index 0000000..81d78b4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/chunkio/package-tree.html @@ -0,0 +1,126 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.chunkio Class Hierarchy (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="net.minecraftforge.common.chunkio Class Hierarchy (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</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/common/config/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/chunkio/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package net.minecraftforge.common.chunkio</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">net.minecraftforge.common.chunkio.<a href="../../../../net/minecraftforge/common/chunkio/ChunkIOExecutor.html" title="class in net.minecraftforge.common.chunkio"><span class="strong">ChunkIOExecutor</span></a></li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/common/config/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/chunkio/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/config/ConfigCategory.html b/javadoc/net/minecraftforge/common/config/ConfigCategory.html new file mode 100644 index 0000000..f9c0e7d --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/ConfigCategory.html @@ -0,0 +1,929 @@ +<!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:11 EST 2015 --> +<title>ConfigCategory (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="ConfigCategory (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>Prev Class</li> +<li><a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/ConfigCategory.html" target="_top">Frames</a></li> +<li><a href="ConfigCategory.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><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.config</div> +<h2 title="Class ConfigCategory" class="title">Class ConfigCategory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.ConfigCategory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConfigCategory</span> +extends java.lang.Object +implements java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K,V></code></li> +</ul> +</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><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/config/ConfigCategory.html#parent">parent</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/config/ConfigCategory.html#ConfigCategory(java.lang.String)">ConfigCategory</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#ConfigCategory(java.lang.String,%20net.minecraftforge.common.config.ConfigCategory)">ConfigCategory</a></strong>(java.lang.String name, + <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> parent)</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/config/ConfigCategory.html#clear()">clear</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#containsKey(java.lang.Object)">containsKey</a></strong>(java.lang.Object key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#containsKey(java.lang.String)">containsKey</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#containsValue(java.lang.Object)">containsValue</a></strong>(java.lang.Object value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#entrySet()">entrySet</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#get(java.lang.Object)">get</a></strong>(java.lang.Object key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#get(java.lang.String)">get</a></strong>(java.lang.String key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<<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/config/ConfigCategory.html#getChildren()">getChildren</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getComment()">getComment</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getConfigEntryClass()">getConfigEntryClass</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#getFirstParent()">getFirstParent</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getLanguagekey()">getLanguagekey</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getName()">getName</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getOrderedValues()">getOrderedValues</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getPropertyOrder()">getPropertyOrder</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getQualifiedName()">getQualifiedName</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getQualifiedName(java.lang.String,%20net.minecraftforge.common.config.ConfigCategory)">getQualifiedName</a></strong>(java.lang.String name, + <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> parent)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#getValues()">getValues</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#hasChanged()">hasChanged</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#isChild()">isChild</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#keySet()">keySet</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#put(java.lang.String,%20net.minecraftforge.common.config.Property)">put</a></strong>(java.lang.String key, + <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#putAll(java.util.Map)">putAll</a></strong>(java.util.Map<? extends java.lang.String,? extends <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>> m)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object key)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#removeChild(net.minecraftforge.common.config.ConfigCategory)">removeChild</a></strong>(<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> child)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#requiresMcRestart()">requiresMcRestart</a></strong>()</code> +<div class="block">Gets whether or not this ConfigCategory requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#requiresWorldRestart()">requiresWorldRestart</a></strong>()</code> +<div class="block">Returns whether or not this category is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#setComment(java.lang.String)">setComment</a></strong>(java.lang.String comment)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#setConfigEntryClass(java.lang.Class)">setConfigEntryClass</a></strong>(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#setLanguageKey(java.lang.String)">setLanguageKey</a></strong>(java.lang.String languagekey)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#setPropertyOrder(java.util.List)">setPropertyOrder</a></strong>(java.util.List<java.lang.String> propertyOrder)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#setRequiresMcRestart(boolean)">setRequiresMcRestart</a></strong>(boolean requiresMcRestart)</code> +<div class="block">Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#setRequiresWorldRestart(boolean)">setRequiresWorldRestart</a></strong>(boolean requiresWorldRestart)</code> +<div class="block">Sets the flag for whether or not this category can be edited while a world is running.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/ConfigCategory.html#setShowInGui(boolean)">setShowInGui</a></strong>(boolean showInGui)</code> +<div class="block">Sets whether or not this ConfigCategory should be allowed to show on config GUIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#showInGui()">showInGui</a></strong>()</code> +<div class="block">Gets whether or not this ConfigCategory should be allowed to show on config GUIs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#size()">size</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Collection<<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#values()">values</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html#write(java.io.BufferedWriter,%20int)">write</a></strong>(java.io.BufferedWriter out, + int indent)</code> </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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Map</h3> +<code>hashCode</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="parent"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>parent</h4> +<pre>public final <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> parent</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConfigCategory(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigCategory</h4> +<pre>public ConfigCategory(java.lang.String name)</pre> +</li> +</ul> +<a name="ConfigCategory(java.lang.String, net.minecraftforge.common.config.ConfigCategory)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConfigCategory</h4> +<pre>public ConfigCategory(java.lang.String name, + <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> parent)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>equals</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +</li> +</ul> +<a name="getQualifiedName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQualifiedName</h4> +<pre>public java.lang.String getQualifiedName()</pre> +</li> +</ul> +<a name="getQualifiedName(java.lang.String, net.minecraftforge.common.config.ConfigCategory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQualifiedName</h4> +<pre>public static java.lang.String getQualifiedName(java.lang.String name, + <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> parent)</pre> +</li> +</ul> +<a name="getFirstParent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFirstParent</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> getFirstParent()</pre> +</li> +</ul> +<a name="isChild()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isChild</h4> +<pre>public boolean isChild()</pre> +</li> +</ul> +<a name="getValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValues</h4> +<pre>public java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>> getValues()</pre> +</li> +</ul> +<a name="getOrderedValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderedValues</h4> +<pre>public java.util.List<<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>> getOrderedValues()</pre> +</li> +</ul> +<a name="setConfigEntryClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfigEntryClass</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> setConfigEntryClass(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</pre> +</li> +</ul> +<a name="getConfigEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> getConfigEntryClass()</pre> +</li> +</ul> +<a name="setLanguageKey(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLanguageKey</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> setLanguageKey(java.lang.String languagekey)</pre> +</li> +</ul> +<a name="getLanguagekey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLanguagekey</h4> +<pre>public java.lang.String getLanguagekey()</pre> +</li> +</ul> +<a name="setComment(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setComment</h4> +<pre>public void setComment(java.lang.String comment)</pre> +</li> +</ul> +<a name="getComment()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComment</h4> +<pre>public java.lang.String getComment()</pre> +</li> +</ul> +<a name="setRequiresWorldRestart(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequiresWorldRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> setRequiresWorldRestart(boolean requiresWorldRestart)</pre> +<div class="block">Sets the flag for whether or not this category can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. Only set this flag to + true if all child properties/categories are unable to be modified while a world is running.</div> +</li> +</ul> +<a name="requiresWorldRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresWorldRestart</h4> +<pre>public boolean requiresWorldRestart()</pre> +<div class="block">Returns whether or not this category is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.</div> +</li> +</ul> +<a name="setShowInGui(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShowInGui</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> setShowInGui(boolean showInGui)</pre> +<div class="block">Sets whether or not this ConfigCategory should be allowed to show on config GUIs. + Defaults to true.</div> +</li> +</ul> +<a name="showInGui()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>showInGui</h4> +<pre>public boolean showInGui()</pre> +<div class="block">Gets whether or not this ConfigCategory should be allowed to show on config GUIs. + Defaults to true unless set to false.</div> +</li> +</ul> +<a name="setRequiresMcRestart(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequiresMcRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> setRequiresMcRestart(boolean requiresMcRestart)</pre> +<div class="block">Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false. Only set this flag to true if ALL child properties/categories require + Minecraft to be restarted when changed. Setting this flag will also prevent modification + of the child properties/categories while a world is running.</div> +</li> +</ul> +<a name="requiresMcRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresMcRestart</h4> +<pre>public boolean requiresMcRestart()</pre> +<div class="block">Gets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false unless set to true.</div> +</li> +</ul> +<a name="setPropertyOrder(java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPropertyOrder</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> setPropertyOrder(java.util.List<java.lang.String> propertyOrder)</pre> +</li> +</ul> +<a name="getPropertyOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyOrder</h4> +<pre>public java.util.List<java.lang.String> getPropertyOrder()</pre> +</li> +</ul> +<a name="containsKey(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsKey</h4> +<pre>public boolean containsKey(java.lang.String key)</pre> +</li> +</ul> +<a name="get(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String key)</pre> +</li> +</ul> +<a name="write(java.io.BufferedWriter, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>write</h4> +<pre>public void write(java.io.BufferedWriter out, + int indent) + throws java.io.IOException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="hasChanged()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasChanged</h4> +<pre>public boolean hasChanged()</pre> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>size</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>isEmpty</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="containsKey(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsKey</h4> +<pre>public boolean containsKey(java.lang.Object key)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>containsKey</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="containsValue(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsValue</h4> +<pre>public boolean containsValue(java.lang.Object value)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>containsValue</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="get(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.Object key)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>get</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="put(java.lang.String, net.minecraftforge.common.config.Property)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> put(java.lang.String key, + <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> value)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>put</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="remove(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> remove(java.lang.Object key)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>remove</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="putAll(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAll</h4> +<pre>public void putAll(java.util.Map<? extends java.lang.String,? extends <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>> m)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>putAll</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>clear</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="keySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySet</h4> +<pre>public java.util.Set<java.lang.String> keySet()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>keySet</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public java.util.Collection<<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>> values()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>values</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="entrySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entrySet</h4> +<pre>public java.util.Set<java.util.Map.Entry<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>>> entrySet()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>entrySet</code> in interface <code>java.util.Map<java.lang.String,<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a>></code></dd> +</dl> +</li> +</ul> +<a name="getChildren()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChildren</h4> +<pre>public java.util.Set<<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a>> getChildren()</pre> +</li> +</ul> +<a name="removeChild(net.minecraftforge.common.config.ConfigCategory)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removeChild</h4> +<pre>public void removeChild(<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> child)</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>Prev Class</li> +<li><a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/ConfigCategory.html" target="_top">Frames</a></li> +<li><a href="ConfigCategory.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><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> diff --git a/javadoc/net/minecraftforge/common/config/ConfigElement.html b/javadoc/net/minecraftforge/common/config/ConfigElement.html new file mode 100644 index 0000000..886c8a6 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/ConfigElement.html @@ -0,0 +1,919 @@ +<!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:11 EST 2015 --> +<title>ConfigElement (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="ConfigElement (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/config/ConfigCategory.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/ConfigElement.html" target="_top">Frames</a></li> +<li><a href="ConfigElement.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><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.config</div> +<h2 title="Class ConfigElement" class="title">Class ConfigElement<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.ConfigElement<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConfigElement<T></span> +extends java.lang.Object +implements <a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><T></pre> +<div class="block">This class bridges the gap between the FML config GUI classes and the Forge Configuration classes.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== PROPERTY SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="property_summary"> +<!-- --> +</a> +<h3>Property Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Property Summary table, listing properties, and an explanation"> +<caption><span>Properties</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Type</th> +<th class="colLast" scope="col">Property and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#isProperty">is</a></strong></code> +<div class="block">[Property, Category] Is this object a property object?</div> +</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/config/ConfigElement.html#ConfigElement(net.minecraftforge.common.config.ConfigCategory)">ConfigElement</a></strong>(<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> ctgy)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#ConfigElement(net.minecraftforge.common.config.Property)">ConfigElement</a></strong>(<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> prop)</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>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#get()">get</a></strong>()</code> +<div class="block">[Property] Gets this property value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getArrayEntryClass()">getArrayEntryClass</a></strong>()</code> +<div class="block">This method returns a class that implements <code>IArrayEntry</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<<a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getChildElements()">getChildElements</a></strong>()</code> +<div class="block">[Category] Gets this category's child categories/properties.</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/config/ConfigElement.html#getComment()">getComment</a></strong>()</code> +<div class="block">[Property, Category] Gets the comment for this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getConfigEntryClass()">getConfigEntryClass</a></strong>()</code> +<div class="block">This method returns a class that implements <code>IConfigEntry</code> or null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getDefault()">getDefault</a></strong>()</code> +<div class="block">[Property] Gets this property's default value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getDefaults()">getDefaults</a></strong>()</code> +<div class="block">[Property] Gets this property's default values.</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/config/ConfigElement.html#getLanguageKey()">getLanguageKey</a></strong>()</code> +<div class="block">[Property, Category] Gets a language key for localization of config GUI entry names.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getList()">getList</a></strong>()</code> +<div class="block">[Property] Gets this property value as a list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getMaxListLength()">getMaxListLength</a></strong>()</code> +<div class="block">[Property] Gets the max length of this list property, or -1 if the length is unlimited.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getMaxValue()">getMaxValue</a></strong>()</code> +<div class="block">[Property] Gets this property's maximum value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getMinValue()">getMinValue</a></strong>()</code> +<div class="block">[Property] Gets this property's minimum value.</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/config/ConfigElement.html#getName()">getName</a></strong>()</code> +<div class="block">[Property, Category] Gets the name of this object.</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/config/ConfigElement.html#getQualifiedName()">getQualifiedName</a></strong>()</code> +<div class="block">[Category] Gets the qualified name of this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../cpw/mods/fml/client/config/ConfigGuiType.html" title="enum in cpw.mods.fml.client.config">ConfigGuiType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getType()">getType</a></strong>()</code> +<div class="block">[Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../cpw/mods/fml/client/config/ConfigGuiType.html" title="enum in cpw.mods.fml.client.config">ConfigGuiType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getType(net.minecraftforge.common.config.Property)">getType</a></strong>(<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> prop)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config">ConfigElement</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getTypedElement(net.minecraftforge.common.config.Property)">getTypedElement</a></strong>(<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> prop)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.regex.Pattern</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#getValidationPattern()">getValidationPattern</a></strong>()</code> +<div class="block">[Property] Gets a Pattern object used in String property input validation.</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/config/ConfigElement.html#getValidValues()">getValidValues</a></strong>()</code> +<div class="block">[Property] Gets a String array of valid values for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#isDefault()">isDefault</a></strong>()</code> +<div class="block">[Property] Is this property value equal to the default value?</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#isList()">isList</a></strong>()</code> +<div class="block">[Property] Is this property object a list?</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#isListLengthFixed()">isListLengthFixed</a></strong>()</code> +<div class="block">[Property] Does this list property have to remain a fixed length?</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#isProperty()">isProperty</a></strong>()</code> +<div class="block">[Property, Category] Is this object a property object?</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config">ConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#listCategoriesFirst(boolean)">listCategoriesFirst</a></strong>(boolean categoriesFirst)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#requiresMcRestart()">requiresMcRestart</a></strong>()</code> +<div class="block">[Property, Category] Whether or not this element requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#requiresWorldRestart()">requiresWorldRestart</a></strong>()</code> +<div class="block">[Property, Category] Whether or not this element is safe to modify while a world is running.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#set(T)">set</a></strong>(<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a> value)</code> +<div class="block">[Property] Sets this property's value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#set(T[])">set</a></strong>(<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>[] aVal)</code> +<div class="block">[Property] Sets this property's value to the specified array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#setToDefault()">setToDefault</a></strong>()</code> +<div class="block">[Property] Sets this property's value to the default value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/ConfigElement.html#showInGui()">showInGui</a></strong>()</code> +<div class="block">[Property, Category] Whether or not this element should be allowed to show on config GUIs.</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"> +<!-- ============ PROPERTY DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="property_detail"> +<!-- --> +</a> +<h3>Property Detail</h3> +<a name="isProperty"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>is</h4> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isProperty()">isProperty</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConfigElement(net.minecraftforge.common.config.ConfigCategory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigElement</h4> +<pre>public ConfigElement(<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> ctgy)</pre> +</li> +</ul> +<a name="ConfigElement(net.minecraftforge.common.config.Property)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConfigElement</h4> +<pre>public ConfigElement(<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> prop)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="listCategoriesFirst(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>listCategoriesFirst</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config">ConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>> listCategoriesFirst(boolean categoriesFirst)</pre> +</li> +</ul> +<a name="getChildElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChildElements</h4> +<pre>public java.util.List<<a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a>> getChildElements()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getChildElements()">IConfigElement</a></code></strong></div> +<div class="block">[Category] Gets this category's child categories/properties.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getChildElements()">getChildElements</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getTypedElement(net.minecraftforge.common.config.Property)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTypedElement</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config">ConfigElement</a><?> getTypedElement(<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> prop)</pre> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getName()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Gets the name of this object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getName()">getName</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="isProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isProperty</h4> +<pre>public boolean isProperty()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isProperty()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Is this object a property object?</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isProperty()">isProperty</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getConfigEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> getConfigEntryClass()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getConfigEntryClass()">IConfigElement</a></code></strong></div> +<div class="block">This method returns a class that implements <code>IConfigEntry</code> or null. This class MUST + provide a constructor with the following parameter types: <code>GuiConfig</code>, <code>GuiConfigEntries</code>, <code>IConfigElement</code></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getConfigEntryClass()">getConfigEntryClass</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getArrayEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArrayEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> getArrayEntryClass()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getArrayEntryClass()">IConfigElement</a></code></strong></div> +<div class="block">This method returns a class that implements <code>IArrayEntry</code>. This class MUST provide a constructor with the + following parameter types: <code>GuiEditArray</code>, <code>GuiEditArrayEntries</code>, <code>IConfigElement</code>, <code>Object</code></div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getArrayEntryClass()">getArrayEntryClass</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getQualifiedName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQualifiedName</h4> +<pre>public java.lang.String getQualifiedName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getQualifiedName()">IConfigElement</a></code></strong></div> +<div class="block">[Category] Gets the qualified name of this object. This is typically only used for category objects.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getQualifiedName()">getQualifiedName</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../../cpw/mods/fml/client/config/ConfigGuiType.html" title="enum in cpw.mods.fml.client.config">ConfigGuiType</a> getType()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getType()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getType()">getType</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getType(net.minecraftforge.common.config.Property)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public static <a href="../../../../cpw/mods/fml/client/config/ConfigGuiType.html" title="enum in cpw.mods.fml.client.config">ConfigGuiType</a> getType(<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> prop)</pre> +</li> +</ul> +<a name="isList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isList</h4> +<pre>public boolean isList()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isList()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Is this property object a list?</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isList()">isList</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="isListLengthFixed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isListLengthFixed</h4> +<pre>public boolean isListLengthFixed()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isListLengthFixed()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Does this list property have to remain a fixed length?</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isListLengthFixed()">isListLengthFixed</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getMaxListLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxListLength</h4> +<pre>public int getMaxListLength()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getMaxListLength()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets the max length of this list property, or -1 if the length is unlimited.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getMaxListLength()">getMaxListLength</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getComment()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getComment</h4> +<pre>public java.lang.String getComment()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getComment()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Gets the comment for this object. Used for the tooltip if getLanguageKey() + ".tooltip" is not defined in the + .lang file.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getComment()">getComment</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="isDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDefault</h4> +<pre>public boolean isDefault()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isDefault()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Is this property value equal to the default value?</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#isDefault()">isDefault</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="setToDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setToDefault</h4> +<pre>public void setToDefault()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#setToDefault()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Sets this property's value to the default value.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#setToDefault()">setToDefault</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="requiresWorldRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresWorldRestart</h4> +<pre>public boolean requiresWorldRestart()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#requiresWorldRestart()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Whether or not this element is safe to modify while a world is running. For Categories return false if ANY properties + in the category are modifiable while a world is running, true if all are not.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#requiresWorldRestart()">requiresWorldRestart</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="showInGui()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>showInGui</h4> +<pre>public boolean showInGui()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#showInGui()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Whether or not this element should be allowed to show on config GUIs.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#showInGui()">showInGui</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="requiresMcRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresMcRestart</h4> +<pre>public boolean requiresMcRestart()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#requiresMcRestart()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Whether or not this element requires Minecraft to be restarted when changed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#requiresMcRestart()">requiresMcRestart</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getValidValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidValues</h4> +<pre>public java.lang.String[] getValidValues()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getValidValues()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets a String array of valid values for this property. This is generally used for String properties to allow the user to + select a value from a list of valid values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getValidValues()">getValidValues</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getLanguageKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLanguageKey</h4> +<pre>public java.lang.String getLanguageKey()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getLanguageKey()">IConfigElement</a></code></strong></div> +<div class="block">[Property, Category] Gets a language key for localization of config GUI entry names. If the same key is specified with .tooltip + appended to the end, that key will return a localized tooltip when the mouse hovers over the property label/category button.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getLanguageKey()">getLanguageKey</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefault</h4> +<pre>public java.lang.Object getDefault()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getDefault()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets this property's default value. If this element is an array, this method should return a String + representation of that array using Arrays.toString()</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getDefault()">getDefault</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getDefaults()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaults</h4> +<pre>public java.lang.Object[] getDefaults()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getDefaults()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets this property's default values.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getDefaults()">getDefaults</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getValidationPattern()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationPattern</h4> +<pre>public java.util.regex.Pattern getValidationPattern()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getValidationPattern()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets a Pattern object used in String property input validation.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getValidationPattern()">getValidationPattern</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="get()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.Object get()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#get()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets this property value.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#get()">get</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getList</h4> +<pre>public java.lang.Object[] getList()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getList()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets this property value as a list. Generally you should be sure of whether the property is a list before calling this.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getList()">getList</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="set(java.lang.Object)"> +<!-- --> +</a><a name="set(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a> value)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#set(T)">IConfigElement</a></code></strong></div> +<div class="block">[Property] Sets this property's value.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#set(T)">set</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="set(java.lang.Object[])"> +<!-- --> +</a><a name="set(T[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>[] aVal)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#set(T[])">IConfigElement</a></code></strong></div> +<div class="block">[Property] Sets this property's value to the specified array.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#set(T[])">set</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getMinValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a> getMinValue()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getMinValue()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets this property's minimum value.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getMinValue()">getMinValue</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getMaxValue()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getMaxValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a> getMaxValue()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getMaxValue()">IConfigElement</a></code></strong></div> +<div class="block">[Property] Gets this property's maximum value.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html#getMaxValue()">getMaxValue</a></code> in interface <code><a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="type parameter in ConfigElement">T</a>></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="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/config/ConfigCategory.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/ConfigElement.html" target="_top">Frames</a></li> +<li><a href="ConfigElement.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><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> diff --git a/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html new file mode 100644 index 0000000..d1e0522 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html @@ -0,0 +1,340 @@ +<!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:11 EST 2015 --> +<title>Configuration.UnicodeInputStreamReader (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="Configuration.UnicodeInputStreamReader (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/config/Configuration.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" target="_top">Frames</a></li> +<li><a href="Configuration.UnicodeInputStreamReader.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="#fields_inherited_from_class_java.io.Reader">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>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.config</div> +<h2 title="Class Configuration.UnicodeInputStreamReader" class="title">Class Configuration.UnicodeInputStreamReader</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.io.Reader</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.Configuration.UnicodeInputStreamReader</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">Configuration.UnicodeInputStreamReader</span> +extends java.io.Reader</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> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_java.io.Reader"> +<!-- --> +</a> +<h3>Fields inherited from class java.io.Reader</h3> +<code>lock</code></li> +</ul> +</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/config/Configuration.UnicodeInputStreamReader.html#Configuration.UnicodeInputStreamReader(java.io.InputStream,%20java.lang.String)">Configuration.UnicodeInputStreamReader</a></strong>(java.io.InputStream source, + java.lang.String encoding)</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/config/Configuration.UnicodeInputStreamReader.html#close()">close</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html#getEncoding()">getEncoding</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html#read(char[],%20int,%20int)">read</a></strong>(char[] cbuf, + int off, + int len)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.io.Reader"> +<!-- --> +</a> +<h3>Methods inherited from class java.io.Reader</h3> +<code>mark, markSupported, read, read, read, ready, reset, skip</code></li> +</ul> +<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="Configuration.UnicodeInputStreamReader(java.io.InputStream, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Configuration.UnicodeInputStreamReader</h4> +<pre>public Configuration.UnicodeInputStreamReader(java.io.InputStream source, + java.lang.String encoding) + throws java.io.IOException</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></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="getEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEncoding</h4> +<pre>public java.lang.String getEncoding()</pre> +</li> +</ul> +<a name="read(char[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>read</h4> +<pre>public int read(char[] cbuf, + int off, + int len) + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>read</code> in class <code>java.io.Reader</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void close() + throws java.io.IOException</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.io.Closeable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>close</code> in class <code>java.io.Reader</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</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="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/config/Configuration.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" target="_top">Frames</a></li> +<li><a href="Configuration.UnicodeInputStreamReader.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="#fields_inherited_from_class_java.io.Reader">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>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> diff --git a/javadoc/net/minecraftforge/common/config/Configuration.html b/javadoc/net/minecraftforge/common/config/Configuration.html new file mode 100644 index 0000000..0b955f3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Configuration.html @@ -0,0 +1,1988 @@ +<!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:11 EST 2015 --> +<title>Configuration (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="Configuration (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/config/ConfigElement.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Configuration.html" target="_top">Frames</a></li> +<li><a href="Configuration.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.config</div> +<h2 title="Class Configuration" class="title">Class Configuration</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.Configuration</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Configuration</span> +extends java.lang.Object</pre> +<div class="block">This class offers advanced configurations capabilities, allowing to provide + various categories for configuration variables.</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/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config">Configuration.UnicodeInputStreamReader</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.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#ALLOWED_CHARS">ALLOWED_CHARS</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static com.google.common.base.CharMatcher</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#allowedProperties">allowedProperties</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#CATEGORY_GENERAL">CATEGORY_GENERAL</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#CATEGORY_SPLITTER">CATEGORY_SPLITTER</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#COMMENT_SEPARATOR">COMMENT_SEPARATOR</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#DEFAULT_ENCODING">DEFAULT_ENCODING</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#defaultEncoding">defaultEncoding</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#isChild">isChild</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#NEW_LINE">NEW_LINE</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/config/Configuration.html#Configuration()">Configuration</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#Configuration(java.io.File)">Configuration</a></strong>(java.io.File file)</code> +<div class="block">Create a configuration file for the file given in parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#Configuration(java.io.File,%20boolean)">Configuration</a></strong>(java.io.File file, + boolean caseSensitiveCustomCategories)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#Configuration(java.io.File,%20java.lang.String)">Configuration</a></strong>(java.io.File file, + java.lang.String configVersion)</code> +<div class="block">Create a configuration file for the file given in parameter with the provided config version number.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#Configuration(java.io.File,%20java.lang.String,%20boolean)">Configuration</a></strong>(java.io.File file, + java.lang.String configVersion, + boolean caseSensitiveCustomCategories)</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/config/Configuration.html#addCustomCategoryComment(java.lang.String,%20java.lang.String)">addCustomCategoryComment</a></strong>(java.lang.String category, + java.lang.String comment)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#copyCategoryProps(net.minecraftforge.common.config.Configuration,%20java.lang.String[])">copyCategoryProps</a></strong>(<a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> fromConfig, + java.lang.String[] ctgys)</code> +<div class="block">Copies property objects from another Configuration object to this one using the list of category names.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#enableGlobalConfig()">enableGlobalConfig</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20boolean)">get</a></strong>(java.lang.String category, + java.lang.String key, + boolean defaultValue)</code> +<div class="block">Gets a boolean Property object without a comment using the default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20boolean[])">get</a></strong>(java.lang.String category, + java.lang.String key, + boolean[] defaultValues)</code> +<div class="block">Gets a boolean array Property without a comment using the default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20boolean[],%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment)</code> +<div class="block">Gets a boolean array Property with a comment using the default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20boolean[],%20java.lang.String,%20boolean,%20int)">get</a></strong>(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength)</code> +<div class="block">Gets a boolean array Property with all settings defined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20boolean,%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + boolean defaultValue, + java.lang.String comment)</code> +<div class="block">Gets a boolean Property object with a comment using the default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double)">get</a></strong>(java.lang.String category, + java.lang.String key, + double defaultValue)</code> +<div class="block">Gets a double Property object without a comment using default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double[])">get</a></strong>(java.lang.String category, + java.lang.String key, + double[] defaultValues)</code> +<div class="block">Gets a double array Property object without a comment using default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double[],%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment)</code> +<div class="block">Gets a double array Property object without a comment using default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double[],%20java.lang.String,%20double,%20double)">get</a></strong>(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue)</code> +<div class="block">Gets a double array Property object with the defined comment, minimum and maximum bounds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double[],%20java.lang.String,%20double,%20double,%20boolean,%20int)">get</a></strong>(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue, + boolean isListLengthFixed, + int maxListLength)</code> +<div class="block">Gets a double array Property object with all settings defined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double,%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment)</code> +<div class="block">Gets a double Property object with a comment using default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20double,%20java.lang.String,%20double,%20double)">get</a></strong>(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment, + double minValue, + double maxValue)</code> +<div class="block">Gets a double Property object with the defined comment, minimum and maximum bounds</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int)">get</a></strong>(java.lang.String category, + java.lang.String key, + int defaultValue)</code> +<div class="block">Gets an integer Property object without a comment using default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int[])">get</a></strong>(java.lang.String category, + java.lang.String key, + int[] defaultValues)</code> +<div class="block">Gets an integer array Property object without a comment using default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int[],%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment)</code> +<div class="block">Gets an integer array Property object with a comment using default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int[],%20java.lang.String,%20int,%20int)">get</a></strong>(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue)</code> +<div class="block">Gets an integer array Property object with the defined comment, minimum and maximum bounds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int[],%20java.lang.String,%20int,%20int,%20boolean,%20int)">get</a></strong>(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue, + boolean isListLengthFixed, + int maxListLength)</code> +<div class="block">Gets an integer array Property object with all settings defined.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int,%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment)</code> +<div class="block">Gets an integer Property object with a comment using default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20int,%20java.lang.String,%20int,%20int)">get</a></strong>(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment, + int minValue, + int maxValue)</code> +<div class="block">Gets an integer Property object with the defined comment, minimum and maximum bounds.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue)</code> +<div class="block">Gets a string Property without a comment using the default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String[])">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues)</code> +<div class="block">Gets a string array Property without a comment using the default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment)</code> +<div class="block">Gets a string array Property with a comment using the default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String,%20boolean,%20int,%20java.util.regex.Pattern)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength, + java.util.regex.Pattern validationPattern)</code> +<div class="block">Gets a string array Property with a comment with all settings defined.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String,%20java.util.regex.Pattern)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + java.util.regex.Pattern validationPattern)</code> +<div class="block">Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String,%20net.minecraftforge.common.config.Property.Type)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</code> +<div class="block">Gets a list (array) Property object of the specified type using default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment)</code> +<div class="block">Gets a string Property with a comment using the default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.util.regex.Pattern)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern validationPattern)</code> +<div class="block">Gets a string Property with a comment using the defined validationPattern and otherwise default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type)">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</code> +<div class="block">Gets a Property object of the specified type using default settings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#get(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String[])">get</a></strong>(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues)</code> +<div class="block">Gets a string Property with a comment using the defined validValues array and otherwise default settings.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getBoolean(java.lang.String,%20java.lang.String,%20boolean,%20java.lang.String)">getBoolean</a></strong>(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment)</code> +<div class="block">Creates a boolean property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getBoolean(java.lang.String,%20java.lang.String,%20boolean,%20java.lang.String,%20java.lang.String)">getBoolean</a></strong>(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment, + java.lang.String langKey)</code> +<div class="block">Creates a boolean property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/Configuration.html#getCategory(java.lang.String)">getCategory</a></strong>(java.lang.String category)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getCategoryNames()">getCategoryNames</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getConfigFile()">getConfigFile</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getDefinedConfigVersion()">getDefinedConfigVersion</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getFloat(java.lang.String,%20java.lang.String,%20float,%20float,%20float,%20java.lang.String)">getFloat</a></strong>(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment)</code> +<div class="block">Creates a float property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>float</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getFloat(java.lang.String,%20java.lang.String,%20float,%20float,%20float,%20java.lang.String,%20java.lang.String)">getFloat</a></strong>(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment, + java.lang.String langKey)</code> +<div class="block">Creates a float property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getInt(java.lang.String,%20java.lang.String,%20int,%20int,%20int,%20java.lang.String)">getInt</a></strong>(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment)</code> +<div class="block">Creates a integer property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getInt(java.lang.String,%20java.lang.String,%20int,%20int,%20int,%20java.lang.String,%20java.lang.String)">getInt</a></strong>(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment, + java.lang.String langKey)</code> +<div class="block">Creates a integer property.</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/config/Configuration.html#getLoadedConfigVersion()">getLoadedConfigVersion</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#getString(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">getString</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment)</code> +<div class="block">Creates a string property.</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/config/Configuration.html#getString(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.util.regex.Pattern)">getString</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern pattern)</code> +<div class="block">Creates a string property.</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/config/Configuration.html#getString(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">getString</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey)</code> +<div class="block">Creates a string property.</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/config/Configuration.html#getString(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String[])">getString</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues)</code> +<div class="block">Creates a string property.</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/config/Configuration.html#getString(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String)">getString</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues, + java.lang.String langKey)</code> +<div class="block">Creates a string property.</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/config/Configuration.html#getString(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.util.regex.Pattern)">getString</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey, + java.util.regex.Pattern pattern)</code> +<div class="block">Creates a string property.</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/config/Configuration.html#getStringList(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String)">getStringList</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValues, + java.lang.String comment)</code> +<div class="block">Creates a string list property.</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/config/Configuration.html#getStringList(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String,%20java.lang.String[])">getStringList</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues)</code> +<div class="block">Creates a string list property.</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/config/Configuration.html#getStringList(java.lang.String,%20java.lang.String,%20java.lang.String[],%20java.lang.String,%20java.lang.String[],%20java.lang.String)">getStringList</a></strong>(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues, + java.lang.String langKey)</code> +<div class="block">Creates a string list property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#hasCategory(java.lang.String)">hasCategory</a></strong>(java.lang.String category)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#hasChanged()">hasChanged</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#hasKey(java.lang.String,%20java.lang.String)">hasKey</a></strong>(java.lang.String category, + java.lang.String key)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#load()">load</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#moveProperty(java.lang.String,%20java.lang.String,%20java.lang.String)">moveProperty</a></strong>(java.lang.String oldCategory, + java.lang.String propName, + java.lang.String newCategory)</code> +<div class="block">Moves a property from one category to another.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#removeCategory(net.minecraftforge.common.config.ConfigCategory)">removeCategory</a></strong>(<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> category)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#renameProperty(java.lang.String,%20java.lang.String,%20java.lang.String)">renameProperty</a></strong>(java.lang.String category, + java.lang.String oldPropName, + java.lang.String newPropName)</code> +<div class="block">Renames a property in a given category.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Configuration.html#save()">save</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/Configuration.html#setCategoryComment(java.lang.String,%20java.lang.String)">setCategoryComment</a></strong>(java.lang.String category, + java.lang.String comment)</code> +<div class="block">Adds a comment to the specified ConfigCategory object</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/Configuration.html#setCategoryConfigEntryClass(java.lang.String,%20java.lang.Class)">setCategoryConfigEntryClass</a></strong>(java.lang.String category, + java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</code> +<div class="block">Sets the custom IConfigEntry class that should be used in place of the standard entry class (which is just a button that + navigates into the category).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/Configuration.html#setCategoryLanguageKey(java.lang.String,%20java.lang.String)">setCategoryLanguageKey</a></strong>(java.lang.String category, + java.lang.String langKey)</code> +<div class="block">Adds a language key to the specified ConfigCategory object</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/Configuration.html#setCategoryPropertyOrder(java.lang.String,%20java.util.List)">setCategoryPropertyOrder</a></strong>(java.lang.String category, + java.util.List<java.lang.String> propOrder)</code> +<div class="block">Sets the order that direct child properties of this config category will be written to the config file and will be displayed in + config GUIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/config/Configuration.html#setCategoryRequiresMcRestart(java.lang.String,%20boolean)">setCategoryRequiresMcRestart</a></strong>(java.lang.String category, + boolean requiresMcRestart)</code> +<div class="block">Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/config/Configuration.html#setCategoryRequiresWorldRestart(java.lang.String,%20boolean)">setCategoryRequiresWorldRestart</a></strong>(java.lang.String category, + boolean requiresWorldRestart)</code> +<div class="block">Sets the flag for whether or not this category can be edited while a world is running.</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/config/Configuration.html#toString()">toString</a></strong>()</code> </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, 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="CATEGORY_GENERAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CATEGORY_GENERAL</h4> +<pre>public static final java.lang.String CATEGORY_GENERAL</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.config.Configuration.CATEGORY_GENERAL">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="ALLOWED_CHARS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ALLOWED_CHARS</h4> +<pre>public static final java.lang.String ALLOWED_CHARS</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.config.Configuration.ALLOWED_CHARS">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="DEFAULT_ENCODING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_ENCODING</h4> +<pre>public static final java.lang.String DEFAULT_ENCODING</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.config.Configuration.DEFAULT_ENCODING">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="CATEGORY_SPLITTER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CATEGORY_SPLITTER</h4> +<pre>public static final java.lang.String CATEGORY_SPLITTER</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.config.Configuration.CATEGORY_SPLITTER">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="NEW_LINE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NEW_LINE</h4> +<pre>public static final java.lang.String NEW_LINE</pre> +</li> +</ul> +<a name="COMMENT_SEPARATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COMMENT_SEPARATOR</h4> +<pre>public static final java.lang.String COMMENT_SEPARATOR</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.config.Configuration.COMMENT_SEPARATOR">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="allowedProperties"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allowedProperties</h4> +<pre>public static final com.google.common.base.CharMatcher allowedProperties</pre> +</li> +</ul> +<a name="defaultEncoding"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>defaultEncoding</h4> +<pre>public java.lang.String defaultEncoding</pre> +</li> +</ul> +<a name="isChild"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isChild</h4> +<pre>public boolean isChild</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Configuration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Configuration</h4> +<pre>public Configuration()</pre> +</li> +</ul> +<a name="Configuration(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Configuration</h4> +<pre>public Configuration(java.io.File file)</pre> +<div class="block">Create a configuration file for the file given in parameter.</div> +</li> +</ul> +<a name="Configuration(java.io.File, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Configuration</h4> +<pre>public Configuration(java.io.File file, + java.lang.String configVersion)</pre> +<div class="block">Create a configuration file for the file given in parameter with the provided config version number.</div> +</li> +</ul> +<a name="Configuration(java.io.File, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Configuration</h4> +<pre>public Configuration(java.io.File file, + java.lang.String configVersion, + boolean caseSensitiveCustomCategories)</pre> +</li> +</ul> +<a name="Configuration(java.io.File, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Configuration</h4> +<pre>public Configuration(java.io.File file, + boolean caseSensitiveCustomCategories)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="getDefinedConfigVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefinedConfigVersion</h4> +<pre>public java.lang.String getDefinedConfigVersion()</pre> +</li> +</ul> +<a name="getLoadedConfigVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLoadedConfigVersion</h4> +<pre>public java.lang.String getLoadedConfigVersion()</pre> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + boolean defaultValue)</pre> +<div class="block">Gets a boolean Property object without a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a boolean Property object without a comment</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + boolean defaultValue, + java.lang.String comment)</pre> +<div class="block">Gets a boolean Property object with a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>a boolean Property object without a comment</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + boolean[] defaultValues)</pre> +<div class="block">Gets a boolean array Property without a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd> +<dt><span class="strong">Returns:</span></dt><dd>a boolean array Property without a comment using these defaults: isListLengthFixed = false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, boolean[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment)</pre> +<div class="block">Gets a boolean array Property with a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>a boolean array Property with a comment using these defaults: isListLengthFixed = false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, boolean[], java.lang.String, boolean, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength)</pre> +<div class="block">Gets a boolean array Property with all settings defined.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>isListLengthFixed</code> - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)</dd><dd><code>maxListLength</code> - the maximum length of this array, use -1 for no max length</dd> +<dt><span class="strong">Returns:</span></dt><dd>a boolean array Property with all settings defined</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int defaultValue)</pre> +<div class="block">Gets an integer Property object without a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment)</pre> +<div class="block">Gets an integer Property object with a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int, java.lang.String, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment, + int minValue, + int maxValue)</pre> +<div class="block">Gets an integer Property object with the defined comment, minimum and maximum bounds.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd><dd><code>minValue</code> - minimum boundary</dd><dd><code>maxValue</code> - maximum boundary</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer Property object with the defined comment, minimum and maximum bounds</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int[] defaultValues)</pre> +<div class="block">Gets an integer array Property object without a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment)</pre> +<div class="block">Gets an integer array Property object with a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int[], java.lang.String, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue)</pre> +<div class="block">Gets an integer array Property object with the defined comment, minimum and maximum bounds.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>minValue</code> - minimum boundary</dd><dd><code>maxValue</code> - maximum boundary</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed + = false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, int[], java.lang.String, int, int, boolean, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue, + boolean isListLengthFixed, + int maxListLength)</pre> +<div class="block">Gets an integer array Property object with all settings defined.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>minValue</code> - minimum boundary</dd><dd><code>maxValue</code> - maximum boundary</dd><dd><code>isListLengthFixed</code> - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)</dd><dd><code>maxListLength</code> - the maximum length of this array, use -1 for no max length</dd> +<dt><span class="strong">Returns:</span></dt><dd>an integer array Property object with all settings defined</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double defaultValue)</pre> +<div class="block">Gets a double Property object without a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment)</pre> +<div class="block">Gets a double Property object with a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double, java.lang.String, double, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment, + double minValue, + double maxValue)</pre> +<div class="block">Gets a double Property object with the defined comment, minimum and maximum bounds</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd><dd><code>minValue</code> - minimum boundary</dd><dd><code>maxValue</code> - maximum boundary</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double Property object with the defined comment, minimum and maximum bounds</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double[] defaultValues)</pre> +<div class="block">Gets a double array Property object without a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment)</pre> +<div class="block">Gets a double array Property object without a comment using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double[], java.lang.String, double, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue)</pre> +<div class="block">Gets a double array Property object with the defined comment, minimum and maximum bounds.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>minValue</code> - minimum boundary</dd><dd><code>maxValue</code> - maximum boundary</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed = + false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, double[], java.lang.String, double, double, boolean, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue, + boolean isListLengthFixed, + int maxListLength)</pre> +<div class="block">Gets a double array Property object with all settings defined.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>minValue</code> - minimum boundary</dd><dd><code>maxValue</code> - maximum boundary</dd><dd><code>isListLengthFixed</code> - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)</dd><dd><code>maxListLength</code> - the maximum length of this array, use -1 for no max length</dd> +<dt><span class="strong">Returns:</span></dt><dd>a double array Property object with all settings defined</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue)</pre> +<div class="block">Gets a string Property without a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string Property with validationPattern = null, validValues = null</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment)</pre> +<div class="block">Gets a string Property with a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string Property with validationPattern = null, validValues = null</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern validationPattern)</pre> +<div class="block">Gets a string Property with a comment using the defined validationPattern and otherwise default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd><dd><code>validationPattern</code> - a Pattern object for input validation</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string Property with the defined validationPattern, validValues = null</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues)</pre> +<div class="block">Gets a string Property with a comment using the defined validValues array and otherwise default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd><dd><code>validValues</code> - an array of valid values that this Property can be set to. If an array is provided the Config GUI control will be + a value cycle button.</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string Property with the defined validValues array, validationPattern = null</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues)</pre> +<div class="block">Gets a string array Property without a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment)</pre> +<div class="block">Gets a string array Property with a comment using the default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String[], java.lang.String, java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + java.util.regex.Pattern validationPattern)</pre> +<div class="block">Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>validationPattern</code> - a Pattern object for input validation</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string array Property with the defined validationPattern, isListLengthFixed = false, maxListLength = -1</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String[], java.lang.String, boolean, int, java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength, + java.util.regex.Pattern validationPattern)</pre> +<div class="block">Gets a string array Property with a comment with all settings defined.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>isListLengthFixed</code> - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)</dd><dd><code>maxListLength</code> - the maximum length of this array, use -1 for no max length</dd><dd><code>validationPattern</code> - a Pattern object for input validation</dd> +<dt><span class="strong">Returns:</span></dt><dd>a string array Property with a comment with all settings defined</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</pre> +<div class="block">Gets a Property object of the specified type using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValue</code> - the default value</dd><dd><code>comment</code> - a String comment</dd><dd><code>type</code> - a Property.Type enum value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a Property object of the specified type using default settings</dd></dl> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String, java.lang.String[], java.lang.String, net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</pre> +<div class="block">Gets a list (array) Property object of the specified type using default settings.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>key</code> - the Property key value</dd><dd><code>defaultValues</code> - an array containing the default values</dd><dd><code>comment</code> - a String comment</dd><dd><code>type</code> - a Property.Type enum value</dd> +<dt><span class="strong">Returns:</span></dt><dd>a list (array) Property object of the specified type using default settings</dd></dl> +</li> +</ul> +<a name="hasCategory(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasCategory</h4> +<pre>public boolean hasCategory(java.lang.String category)</pre> +</li> +</ul> +<a name="hasKey(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasKey</h4> +<pre>public boolean hasKey(java.lang.String category, + java.lang.String key)</pre> +</li> +</ul> +<a name="load()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>load</h4> +<pre>public void load()</pre> +</li> +</ul> +<a name="save()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>save</h4> +<pre>public void save()</pre> +</li> +</ul> +<a name="getCategory(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCategory</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> getCategory(java.lang.String category)</pre> +</li> +</ul> +<a name="removeCategory(net.minecraftforge.common.config.ConfigCategory)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>removeCategory</h4> +<pre>public void removeCategory(<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a> category)</pre> +</li> +</ul> +<a name="setCategoryComment(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategoryComment</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> setCategoryComment(java.lang.String category, + java.lang.String comment)</pre> +<div class="block">Adds a comment to the specified ConfigCategory object</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>comment</code> - a String comment</dd></dl> +</li> +</ul> +<a name="addCustomCategoryComment(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCustomCategoryComment</h4> +<pre>public void addCustomCategoryComment(java.lang.String category, + java.lang.String comment)</pre> +</li> +</ul> +<a name="setCategoryLanguageKey(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategoryLanguageKey</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> setCategoryLanguageKey(java.lang.String category, + java.lang.String langKey)</pre> +<div class="block">Adds a language key to the specified ConfigCategory object</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the config category</dd><dd><code>langKey</code> - a language key string such as configcategory.general</dd></dl> +</li> +</ul> +<a name="setCategoryConfigEntryClass(java.lang.String, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategoryConfigEntryClass</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> setCategoryConfigEntryClass(java.lang.String category, + java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</pre> +<div class="block">Sets the custom IConfigEntry class that should be used in place of the standard entry class (which is just a button that + navigates into the category). This class MUST provide a constructor with the following parameter types: <code>GuiConfig</code> (the parent + GuiConfig screen will be provided), <code>GuiPropertyList</code> (the parent GuiPropertyList will be provided), <code>IConfigElement</code> + (the IConfigElement for this Property will be provided).</div> +</li> +</ul> +<a name="setCategoryRequiresWorldRestart(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategoryRequiresWorldRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> setCategoryRequiresWorldRestart(java.lang.String category, + boolean requiresWorldRestart)</pre> +<div class="block">Sets the flag for whether or not this category can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. Only set this flag to + true if all child properties/categories are unable to be modified while a world is running.</div> +</li> +</ul> +<a name="setCategoryRequiresMcRestart(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategoryRequiresMcRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> setCategoryRequiresMcRestart(java.lang.String category, + boolean requiresMcRestart)</pre> +<div class="block">Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false. Only set this flag to true if ALL child properties/categories require + Minecraft to be restarted when changed. Setting this flag will also prevent modification + of the child properties/categories while a world is running.</div> +</li> +</ul> +<a name="setCategoryPropertyOrder(java.lang.String, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCategoryPropertyOrder</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> setCategoryPropertyOrder(java.lang.String category, + java.util.List<java.lang.String> propOrder)</pre> +<div class="block">Sets the order that direct child properties of this config category will be written to the config file and will be displayed in + config GUIs.</div> +</li> +</ul> +<a name="enableGlobalConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enableGlobalConfig</h4> +<pre>public static void enableGlobalConfig()</pre> +</li> +</ul> +<a name="hasChanged()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasChanged</h4> +<pre>public boolean hasChanged()</pre> +</li> +</ul> +<a name="getCategoryNames()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCategoryNames</h4> +<pre>public java.util.Set<java.lang.String> getCategoryNames()</pre> +</li> +</ul> +<a name="renameProperty(java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>renameProperty</h4> +<pre>public boolean renameProperty(java.lang.String category, + java.lang.String oldPropName, + java.lang.String newPropName)</pre> +<div class="block">Renames a property in a given category.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>category</code> - the category in which the property resides</dd><dd><code>oldPropName</code> - the existing property name</dd><dd><code>newPropName</code> - the new property name</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the category and property exist, false otherwise</dd></dl> +</li> +</ul> +<a name="moveProperty(java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>moveProperty</h4> +<pre>public boolean moveProperty(java.lang.String oldCategory, + java.lang.String propName, + java.lang.String newCategory)</pre> +<div class="block">Moves a property from one category to another.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>oldCategory</code> - the category the property currently resides in</dd><dd><code>propName</code> - the name of the property to move</dd><dd><code>newCategory</code> - the category the property should be moved to</dd> +<dt><span class="strong">Returns:</span></dt><dd>true if the old category and property exist, false otherwise</dd></dl> +</li> +</ul> +<a name="copyCategoryProps(net.minecraftforge.common.config.Configuration, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyCategoryProps</h4> +<pre>public void copyCategoryProps(<a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a> fromConfig, + java.lang.String[] ctgys)</pre> +<div class="block">Copies property objects from another Configuration object to this one using the list of category names. Properties that only exist in the + "from" object are ignored. Pass null for the ctgys array to include all categories.</div> +</li> +</ul> +<a name="getString(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment)</pre> +<div class="block">Creates a string property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getString(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey)</pre> +<div class="block">Creates a string property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>langKey</code> - A language key used for localization of GUIs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getString(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern pattern)</pre> +<div class="block">Creates a string property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getString(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey, + java.util.regex.Pattern pattern)</pre> +<div class="block">Creates a string property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>langKey</code> - A language key used for localization of GUIs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getString(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues)</pre> +<div class="block">Creates a string property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>validValues</code> - A list of valid values that this property can be set to.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getString(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues, + java.lang.String langKey)</pre> +<div class="block">Creates a string property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>validValues</code> - A list of valid values that this property can be set to.</dd><dd><code>langKey</code> - A language key used for localization of GUIs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getStringList(java.lang.String, java.lang.String, java.lang.String[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStringList</h4> +<pre>public java.lang.String[] getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValues, + java.lang.String comment)</pre> +<div class="block">Creates a string list property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getStringList(java.lang.String, java.lang.String, java.lang.String[], java.lang.String, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStringList</h4> +<pre>public java.lang.String[] getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues)</pre> +<div class="block">Creates a string list property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getStringList(java.lang.String, java.lang.String, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStringList</h4> +<pre>public java.lang.String[] getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues, + java.lang.String langKey)</pre> +<div class="block">Creates a string list property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new string property.</dd></dl> +</li> +</ul> +<a name="getBoolean(java.lang.String, java.lang.String, boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment)</pre> +<div class="block">Creates a boolean property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new boolean property.</dd></dl> +</li> +</ul> +<a name="getBoolean(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment, + java.lang.String langKey)</pre> +<div class="block">Creates a boolean property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>langKey</code> - A language key used for localization of GUIs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new boolean property.</dd></dl> +</li> +</ul> +<a name="getInt(java.lang.String, java.lang.String, int, int, int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment)</pre> +<div class="block">Creates a integer property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>minValue</code> - Minimum value of the property.</dd><dd><code>maxValue</code> - Maximum value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new integer property.</dd></dl> +</li> +</ul> +<a name="getInt(java.lang.String, java.lang.String, int, int, int, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment, + java.lang.String langKey)</pre> +<div class="block">Creates a integer property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>minValue</code> - Minimum value of the property.</dd><dd><code>maxValue</code> - Maximum value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>langKey</code> - A language key used for localization of GUIs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new integer property.</dd></dl> +</li> +</ul> +<a name="getFloat(java.lang.String, java.lang.String, float, float, float, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFloat</h4> +<pre>public float getFloat(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment)</pre> +<div class="block">Creates a float property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>minValue</code> - Minimum value of the property.</dd><dd><code>maxValue</code> - Maximum value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new float property.</dd></dl> +</li> +</ul> +<a name="getFloat(java.lang.String, java.lang.String, float, float, float, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFloat</h4> +<pre>public float getFloat(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment, + java.lang.String langKey)</pre> +<div class="block">Creates a float property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - Name of the property.</dd><dd><code>category</code> - Category of the property.</dd><dd><code>defaultValue</code> - Default value of the property.</dd><dd><code>minValue</code> - Minimum value of the property.</dd><dd><code>maxValue</code> - Maximum value of the property.</dd><dd><code>comment</code> - A brief description what the property does.</dd><dd><code>langKey</code> - A language key used for localization of GUIs</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value of the new float property.</dd></dl> +</li> +</ul> +<a name="getConfigFile()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConfigFile</h4> +<pre>public java.io.File getConfigFile()</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/config/ConfigElement.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Configuration.html" target="_top">Frames</a></li> +<li><a href="Configuration.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> diff --git a/javadoc/net/minecraftforge/common/config/Property.Type.html b/javadoc/net/minecraftforge/common/config/Property.Type.html new file mode 100644 index 0000000..10d5191 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Property.Type.html @@ -0,0 +1,395 @@ +<!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:11 EST 2015 --> +<title>Property.Type (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="Property.Type (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/config/Property.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Property.Type.html" target="_top">Frames</a></li> +<li><a href="Property.Type.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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.config</div> +<h2 title="Enum Property.Type" class="title">Enum Property.Type</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.Property.Type</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a>></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">Property.Type</span> +extends java.lang.Enum<<a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#BOOLEAN">BOOLEAN</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#COLOR">COLOR</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#DOUBLE">DOUBLE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#INTEGER">INTEGER</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#MOD_ID">MOD_ID</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#STRING">STRING</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>char</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#getID()">getID</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#tryParse(char)">tryParse</a></strong>(char id)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="STRING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>STRING</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> STRING</pre> +</li> +</ul> +<a name="INTEGER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INTEGER</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> INTEGER</pre> +</li> +</ul> +<a name="BOOLEAN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BOOLEAN</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> BOOLEAN</pre> +</li> +</ul> +<a name="DOUBLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DOUBLE</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> DOUBLE</pre> +</li> +</ul> +<a name="COLOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COLOR</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> COLOR</pre> +</li> +</ul> +<a name="MOD_ID"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MOD_ID</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> MOD_ID</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Property.Type c : Property.Type.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="tryParse(char)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tryParse</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> tryParse(char id)</pre> +</li> +</ul> +<a name="getID()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getID</h4> +<pre>public char getID()</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/config/Property.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Property.Type.html" target="_top">Frames</a></li> +<li><a href="Property.Type.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="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/config/Property.html b/javadoc/net/minecraftforge/common/config/Property.html new file mode 100644 index 0000000..3c842c9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Property.html @@ -0,0 +1,1733 @@ +<!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:11 EST 2015 --> +<title>Property (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="Property (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/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Property.html" target="_top">Frames</a></li> +<li><a href="Property.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.config</div> +<h2 title="Class Property" class="title">Class Property</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.Property</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Property</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/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</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>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#comment">comment</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/config/Property.html#Property(java.lang.String,%20java.lang.String[],%20net.minecraftforge.common.config.Property.Type)">Property</a></strong>(java.lang.String name, + java.lang.String[] values, + <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="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String[],%20net.minecraftforge.common.config.Property.Type,%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type)">Property</a></strong>(java.lang.String name, + 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="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20boolean)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20boolean,%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read, + java.lang.String langKey)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20java.lang.String[])">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20java.lang.String[],%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues, + java.lang.String langKey)</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>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getArrayEntryClass()">getArrayEntryClass</a></strong>()</code> +<div class="block">Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getBoolean()">getBoolean</a></strong>()</code> +<div class="block">Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getBoolean(boolean)">getBoolean</a></strong>(boolean _default)</code> +<div class="block">Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getBooleanList()">getBooleanList</a></strong>()</code> +<div class="block">Returns the boolean value of all values that can + be parsed in the list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getConfigEntryClass()">getConfigEntryClass</a></strong>()</code> +<div class="block">Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</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/config/Property.html#getDefault()">getDefault</a></strong>()</code> +<div class="block">Gets the raw String default value of this Property.</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/config/Property.html#getDefaults()">getDefaults</a></strong>()</code> +<div class="block">Gets the raw String[] default values of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDouble()">getDouble</a></strong>()</code> +<div class="block">Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDouble(double)">getDouble</a></strong>(double _default)</code> +<div class="block">Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDoubleList()">getDoubleList</a></strong>()</code> +<div class="block">Returns the double value of all values that can + be parsed in the list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getInt()">getInt</a></strong>()</code> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getInt(int)">getInt</a></strong>(int _default)</code> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getIntList()">getIntList</a></strong>()</code> +<div class="block">Returns the integer value of all values that can + be parsed in the list.</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/config/Property.html#getLanguageKey()">getLanguageKey</a></strong>()</code> +<div class="block">Gets the language key string for this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getMaxListLength()">getMaxListLength</a></strong>()</code> +<div class="block">Gets the maximum length of this list/array Property.</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/config/Property.html#getMaxValue()">getMaxValue</a></strong>()</code> +<div class="block">Gets the maximum value.</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/config/Property.html#getMinValue()">getMinValue</a></strong>()</code> +<div class="block">Gets the minimum value.</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/config/Property.html#getName()">getName</a></strong>()</code> +<div class="block">Gets the name/key for this Property.</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/config/Property.html#getString()">getString</a></strong>()</code> +<div class="block">Returns the value in this property as it's raw string.</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/config/Property.html#getStringList()">getStringList</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getType()">getType</a></strong>()</code> +<div class="block">Gets the Property.Type enum value for this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.regex.Pattern</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getValidationPattern()">getValidationPattern</a></strong>()</code> +<div class="block">Gets the Pattern object used to validate user input for this Property.</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/config/Property.html#getValidValues()">getValidValues</a></strong>()</code> +<div class="block">Gets the array of valid values that this String Property can be set to, or null if not defined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#hasChanged()">hasChanged</a></strong>()</code> +<div class="block">Gets the changed status of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isBooleanList()">isBooleanList</a></strong>()</code> +<div class="block">Checks if all of current values stored in this property can be converted to a boolean.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isBooleanValue()">isBooleanValue</a></strong>()</code> +<div class="block">Checks if the current value held by this property is a valid boolean value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isDefault()">isDefault</a></strong>()</code> +<div class="block">Returns whether or not this Property is defaulted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isDoubleList()">isDoubleList</a></strong>()</code> +<div class="block">Checks if all of the current values stored in this property can be converted to a double.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isDoubleValue()">isDoubleValue</a></strong>()</code> +<div class="block">Checks if the current value held by this property is a valid double value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isIntList()">isIntList</a></strong>()</code> +<div class="block">Checks if all of the current values stored in this property can be converted to an integer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isIntValue()">isIntValue</a></strong>()</code> +<div class="block">Checks if the current value stored in this property can be converted to an integer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isList()">isList</a></strong>()</code> +<div class="block">Returns whether or not this Property is a list/array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isListLengthFixed()">isListLengthFixed</a></strong>()</code> +<div class="block">Returns whether or not this list/array has a fixed length.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#requiresMcRestart()">requiresMcRestart</a></strong>()</code> +<div class="block">Gets whether or not this Property requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#requiresWorldRestart()">requiresWorldRestart</a></strong>()</code> +<div class="block">Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(boolean)">set</a></strong>(boolean value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(boolean[])">set</a></strong>(boolean[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(double)">set</a></strong>(double value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(double[])">set</a></strong>(double[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(int)">set</a></strong>(int value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(int[])">set</a></strong>(int[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(java.lang.String)">set</a></strong>(java.lang.String value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(java.lang.String[])">set</a></strong>(java.lang.String[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setArrayEntryClass(java.lang.Class)">setArrayEntryClass</a></strong>(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> clazz)</code> +<div class="block">Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setConfigEntryClass(java.lang.Class)">setConfigEntryClass</a></strong>(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</code> +<div class="block">Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(boolean)">setDefaultValue</a></strong>(boolean defaultValue)</code> +<div class="block">Sets the default boolean value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(double)">setDefaultValue</a></strong>(double defaultValue)</code> +<div class="block">Sets the default double value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(int)">setDefaultValue</a></strong>(int defaultValue)</code> +<div class="block">Sets the default int value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(java.lang.String)">setDefaultValue</a></strong>(java.lang.String defaultValue)</code> +<div class="block">Sets the default string value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(boolean[])">setDefaultValues</a></strong>(boolean[] defaultValues)</code> +<div class="block">Sets the default boolean[] values of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(double[])">setDefaultValues</a></strong>(double[] defaultValues)</code> +<div class="block">Sets the default double[] values of this Property</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(int[])">setDefaultValues</a></strong>(int[] defaultValues)</code> +<div class="block">Sets the default int[] values of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(java.lang.String[])">setDefaultValues</a></strong>(java.lang.String[] defaultValues)</code> +<div class="block">Sets the default String[] values of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setIsListLengthFixed(boolean)">setIsListLengthFixed</a></strong>(boolean isListLengthFixed)</code> +<div class="block">Sets the flag for whether this list/array Property has a fixed length.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setLanguageKey(java.lang.String)">setLanguageKey</a></strong>(java.lang.String langKey)</code> +<div class="block">Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMaxListLength(int)">setMaxListLength</a></strong>(int max)</code> +<div class="block">Sets the maximum length of this list/array Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMaxValue(double)">setMaxValue</a></strong>(double maxValue)</code> +<div class="block">Sets the maximum double value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMaxValue(int)">setMaxValue</a></strong>(int maxValue)</code> +<div class="block">Sets the maximum int value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMinValue(double)">setMinValue</a></strong>(double minValue)</code> +<div class="block">Sets the minimum double value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMinValue(int)">setMinValue</a></strong>(int minValue)</code> +<div class="block">Sets the minimum int value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Sets the name/key for this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setRequiresMcRestart(boolean)">setRequiresMcRestart</a></strong>(boolean requiresMcRestart)</code> +<div class="block">Sets whether or not this Property requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setRequiresWorldRestart(boolean)">setRequiresWorldRestart</a></strong>(boolean requiresWorldRestart)</code> +<div class="block">Sets the flag for whether or not this Property can be edited while a world is running.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setShowInGui(boolean)">setShowInGui</a></strong>(boolean showInGui)</code> +<div class="block">Sets whether or not this Property should be allowed to show on config GUIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setToDefault()">setToDefault</a></strong>()</code> +<div class="block">Sets the current value(s) of this Property to the default value(s).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValidationPattern(java.util.regex.Pattern)">setValidationPattern</a></strong>(java.util.regex.Pattern validationPattern)</code> +<div class="block">Sets a regex Pattern object used to validate user input for formatted String or String[] properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValidValues(java.lang.String[])">setValidValues</a></strong>(java.lang.String[] validValues)</code> +<div class="block">Sets the array of valid values that this String Property can be set to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(boolean)">setValue</a></strong>(boolean value)</code> +<div class="block">Sets the value of this Property to the provided boolean value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(double)">setValue</a></strong>(double value)</code> +<div class="block">Sets the value of this Property to the provided double value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(int)">setValue</a></strong>(int value)</code> +<div class="block">Sets the value of this Property to the provided int value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Sets the value of this Property to the provided String value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(boolean[])">setValues</a></strong>(boolean[] values)</code> +<div class="block">Sets the values of this Property to the provided boolean[] values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(double[])">setValues</a></strong>(double[] values)</code> +<div class="block">Sets the values of this Property to the provided double[] values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(int[])">setValues</a></strong>(int[] values)</code> +<div class="block">Sets the values of this Property to the provided int[] values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(java.lang.String[])">setValues</a></strong>(java.lang.String[] values)</code> +<div class="block">Sets the values of this Property to the provided String[] values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#showInGui()">showInGui</a></strong>()</code> +<div class="block">Gets whether or not this Property should be allowed to show on config GUIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#wasRead()">wasRead</a></strong>()</code> +<div class="block">Determines if this config value was just created, or if it was read from the config file.</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="comment"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>comment</h4> +<pre>public java.lang.String comment</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + 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> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read, + java.lang.String langKey)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, java.lang.String[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues, + java.lang.String langKey)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String[], net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String[], net.minecraftforge.common.config.Property.Type, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDefault</h4> +<pre>public boolean isDefault()</pre> +<div class="block">Returns whether or not this Property is defaulted.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the current value(s) is(are) deeply equal to the default value(s)</dd></dl> +</li> +</ul> +<a name="setToDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setToDefault</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setToDefault()</pre> +<div class="block">Sets the current value(s) of this Property to the default value(s).</div> +</li> +</ul> +<a name="getDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefault</h4> +<pre>public java.lang.String getDefault()</pre> +<div class="block">Gets the raw String default value of this Property. Check for isList() == false first.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the default value String</dd></dl> +</li> +</ul> +<a name="getDefaults()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaults</h4> +<pre>public java.lang.String[] getDefaults()</pre> +<div class="block">Gets the raw String[] default values of this Property. Check for isList() == true first.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the default values String[]</dd></dl> +</li> +</ul> +<a name="setRequiresWorldRestart(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequiresWorldRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setRequiresWorldRestart(boolean requiresWorldRestart)</pre> +<div class="block">Sets the flag for whether or not this Property can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. When set to false the Property will be + editable from both the main menu Mods list config screen and the in-game Mod Options config screen. When set to true the Property + will only be editable from the main menu Mods list config screen.</div> +</li> +</ul> +<a name="requiresWorldRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresWorldRestart</h4> +<pre>public boolean requiresWorldRestart()</pre> +<div class="block">Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen. Setting this flag to true will disable editing of + this property while a world is running.</div> +</li> +</ul> +<a name="setShowInGui(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShowInGui</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setShowInGui(boolean showInGui)</pre> +<div class="block">Sets whether or not this Property should be allowed to show on config GUIs. + Defaults to true.</div> +</li> +</ul> +<a name="showInGui()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>showInGui</h4> +<pre>public boolean showInGui()</pre> +<div class="block">Gets whether or not this Property should be allowed to show on config GUIs. + Defaults to true unless set to false.</div> +</li> +</ul> +<a name="setRequiresMcRestart(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequiresMcRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setRequiresMcRestart(boolean requiresMcRestart)</pre> +<div class="block">Sets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false. Setting this flag to true will also disable editing of + this property while a world is running.</div> +</li> +</ul> +<a name="requiresMcRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresMcRestart</h4> +<pre>public boolean requiresMcRestart()</pre> +<div class="block">Gets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false unless set to true.</div> +</li> +</ul> +<a name="setMaxListLength(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxListLength</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMaxListLength(int max)</pre> +<div class="block">Sets the maximum length of this list/array Property. Only important if isList() == true. If the current values array or default + values array is longer than the new maximum it will be resized. If calling both this method and setIsListLengthFixed(true), this + method should be called afterwards (but is not required).</div> +</li> +</ul> +<a name="getMaxListLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxListLength</h4> +<pre>public int getMaxListLength()</pre> +<div class="block">Gets the maximum length of this list/array Property. Only important if isList() == true.</div> +</li> +</ul> +<a name="setIsListLengthFixed(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIsListLengthFixed</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setIsListLengthFixed(boolean isListLengthFixed)</pre> +<div class="block">Sets the flag for whether this list/array Property has a fixed length. Only important if isList() == true. If calling both this + method and setMaxListLength(), this method should be called first (but is not required).</div> +</li> +</ul> +<a name="isListLengthFixed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isListLengthFixed</h4> +<pre>public boolean isListLengthFixed()</pre> +<div class="block">Returns whether or not this list/array has a fixed length. Only important if isList() == true.</div> +</li> +</ul> +<a name="setConfigEntryClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfigEntryClass</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setConfigEntryClass(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</pre> +<div class="block">Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type. This class + MUST provide a constructor with the following parameter types: <code>GuiConfig</code> (the owning GuiConfig screen will be provided), + <code>GuiConfigEntries</code> (the owning GuiConfigEntries will be provided), <code>IConfigElement</code> (the IConfigElement for this Property + will be provided).</div> +</li> +</ul> +<a name="getConfigEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> getConfigEntryClass()</pre> +<div class="block">Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a class that implements IConfigEntry</dd></dl> +</li> +</ul> +<a name="setArrayEntryClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setArrayEntryClass</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setArrayEntryClass(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> clazz)</pre> +<div class="block">Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type. This class + MUST provide a constructor with the following parameter types: <code>GuiEditList</code> (the owning GuiEditList screen will be provided), + <code>GuiPropertyList</code> (the parent GuiPropertyList will be provided), <code>IConfigProperty</code> (the IConfigProperty for this Property + will be provided).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - a class that implements IConfigEntry</dd></dl> +</li> +</ul> +<a name="getArrayEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArrayEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> getArrayEntryClass()</pre> +<div class="block">Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a class that implements IArrayEntry</dd></dl> +</li> +</ul> +<a name="setValidationPattern(java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValidationPattern</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValidationPattern(java.util.regex.Pattern validationPattern)</pre> +<div class="block">Sets a regex Pattern object used to validate user input for formatted String or String[] properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validationPattern</code> - </dd></dl> +</li> +</ul> +<a name="getValidationPattern()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationPattern</h4> +<pre>public java.util.regex.Pattern getValidationPattern()</pre> +<div class="block">Gets the Pattern object used to validate user input for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the user input validation Pattern object, or null if none is set</dd></dl> +</li> +</ul> +<a name="setLanguageKey(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLanguageKey</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setLanguageKey(java.lang.String langKey)</pre> +<div class="block">Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3. The string languageKey + + ".tooltip" is used for tooltips when a user hovers the mouse over a GUI property label.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>langKey</code> - a string language key such as myawesomemod.config.myPropName</dd></dl> +</li> +</ul> +<a name="getLanguageKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLanguageKey</h4> +<pre>public java.lang.String getLanguageKey()</pre> +<div class="block">Gets the language key string for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the language key</dd></dl> +</li> +</ul> +<a name="setDefaultValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(java.lang.String defaultValue)</pre> +<div class="block">Sets the default string value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - a String value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(java.lang.String[] defaultValues)</pre> +<div class="block">Sets the default String[] values of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of String values</dd></dl> +</li> +</ul> +<a name="setDefaultValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(int defaultValue)</pre> +<div class="block">Sets the default int value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - an int value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(int[] defaultValues)</pre> +<div class="block">Sets the default int[] values of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of int values</dd></dl> +</li> +</ul> +<a name="setDefaultValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(double defaultValue)</pre> +<div class="block">Sets the default double value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - a double value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(double[] defaultValues)</pre> +<div class="block">Sets the default double[] values of this Property</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of double values</dd></dl> +</li> +</ul> +<a name="setDefaultValue(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(boolean defaultValue)</pre> +<div class="block">Sets the default boolean value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - a boolean value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(boolean[] defaultValues)</pre> +<div class="block">Sets the default boolean[] values of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of boolean values</dd></dl> +</li> +</ul> +<a name="setMinValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMinValue(int minValue)</pre> +<div class="block">Sets the minimum int value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minValue</code> - an int value</dd></dl> +</li> +</ul> +<a name="setMaxValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMaxValue(int maxValue)</pre> +<div class="block">Sets the maximum int value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxValue</code> - an int value</dd></dl> +</li> +</ul> +<a name="setMinValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMinValue(double minValue)</pre> +<div class="block">Sets the minimum double value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minValue</code> - a double value</dd></dl> +</li> +</ul> +<a name="setMaxValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMaxValue(double maxValue)</pre> +<div class="block">Sets the maximum double value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxValue</code> - a double value</dd></dl> +</li> +</ul> +<a name="getMinValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinValue</h4> +<pre>public java.lang.String getMinValue()</pre> +<div class="block">Gets the minimum value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the minimum value bound</dd></dl> +</li> +</ul> +<a name="getMaxValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxValue</h4> +<pre>public java.lang.String getMaxValue()</pre> +<div class="block">Gets the maximum value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the maximum value bound</dd></dl> +</li> +</ul> +<a name="getString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString()</pre> +<div class="block">Returns the value in this property as it's raw string.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>current value</dd></dl> +</li> +</ul> +<a name="setValidValues(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValidValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValidValues(java.lang.String[] validValues)</pre> +<div class="block">Sets the array of valid values that this String Property can be set to. When an array of valid values is defined for a Property the + GUI control for that property will be a value cycle button.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validValues</code> - a String array of valid values</dd></dl> +</li> +</ul> +<a name="getValidValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidValues</h4> +<pre>public java.lang.String[] getValidValues()</pre> +<div class="block">Gets the array of valid values that this String Property can be set to, or null if not defined.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a String array of valid values</dd></dl> +</li> +</ul> +<a name="getInt()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt()</pre> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="getInt(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(int _default)</pre> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide if the current value is not a valid integer</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="isIntValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIntValue</h4> +<pre>public boolean isIntValue()</pre> +<div class="block">Checks if the current value stored in this property can be converted to an integer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the type of the Property is an Integer</dd></dl> +</li> +</ul> +<a name="getBoolean(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(boolean _default)</pre> +<div class="block">Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value as a boolean, or the default</dd></dl> +</li> +</ul> +<a name="getBoolean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean()</pre> +<div class="block">Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The value as a boolean, or the default</dd></dl> +</li> +</ul> +<a name="isBooleanValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBooleanValue</h4> +<pre>public boolean isBooleanValue()</pre> +<div class="block">Checks if the current value held by this property is a valid boolean value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if it is a boolean value</dd></dl> +</li> +</ul> +<a name="isDoubleValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDoubleValue</h4> +<pre>public boolean isDoubleValue()</pre> +<div class="block">Checks if the current value held by this property is a valid double value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the value can be converted to an double</dd></dl> +</li> +</ul> +<a name="getDouble(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble(double _default)</pre> +<div class="block">Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide if the current value is not a valid double</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="getDouble()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble()</pre> +<div class="block">Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide if the current value is not a valid double</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="getStringList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStringList</h4> +<pre>public java.lang.String[] getStringList()</pre> +</li> +</ul> +<a name="getIntList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIntList</h4> +<pre>public int[] getIntList()</pre> +<div class="block">Returns the integer value of all values that can + be parsed in the list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Array of length 0 if none of the values could be parsed.</dd></dl> +</li> +</ul> +<a name="isIntList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIntList</h4> +<pre>public boolean isIntList()</pre> +<div class="block">Checks if all of the current values stored in this property can be converted to an integer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the type of the Property is an Integer List</dd></dl> +</li> +</ul> +<a name="getBooleanList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBooleanList</h4> +<pre>public boolean[] getBooleanList()</pre> +<div class="block">Returns the boolean value of all values that can + be parsed in the list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Array of length 0 if none of the values could be parsed.</dd></dl> +</li> +</ul> +<a name="isBooleanList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBooleanList</h4> +<pre>public boolean isBooleanList()</pre> +<div class="block">Checks if all of current values stored in this property can be converted to a boolean.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if it is a boolean value</dd></dl> +</li> +</ul> +<a name="getDoubleList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDoubleList</h4> +<pre>public double[] getDoubleList()</pre> +<div class="block">Returns the double value of all values that can + be parsed in the list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Array of length 0 if none of the values could be parsed.</dd></dl> +</li> +</ul> +<a name="isDoubleList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDoubleList</h4> +<pre>public boolean isDoubleList()</pre> +<div class="block">Checks if all of the current values stored in this property can be converted to a double.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the type of the Property is a double List</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block">Gets the name/key for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the Property name</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block">Sets the name/key for this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a name</dd></dl> +</li> +</ul> +<a name="wasRead()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wasRead</h4> +<pre>public boolean wasRead()</pre> +<div class="block">Determines if this config value was just created, or if it was read from the config file. + This is useful for mods who auto-assign their blocks to determine if the ID returned is + a configured one, or a automatically generated one.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if this property was loaded from the config file with a value</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> getType()</pre> +<div class="block">Gets the Property.Type enum value for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the Property's type</dd></dl> +</li> +</ul> +<a name="isList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isList</h4> +<pre>public boolean isList()</pre> +<div class="block">Returns whether or not this Property is a list/array.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if this Property is a list/array, false otherwise</dd></dl> +</li> +</ul> +<a name="hasChanged()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasChanged</h4> +<pre>public boolean hasChanged()</pre> +<div class="block">Gets the changed status of this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if this Property has changed, false otherwise</dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(java.lang.String value)</pre> +<div class="block">Sets the value of this Property to the provided String value.</div> +</li> +</ul> +<a name="set(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(java.lang.String value)</pre> +</li> +</ul> +<a name="setValues(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(java.lang.String[] values)</pre> +<div class="block">Sets the values of this Property to the provided String[] values.</div> +</li> +</ul> +<a name="set(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(java.lang.String[] values)</pre> +</li> +</ul> +<a name="setValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(int value)</pre> +<div class="block">Sets the value of this Property to the provided int value.</div> +</li> +</ul> +<a name="setValue(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(boolean value)</pre> +<div class="block">Sets the value of this Property to the provided boolean value.</div> +</li> +</ul> +<a name="setValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(double value)</pre> +<div class="block">Sets the value of this Property to the provided double value.</div> +</li> +</ul> +<a name="setValues(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(boolean[] values)</pre> +<div class="block">Sets the values of this Property to the provided boolean[] values.</div> +</li> +</ul> +<a name="set(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(boolean[] values)</pre> +</li> +</ul> +<a name="setValues(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(int[] values)</pre> +<div class="block">Sets the values of this Property to the provided int[] values.</div> +</li> +</ul> +<a name="set(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(int[] values)</pre> +</li> +</ul> +<a name="setValues(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(double[] values)</pre> +<div class="block">Sets the values of this Property to the provided double[] values.</div> +</li> +</ul> +<a name="set(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(double[] values)</pre> +</li> +</ul> +<a name="set(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(int value)</pre> +</li> +</ul> +<a name="set(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(boolean value)</pre> +</li> +</ul> +<a name="set(double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(double value)</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/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Property.html" target="_top">Frames</a></li> +<li><a href="Property.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> diff --git a/javadoc/net/minecraftforge/common/config/package-frame.html b/javadoc/net/minecraftforge/common/config/package-frame.html new file mode 100644 index 0000000..cda5878 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-frame.html @@ -0,0 +1,27 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.config (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../net/minecraftforge/common/config/package-summary.html" target="classFrame">net.minecraftforge.common.config</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ConfigCategory.html" title="class in net.minecraftforge.common.config" target="classFrame">ConfigCategory</a></li> +<li><a href="ConfigElement.html" title="class in net.minecraftforge.common.config" target="classFrame">ConfigElement</a></li> +<li><a href="Configuration.html" title="class in net.minecraftforge.common.config" target="classFrame">Configuration</a></li> +<li><a href="Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config" target="classFrame">Configuration.UnicodeInputStreamReader</a></li> +<li><a href="Property.html" title="class in net.minecraftforge.common.config" target="classFrame">Property</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="Property.Type.html" title="enum in net.minecraftforge.common.config" target="classFrame">Property.Type</a></li> +</ul> +</div> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/config/package-summary.html b/javadoc/net/minecraftforge/common/config/package-summary.html new file mode 100644 index 0000000..4ff72e5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-summary.html @@ -0,0 +1,167 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.config (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="net.minecraftforge.common.config (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 class="navBarCell1Rev">Package</li> +<li>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/chunkio/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/common/network/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package net.minecraftforge.common.config</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config">ConfigCategory</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config">ConfigElement</a><T></td> +<td class="colLast"> +<div class="block">This class bridges the gap between the FML config GUI classes and the Forge Configuration classes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config">Configuration</a></td> +<td class="colLast"> +<div class="block">This class offers advanced configurations capabilities, allowing to provide + various categories for configuration variables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config">Configuration.UnicodeInputStreamReader</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/chunkio/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/common/network/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/config/package-tree.html b/javadoc/net/minecraftforge/common/config/package-tree.html new file mode 100644 index 0000000..894fc23 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-tree.html @@ -0,0 +1,146 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.config Class Hierarchy (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="net.minecraftforge.common.config Class Hierarchy (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</li> +<li class="navBarCell1Rev">Tree</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/chunkio/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/common/network/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package net.minecraftforge.common.config</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">net.minecraftforge.common.config.<a href="../../../../net/minecraftforge/common/config/ConfigCategory.html" title="class in net.minecraftforge.common.config"><span class="strong">ConfigCategory</span></a> (implements java.util.Map<K,V>)</li> +<li type="circle">net.minecraftforge.common.config.<a href="../../../../net/minecraftforge/common/config/ConfigElement.html" title="class in net.minecraftforge.common.config"><span class="strong">ConfigElement</span></a><T> (implements cpw.mods.fml.client.config.<a href="../../../../cpw/mods/fml/client/config/IConfigElement.html" title="interface in cpw.mods.fml.client.config">IConfigElement</a><T>)</li> +<li type="circle">net.minecraftforge.common.config.<a href="../../../../net/minecraftforge/common/config/Configuration.html" title="class in net.minecraftforge.common.config"><span class="strong">Configuration</span></a></li> +<li type="circle">net.minecraftforge.common.config.<a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config"><span class="strong">Property</span></a></li> +<li type="circle">java.io.Reader (implements java.io.Closeable, java.lang.Readable) +<ul> +<li type="circle">net.minecraftforge.common.config.<a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Configuration.UnicodeInputStreamReader</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">net.minecraftforge.common.config.<a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config"><span class="strong">Property.Type</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/chunkio/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/common/network/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html b/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html new file mode 100644 index 0000000..7d79bb3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html @@ -0,0 +1,349 @@ +<!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:16 EST 2015 --> +<title>DimensionMessageHandler (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="DimensionMessageHandler (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>Prev Class</li> +<li><a href="../../../../net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/DimensionMessageHandler.html" target="_top">Frames</a></li> +<li><a href="DimensionMessageHandler.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><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.network</div> +<h2 title="Class DimensionMessageHandler" class="title">Class DimensionMessageHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelInboundHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.SimpleChannelInboundHandler<<a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.DimensionMessageHandler</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DimensionMessageHandler</span> +extends io.netty.channel.SimpleChannelInboundHandler<<a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a>></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler</h3> +<code>io.netty.channel.ChannelHandler.Sharable</code></li> +</ul> +</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/network/DimensionMessageHandler.html#DimensionMessageHandler()">DimensionMessageHandler</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>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/network/DimensionMessageHandler.html#channelRead0(io.netty.channel.ChannelHandlerContext,%20net.minecraftforge.common.network.ForgeMessage.DimensionRegisterMessage)">channelRead0</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a> msg)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/network/DimensionMessageHandler.html#exceptionCaught(io.netty.channel.ChannelHandlerContext,%20java.lang.Throwable)">exceptionCaught</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.SimpleChannelInboundHandler"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.SimpleChannelInboundHandler</h3> +<code>acceptInboundMessage, channelRead</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelInboundHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter</h3> +<code>channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelHandlerAdapter</h3> +<code>handlerAdded, handlerRemoved, isSharable</code></li> +</ul> +<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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Methods inherited from interface io.netty.channel.ChannelHandler</h3> +<code>handlerAdded, handlerRemoved</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="DimensionMessageHandler()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DimensionMessageHandler</h4> +<pre>public DimensionMessageHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="channelRead0(io.netty.channel.ChannelHandlerContext, net.minecraftforge.common.network.ForgeMessage.DimensionRegisterMessage)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>channelRead0</h4> +<pre>protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a> msg) + throws java.lang.Exception</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>channelRead0</code> in class <code>io.netty.channel.SimpleChannelInboundHandler<<a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="exceptionCaught(io.netty.channel.ChannelHandlerContext, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exceptionCaught</h4> +<pre>public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) + throws java.lang.Exception</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>exceptionCaught</code> in interface <code>io.netty.channel.ChannelHandler</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>exceptionCaught</code> in interface <code>io.netty.channel.ChannelInboundHandler</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>exceptionCaught</code> in class <code>io.netty.channel.ChannelInboundHandlerAdapter</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</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="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>Prev Class</li> +<li><a href="../../../../net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/DimensionMessageHandler.html" target="_top">Frames</a></li> +<li><a href="DimensionMessageHandler.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><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> diff --git a/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html b/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html new file mode 100644 index 0000000..8471382 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html @@ -0,0 +1,349 @@ +<!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:16 EST 2015 --> +<title>FluidIdRegistryMessageHandler (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="FluidIdRegistryMessageHandler (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/network/DimensionMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html" target="_top">Frames</a></li> +<li><a href="FluidIdRegistryMessageHandler.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><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.network</div> +<h2 title="Class FluidIdRegistryMessageHandler" class="title">Class FluidIdRegistryMessageHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelInboundHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.SimpleChannelInboundHandler<<a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.FluidIdRegistryMessageHandler</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FluidIdRegistryMessageHandler</span> +extends io.netty.channel.SimpleChannelInboundHandler<<a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a>></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler</h3> +<code>io.netty.channel.ChannelHandler.Sharable</code></li> +</ul> +</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/network/FluidIdRegistryMessageHandler.html#FluidIdRegistryMessageHandler()">FluidIdRegistryMessageHandler</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>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html#channelRead0(io.netty.channel.ChannelHandlerContext,%20net.minecraftforge.common.network.ForgeMessage.FluidIdMapMessage)">channelRead0</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a> msg)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html#exceptionCaught(io.netty.channel.ChannelHandlerContext,%20java.lang.Throwable)">exceptionCaught</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.SimpleChannelInboundHandler"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.SimpleChannelInboundHandler</h3> +<code>acceptInboundMessage, channelRead</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelInboundHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter</h3> +<code>channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelHandlerAdapter</h3> +<code>handlerAdded, handlerRemoved, isSharable</code></li> +</ul> +<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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Methods inherited from interface io.netty.channel.ChannelHandler</h3> +<code>handlerAdded, handlerRemoved</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="FluidIdRegistryMessageHandler()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FluidIdRegistryMessageHandler</h4> +<pre>public FluidIdRegistryMessageHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="channelRead0(io.netty.channel.ChannelHandlerContext, net.minecraftforge.common.network.ForgeMessage.FluidIdMapMessage)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>channelRead0</h4> +<pre>protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a> msg) + throws java.lang.Exception</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>channelRead0</code> in class <code>io.netty.channel.SimpleChannelInboundHandler<<a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="exceptionCaught(io.netty.channel.ChannelHandlerContext, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exceptionCaught</h4> +<pre>public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Throwable cause) + throws java.lang.Exception</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>exceptionCaught</code> in interface <code>io.netty.channel.ChannelHandler</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code>exceptionCaught</code> in interface <code>io.netty.channel.ChannelInboundHandler</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>exceptionCaught</code> in class <code>io.netty.channel.ChannelInboundHandlerAdapter</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</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="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/network/DimensionMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html" target="_top">Frames</a></li> +<li><a href="FluidIdRegistryMessageHandler.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><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> diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html new file mode 100644 index 0000000..2e63a43 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html @@ -0,0 +1,264 @@ +<!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:16 EST 2015 --> +<title>ForgeMessage.DimensionRegisterMessage (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="ForgeMessage.DimensionRegisterMessage (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/network/ForgeMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" target="_top">Frames</a></li> +<li><a href="ForgeMessage.DimensionRegisterMessage.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_classes_inherited_from_class_net.minecraftforge.common.network.ForgeMessage">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.network</div> +<h2 title="Class ForgeMessage.DimensionRegisterMessage" class="title">Class ForgeMessage.DimensionRegisterMessage</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">net.minecraftforge.common.network.ForgeMessage</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.ForgeMessage.DimensionRegisterMessage</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ForgeMessage.DimensionRegisterMessage</span> +extends <a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_net.minecraftforge.common.network.ForgeMessage"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></h3> +<code><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a>, <a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a></code></li> +</ul> +</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/network/ForgeMessage.DimensionRegisterMessage.html#ForgeMessage.DimensionRegisterMessage()">ForgeMessage.DimensionRegisterMessage</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html#ForgeMessage.DimensionRegisterMessage(int,%20int)">ForgeMessage.DimensionRegisterMessage</a></strong>(int dimensionId, + int providerId)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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="ForgeMessage.DimensionRegisterMessage()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ForgeMessage.DimensionRegisterMessage</h4> +<pre>public ForgeMessage.DimensionRegisterMessage()</pre> +</li> +</ul> +<a name="ForgeMessage.DimensionRegisterMessage(int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeMessage.DimensionRegisterMessage</h4> +<pre>public ForgeMessage.DimensionRegisterMessage(int dimensionId, + int providerId)</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/network/ForgeMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" target="_top">Frames</a></li> +<li><a href="ForgeMessage.DimensionRegisterMessage.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_classes_inherited_from_class_net.minecraftforge.common.network.ForgeMessage">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html new file mode 100644 index 0000000..30e89b3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html @@ -0,0 +1,250 @@ +<!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:16 EST 2015 --> +<title>ForgeMessage.FluidIdMapMessage (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="ForgeMessage.FluidIdMapMessage (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/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" target="_top">Frames</a></li> +<li><a href="ForgeMessage.FluidIdMapMessage.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_classes_inherited_from_class_net.minecraftforge.common.network.ForgeMessage">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.network</div> +<h2 title="Class ForgeMessage.FluidIdMapMessage" class="title">Class ForgeMessage.FluidIdMapMessage</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">net.minecraftforge.common.network.ForgeMessage</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.ForgeMessage.FluidIdMapMessage</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ForgeMessage.FluidIdMapMessage</span> +extends <a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_net.minecraftforge.common.network.ForgeMessage"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></h3> +<code><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a>, <a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a></code></li> +</ul> +</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/network/ForgeMessage.FluidIdMapMessage.html#ForgeMessage.FluidIdMapMessage()">ForgeMessage.FluidIdMapMessage</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> +<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="ForgeMessage.FluidIdMapMessage()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeMessage.FluidIdMapMessage</h4> +<pre>public ForgeMessage.FluidIdMapMessage()</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/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" target="_top">Frames</a></li> +<li><a href="ForgeMessage.FluidIdMapMessage.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_classes_inherited_from_class_net.minecraftforge.common.network.ForgeMessage">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.html new file mode 100644 index 0000000..279d7d7 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeMessage.html @@ -0,0 +1,253 @@ +<!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:16 EST 2015 --> +<title>ForgeMessage (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="ForgeMessage (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/network/FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeMessage.html" target="_top">Frames</a></li> +<li><a href="ForgeMessage.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="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.network</div> +<h2 title="Class ForgeMessage" class="title">Class ForgeMessage</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.ForgeMessage</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a>, <a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">ForgeMessage</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/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</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/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</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/network/ForgeMessage.html#ForgeMessage()">ForgeMessage</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> +<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="ForgeMessage()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeMessage</h4> +<pre>public ForgeMessage()</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/network/FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeMessage.html" target="_top">Frames</a></li> +<li><a href="ForgeMessage.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="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html b/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html new file mode 100644 index 0000000..57d9047 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html @@ -0,0 +1,256 @@ +<!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:16 EST 2015 --> +<title>ForgeNetworkHandler (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="ForgeNetworkHandler (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/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeNetworkHandler.html" target="_top">Frames</a></li> +<li><a href="ForgeNetworkHandler.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><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.network</div> +<h2 title="Class ForgeNetworkHandler" class="title">Class ForgeNetworkHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.ForgeNetworkHandler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">ForgeNetworkHandler</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/network/ForgeNetworkHandler.html#ForgeNetworkHandler()">ForgeNetworkHandler</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/network/ForgeNetworkHandler.html#registerChannel(net.minecraftforge.common.ForgeModContainer,%20cpw.mods.fml.relauncher.Side)">registerChannel</a></strong>(<a href="../../../../net/minecraftforge/common/ForgeModContainer.html" title="class in net.minecraftforge.common">ForgeModContainer</a> forgeModContainer, + <a href="../../../../cpw/mods/fml/relauncher/Side.html" title="enum in cpw.mods.fml.relauncher">Side</a> side)</code> </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="ForgeNetworkHandler()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeNetworkHandler</h4> +<pre>public ForgeNetworkHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="registerChannel(net.minecraftforge.common.ForgeModContainer, cpw.mods.fml.relauncher.Side)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>registerChannel</h4> +<pre>public static void registerChannel(<a href="../../../../net/minecraftforge/common/ForgeModContainer.html" title="class in net.minecraftforge.common">ForgeModContainer</a> forgeModContainer, + <a href="../../../../cpw/mods/fml/relauncher/Side.html" title="enum in cpw.mods.fml.relauncher">Side</a> side)</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/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeNetworkHandler.html" target="_top">Frames</a></li> +<li><a href="ForgeNetworkHandler.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><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> diff --git a/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html b/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html new file mode 100644 index 0000000..2561969 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html @@ -0,0 +1,386 @@ +<!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:16 EST 2015 --> +<title>ForgeRuntimeCodec (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="ForgeRuntimeCodec (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/network/ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeRuntimeCodec.html" target="_top">Frames</a></li> +<li><a href="ForgeRuntimeCodec.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="#fields_inherited_from_class_cpw.mods.fml.common.network.FMLIndexedMessageToMessageCodec">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>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.network</div> +<h2 title="Class ForgeRuntimeCodec" class="title">Class ForgeRuntimeCodec</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelInboundHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelDuplexHandler</li> +<li> +<ul class="inheritance"> +<li>io.netty.handler.codec.MessageToMessageCodec<<a href="../../../../cpw/mods/fml/common/network/internal/FMLProxyPacket.html" title="class in cpw.mods.fml.common.network.internal">FMLProxyPacket</a>,A></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network">cpw.mods.fml.common.network.FMLIndexedMessageToMessageCodec</a><<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.ForgeRuntimeCodec</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ForgeRuntimeCodec</span> +extends <a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network">FMLIndexedMessageToMessageCodec</a><<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a>></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler</h3> +<code>io.netty.channel.ChannelHandler.Sharable</code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_cpw.mods.fml.common.network.FMLIndexedMessageToMessageCodec"> +<!-- --> +</a> +<h3>Fields inherited from class cpw.mods.fml.common.network.<a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network">FMLIndexedMessageToMessageCodec</a></h3> +<code><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#INBOUNDPACKETTRACKER">INBOUNDPACKETTRACKER</a></code></li> +</ul> +</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/network/ForgeRuntimeCodec.html#ForgeRuntimeCodec()">ForgeRuntimeCodec</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/network/ForgeRuntimeCodec.html#decodeInto(io.netty.channel.ChannelHandlerContext,%20io.netty.buffer.ByteBuf,%20net.minecraftforge.common.network.ForgeMessage)">decodeInto</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a> msg)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/network/ForgeRuntimeCodec.html#encodeInto(io.netty.channel.ChannelHandlerContext,%20net.minecraftforge.common.network.ForgeMessage,%20io.netty.buffer.ByteBuf)">encodeInto</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a> msg, + io.netty.buffer.ByteBuf target)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_cpw.mods.fml.common.network.FMLIndexedMessageToMessageCodec"> +<!-- --> +</a> +<h3>Methods inherited from class cpw.mods.fml.common.network.<a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network">FMLIndexedMessageToMessageCodec</a></h3> +<code><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#addDiscriminator(int,%20java.lang.Class)">addDiscriminator</a>, <a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#decode(io.netty.channel.ChannelHandlerContext,%20cpw.mods.fml.common.network.internal.FMLProxyPacket,%20java.util.List)">decode</a>, <a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#encode(io.netty.channel.ChannelHandlerContext,%20A,%20java.util.List)">encode</a>, <a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#exceptionCaught(io.netty.channel.ChannelHandlerContext,%20java.lang.Throwable)">exceptionCaught</a>, <a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#handlerAdded(io.netty.channel.ChannelHandlerContext)">handlerAdded</a>, <a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#testMessageValidity(cpw.mods.fml.common.network.internal.FMLProxyPacket)">testMessageValidity</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.handler.codec.MessageToMessageCodec"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.handler.codec.MessageToMessageCodec</h3> +<code>acceptInboundMessage, acceptOutboundMessage, channelRead, write</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelDuplexHandler"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelDuplexHandler</h3> +<code>bind, close, connect, deregister, disconnect, flush, read</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelInboundHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter</h3> +<code>channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelHandlerAdapter</h3> +<code>handlerRemoved, isSharable</code></li> +</ul> +<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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Methods inherited from interface io.netty.channel.ChannelHandler</h3> +<code>handlerRemoved</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="ForgeRuntimeCodec()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForgeRuntimeCodec</h4> +<pre>public ForgeRuntimeCodec()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="encodeInto(io.netty.channel.ChannelHandlerContext, net.minecraftforge.common.network.ForgeMessage, io.netty.buffer.ByteBuf)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>encodeInto</h4> +<pre>public void encodeInto(io.netty.channel.ChannelHandlerContext ctx, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a> msg, + io.netty.buffer.ByteBuf target) + throws java.lang.Exception</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#encodeInto(io.netty.channel.ChannelHandlerContext,%20A,%20io.netty.buffer.ByteBuf)">encodeInto</a></code> in class <code><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network">FMLIndexedMessageToMessageCodec</a><<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="decodeInto(io.netty.channel.ChannelHandlerContext, io.netty.buffer.ByteBuf, net.minecraftforge.common.network.ForgeMessage)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>decodeInto</h4> +<pre>public void decodeInto(io.netty.channel.ChannelHandlerContext ctx, + io.netty.buffer.ByteBuf source, + <a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a> msg)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html#decodeInto(io.netty.channel.ChannelHandlerContext,%20io.netty.buffer.ByteBuf,%20A)">decodeInto</a></code> in class <code><a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network">FMLIndexedMessageToMessageCodec</a><<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a>></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="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/network/ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ForgeRuntimeCodec.html" target="_top">Frames</a></li> +<li><a href="ForgeRuntimeCodec.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="#fields_inherited_from_class_cpw.mods.fml.common.network.FMLIndexedMessageToMessageCodec">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>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> diff --git a/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html b/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html new file mode 100644 index 0000000..1e680ad --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html @@ -0,0 +1,314 @@ +<!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:16 EST 2015 --> +<title>ServerToClientConnectionEstablishedHandler (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="ServerToClientConnectionEstablishedHandler (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/network/ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html" target="_top">Frames</a></li> +<li><a href="ServerToClientConnectionEstablishedHandler.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><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.network</div> +<h2 title="Class ServerToClientConnectionEstablishedHandler" class="title">Class ServerToClientConnectionEstablishedHandler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>io.netty.channel.ChannelInboundHandlerAdapter</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.network.ServerToClientConnectionEstablishedHandler</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ServerToClientConnectionEstablishedHandler</span> +extends io.netty.channel.ChannelInboundHandlerAdapter</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler</h3> +<code>io.netty.channel.ChannelHandler.Sharable</code></li> +</ul> +</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/network/ServerToClientConnectionEstablishedHandler.html#ServerToClientConnectionEstablishedHandler()">ServerToClientConnectionEstablishedHandler</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/network/ServerToClientConnectionEstablishedHandler.html#userEventTriggered(io.netty.channel.ChannelHandlerContext,%20java.lang.Object)">userEventTriggered</a></strong>(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelInboundHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter</h3> +<code>channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandlerAdapter"> +<!-- --> +</a> +<h3>Methods inherited from class io.netty.channel.ChannelHandlerAdapter</h3> +<code>handlerAdded, handlerRemoved, isSharable</code></li> +</ul> +<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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_io.netty.channel.ChannelHandler"> +<!-- --> +</a> +<h3>Methods inherited from interface io.netty.channel.ChannelHandler</h3> +<code>handlerAdded, handlerRemoved</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="ServerToClientConnectionEstablishedHandler()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ServerToClientConnectionEstablishedHandler</h4> +<pre>public ServerToClientConnectionEstablishedHandler()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="userEventTriggered(io.netty.channel.ChannelHandlerContext, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>userEventTriggered</h4> +<pre>public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, + java.lang.Object evt) + throws java.lang.Exception</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>userEventTriggered</code> in interface <code>io.netty.channel.ChannelInboundHandler</code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>userEventTriggered</code> in class <code>io.netty.channel.ChannelInboundHandlerAdapter</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</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="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/network/ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html" target="_top">Frames</a></li> +<li><a href="ServerToClientConnectionEstablishedHandler.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><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> diff --git a/javadoc/net/minecraftforge/common/network/package-frame.html b/javadoc/net/minecraftforge/common/network/package-frame.html new file mode 100644 index 0000000..da935c4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/package-frame.html @@ -0,0 +1,26 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.network (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../net/minecraftforge/common/network/package-summary.html" target="classFrame">net.minecraftforge.common.network</a></h1> +<div class="indexContainer"> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="DimensionMessageHandler.html" title="class in net.minecraftforge.common.network" target="classFrame">DimensionMessageHandler</a></li> +<li><a href="FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network" target="classFrame">FluidIdRegistryMessageHandler</a></li> +<li><a href="ForgeMessage.html" title="class in net.minecraftforge.common.network" target="classFrame">ForgeMessage</a></li> +<li><a href="ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network" target="classFrame">ForgeMessage.DimensionRegisterMessage</a></li> +<li><a href="ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network" target="classFrame">ForgeMessage.FluidIdMapMessage</a></li> +<li><a href="ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network" target="classFrame">ForgeNetworkHandler</a></li> +<li><a href="ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network" target="classFrame">ForgeRuntimeCodec</a></li> +<li><a href="ServerToClientConnectionEstablishedHandler.html" title="class in net.minecraftforge.common.network" target="classFrame">ServerToClientConnectionEstablishedHandler</a></li> +</ul> +</div> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/network/package-summary.html b/javadoc/net/minecraftforge/common/network/package-summary.html new file mode 100644 index 0000000..9e251ff --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/package-summary.html @@ -0,0 +1,159 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.network (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="net.minecraftforge.common.network (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 class="navBarCell1Rev">Package</li> +<li>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/config/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/common/util/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package net.minecraftforge.common.network</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/DimensionMessageHandler.html" title="class in net.minecraftforge.common.network">DimensionMessageHandler</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network">FluidIdRegistryMessageHandler</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.DimensionRegisterMessage</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network">ForgeMessage.FluidIdMapMessage</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network">ForgeNetworkHandler</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network">ForgeRuntimeCodec</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html" title="class in net.minecraftforge.common.network">ServerToClientConnectionEstablishedHandler</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/config/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/common/util/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/network/package-tree.html b/javadoc/net/minecraftforge/common/network/package-tree.html new file mode 100644 index 0000000..efe776d --- /dev/null +++ b/javadoc/net/minecraftforge/common/network/package-tree.html @@ -0,0 +1,160 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.network Class Hierarchy (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="net.minecraftforge.common.network Class Hierarchy (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</li> +<li class="navBarCell1Rev">Tree</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/config/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/common/util/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package net.minecraftforge.common.network</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">io.netty.channel.ChannelHandlerAdapter (implements io.netty.channel.ChannelHandler) +<ul> +<li type="circle">io.netty.channel.ChannelInboundHandlerAdapter (implements io.netty.channel.ChannelInboundHandler) +<ul> +<li type="circle">io.netty.channel.ChannelDuplexHandler (implements io.netty.channel.ChannelOutboundHandler) +<ul> +<li type="circle">io.netty.handler.codec.MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN> +<ul> +<li type="circle">cpw.mods.fml.common.network.<a href="../../../../cpw/mods/fml/common/network/FMLIndexedMessageToMessageCodec.html" title="class in cpw.mods.fml.common.network"><span class="strong">FMLIndexedMessageToMessageCodec</span></a><A> +<ul> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeRuntimeCodec.html" title="class in net.minecraftforge.common.network"><span class="strong">ForgeRuntimeCodec</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">ServerToClientConnectionEstablishedHandler</span></a></li> +<li type="circle">io.netty.channel.SimpleChannelInboundHandler<I> +<ul> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/DimensionMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">DimensionMessageHandler</span></a></li> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">FluidIdRegistryMessageHandler</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">ForgeMessage</span></a> +<ul> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">ForgeMessage.DimensionRegisterMessage</span></a></li> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html" title="class in net.minecraftforge.common.network"><span class="strong">ForgeMessage.FluidIdMapMessage</span></a></li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.network.<a href="../../../../net/minecraftforge/common/network/ForgeNetworkHandler.html" title="class in net.minecraftforge.common.network"><span class="strong">ForgeNetworkHandler</span></a></li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/config/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/common/util/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/network/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/package-frame.html b/javadoc/net/minecraftforge/common/package-frame.html new file mode 100644 index 0000000..fabd683 --- /dev/null +++ b/javadoc/net/minecraftforge/common/package-frame.html @@ -0,0 +1,59 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../net/minecraftforge/common/package-summary.html" target="classFrame">net.minecraftforge.common</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common" target="classFrame"><i>ForgeChunkManager.LoadingCallback</i></a></li> +<li><a href="ForgeChunkManager.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common" target="classFrame"><i>ForgeChunkManager.OrderedLoadingCallback</i></a></li> +<li><a href="ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common" target="classFrame"><i>ForgeChunkManager.PlayerOrderedLoadingCallback</i></a></li> +<li><a href="IExtendedEntityProperties.html" title="interface in net.minecraftforge.common" target="classFrame"><i>IExtendedEntityProperties</i></a></li> +<li><a href="IMinecartCollisionHandler.html" title="interface in net.minecraftforge.common" target="classFrame"><i>IMinecartCollisionHandler</i></a></li> +<li><a href="IPlantable.html" title="interface in net.minecraftforge.common" target="classFrame"><i>IPlantable</i></a></li> +<li><a href="IShearable.html" title="interface in net.minecraftforge.common" target="classFrame"><i>IShearable</i></a></li> +<li><a href="ISpecialArmor.html" title="interface in net.minecraftforge.common" target="classFrame"><i>ISpecialArmor</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AchievementPage.html" title="class in net.minecraftforge.common" target="classFrame">AchievementPage</a></li> +<li><a href="BiomeDictionary.html" title="class in net.minecraftforge.common" target="classFrame">BiomeDictionary</a></li> +<li><a href="BiomeManager.html" title="class in net.minecraftforge.common" target="classFrame">BiomeManager</a></li> +<li><a href="BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common" target="classFrame">BiomeManager.BiomeEntry</a></li> +<li><a href="ChestGenHooks.html" title="class in net.minecraftforge.common" target="classFrame">ChestGenHooks</a></li> +<li><a href="DimensionManager.html" title="class in net.minecraftforge.common" target="classFrame">DimensionManager</a></li> +<li><a href="DungeonHooks.html" title="class in net.minecraftforge.common" target="classFrame">DungeonHooks</a></li> +<li><a href="DungeonHooks.DungeonMob.html" title="class in net.minecraftforge.common" target="classFrame">DungeonHooks.DungeonMob</a></li> +<li><a href="FishingHooks.html" title="class in net.minecraftforge.common" target="classFrame">FishingHooks</a></li> +<li><a href="ForgeChunkManager.html" title="class in net.minecraftforge.common" target="classFrame">ForgeChunkManager</a></li> +<li><a href="ForgeChunkManager.ForceChunkEvent.html" title="class in net.minecraftforge.common" target="classFrame">ForgeChunkManager.ForceChunkEvent</a></li> +<li><a href="ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common" target="classFrame">ForgeChunkManager.Ticket</a></li> +<li><a href="ForgeChunkManager.UnforceChunkEvent.html" title="class in net.minecraftforge.common" target="classFrame">ForgeChunkManager.UnforceChunkEvent</a></li> +<li><a href="ForgeHooks.html" title="class in net.minecraftforge.common" target="classFrame">ForgeHooks</a></li> +<li><a href="ForgeInternalHandler.html" title="class in net.minecraftforge.common" target="classFrame">ForgeInternalHandler</a></li> +<li><a href="ForgeModContainer.html" title="class in net.minecraftforge.common" target="classFrame">ForgeModContainer</a></li> +<li><a href="ForgeVersion.html" title="class in net.minecraftforge.common" target="classFrame">ForgeVersion</a></li> +<li><a href="ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common" target="classFrame">ISpecialArmor.ArmorProperties</a></li> +<li><a href="MinecraftForge.html" title="class in net.minecraftforge.common" target="classFrame">MinecraftForge</a></li> +<li><a href="UsernameCache.html" title="class in net.minecraftforge.common" target="classFrame">UsernameCache</a></li> +<li><a href="WorldSpecificSaveHandler.html" title="class in net.minecraftforge.common" target="classFrame">WorldSpecificSaveHandler</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="BiomeDictionary.Type.html" title="enum in net.minecraftforge.common" target="classFrame">BiomeDictionary.Type</a></li> +<li><a href="BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common" target="classFrame">BiomeManager.BiomeType</a></li> +<li><a href="EnumPlantType.html" title="enum in net.minecraftforge.common" target="classFrame">EnumPlantType</a></li> +<li><a href="FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common" target="classFrame">FishingHooks.FishableCategory</a></li> +<li><a href="ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common" target="classFrame">ForgeChunkManager.Type</a></li> +<li><a href="ForgeVersion.Status.html" title="enum in net.minecraftforge.common" target="classFrame">ForgeVersion.Status</a></li> +</ul> +</div> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/package-summary.html b/javadoc/net/minecraftforge/common/package-summary.html new file mode 100644 index 0000000..bf0f415 --- /dev/null +++ b/javadoc/net/minecraftforge/common/package-summary.html @@ -0,0 +1,308 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common (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="net.minecraftforge.common (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 class="navBarCell1Rev">Package</li> +<li>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/client/model/techne/package-summary.html">Prev Package</a></li> +<li><a href="../../../net/minecraftforge/common/chunkio/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package net.minecraftforge.common</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.LoadingCallback</a></td> +<td class="colLast"> +<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="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.OrderedLoadingCallback</a></td> +<td class="colLast"> +<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="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common">ForgeChunkManager.PlayerOrderedLoadingCallback</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/IExtendedEntityProperties.html" title="interface in net.minecraftforge.common">IExtendedEntityProperties</a></td> +<td class="colLast"> +<div class="block">Allows for custom entity data and logic to be hooked to existing entity classes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.html" title="interface in net.minecraftforge.common">IMinecartCollisionHandler</a></td> +<td class="colLast"> +<div class="block">This class defines a replacement for the default minecart collision code.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/IPlantable.html" title="interface in net.minecraftforge.common">IPlantable</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/IShearable.html" title="interface in net.minecraftforge.common">IShearable</a></td> +<td class="colLast"> +<div class="block">This allows for mods to create there own Shear-like items + and have them interact with Blocks/Entities without extra work.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ISpecialArmor.html" title="interface in net.minecraftforge.common">ISpecialArmor</a></td> +<td class="colLast"> +<div class="block">This interface is to be implemented by ItemArmor classes.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common">AchievementPage</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/BiomeDictionary.html" title="class in net.minecraftforge.common">BiomeDictionary</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/BiomeManager.html" title="class in net.minecraftforge.common">BiomeManager</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common">BiomeManager.BiomeEntry</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ChestGenHooks.html" title="class in net.minecraftforge.common">ChestGenHooks</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/DimensionManager.html" title="class in net.minecraftforge.common">DimensionManager</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/DungeonHooks.html" title="class in net.minecraftforge.common">DungeonHooks</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/DungeonHooks.DungeonMob.html" title="class in net.minecraftforge.common">DungeonHooks.DungeonMob</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/FishingHooks.html" title="class in net.minecraftforge.common">FishingHooks</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.html" title="class in net.minecraftforge.common">ForgeChunkManager</a></td> +<td class="colLast"> +<div class="block">Manages chunkloading for mods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html" title="class in net.minecraftforge.common">ForgeChunkManager.ForceChunkEvent</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common">ForgeChunkManager.Ticket</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html" title="class in net.minecraftforge.common">ForgeChunkManager.UnforceChunkEvent</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeHooks.html" title="class in net.minecraftforge.common">ForgeHooks</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeInternalHandler.html" title="class in net.minecraftforge.common">ForgeInternalHandler</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeModContainer.html" title="class in net.minecraftforge.common">ForgeModContainer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeVersion.html" title="class in net.minecraftforge.common">ForgeVersion</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common">ISpecialArmor.ArmorProperties</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/MinecraftForge.html" title="class in net.minecraftforge.common">MinecraftForge</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/UsernameCache.html" title="class in net.minecraftforge.common">UsernameCache</a></td> +<td class="colLast"> +<div class="block">Caches player's last known usernames</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html" title="class in net.minecraftforge.common">WorldSpecificSaveHandler</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common">BiomeDictionary.Type</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common">BiomeManager.BiomeType</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common">EnumPlantType</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common">FishingHooks.FishableCategory</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common">ForgeChunkManager.Type</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common">ForgeVersion.Status</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/client/model/techne/package-summary.html">Prev Package</a></li> +<li><a href="../../../net/minecraftforge/common/chunkio/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/package-tree.html b/javadoc/net/minecraftforge/common/package-tree.html new file mode 100644 index 0000000..830d987 --- /dev/null +++ b/javadoc/net/minecraftforge/common/package-tree.html @@ -0,0 +1,189 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common Class Hierarchy (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="net.minecraftforge.common Class Hierarchy (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</li> +<li class="navBarCell1Rev">Tree</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/client/model/techne/package-tree.html">Prev</a></li> +<li><a href="../../../net/minecraftforge/common/chunkio/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package net.minecraftforge.common</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/AchievementPage.html" title="class in net.minecraftforge.common"><span class="strong">AchievementPage</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/BiomeDictionary.html" title="class in net.minecraftforge.common"><span class="strong">BiomeDictionary</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/BiomeManager.html" title="class in net.minecraftforge.common"><span class="strong">BiomeManager</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ChestGenHooks.html" title="class in net.minecraftforge.common"><span class="strong">ChestGenHooks</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/DimensionManager.html" title="class in net.minecraftforge.common"><span class="strong">DimensionManager</span></a></li> +<li type="circle">cpw.mods.fml.common.<a href="../../../cpw/mods/fml/common/DummyModContainer.html" title="class in cpw.mods.fml.common"><span class="strong">DummyModContainer</span></a> (implements cpw.mods.fml.common.<a href="../../../cpw/mods/fml/common/ModContainer.html" title="interface in cpw.mods.fml.common">ModContainer</a>) +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeModContainer.html" title="class in net.minecraftforge.common"><span class="strong">ForgeModContainer</span></a> (implements cpw.mods.fml.common.<a href="../../../cpw/mods/fml/common/WorldAccessContainer.html" title="interface in cpw.mods.fml.common">WorldAccessContainer</a>)</li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/DungeonHooks.html" title="class in net.minecraftforge.common"><span class="strong">DungeonHooks</span></a></li> +<li type="circle">cpw.mods.fml.common.eventhandler.<a href="../../../cpw/mods/fml/common/eventhandler/Event.html" title="class in cpw.mods.fml.common.eventhandler"><span class="strong">Event</span></a> +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html" title="class in net.minecraftforge.common"><span class="strong">ForgeChunkManager.ForceChunkEvent</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html" title="class in net.minecraftforge.common"><span class="strong">ForgeChunkManager.UnforceChunkEvent</span></a></li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/FishingHooks.html" title="class in net.minecraftforge.common"><span class="strong">FishingHooks</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.html" title="class in net.minecraftforge.common"><span class="strong">ForgeChunkManager</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.Ticket.html" title="class in net.minecraftforge.common"><span class="strong">ForgeChunkManager.Ticket</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeHooks.html" title="class in net.minecraftforge.common"><span class="strong">ForgeHooks</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeInternalHandler.html" title="class in net.minecraftforge.common"><span class="strong">ForgeInternalHandler</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeVersion.html" title="class in net.minecraftforge.common"><span class="strong">ForgeVersion</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ISpecialArmor.ArmorProperties.html" title="class in net.minecraftforge.common"><span class="strong">ISpecialArmor.ArmorProperties</span></a> (implements java.lang.Comparable<T>)</li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/MinecraftForge.html" title="class in net.minecraftforge.common"><span class="strong">MinecraftForge</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/UsernameCache.html" title="class in net.minecraftforge.common"><span class="strong">UsernameCache</span></a></li> +<li type="circle">net.minecraft.util.<a href="../../../net/minecraft/util/WeightedRandom.Item.html" title="class in net.minecraft.util"><span class="strong">WeightedRandom.Item</span></a> +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/BiomeManager.BiomeEntry.html" title="class in net.minecraftforge.common"><span class="strong">BiomeManager.BiomeEntry</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/DungeonHooks.DungeonMob.html" title="class in net.minecraftforge.common"><span class="strong">DungeonHooks.DungeonMob</span></a></li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/WorldSpecificSaveHandler.html" title="class in net.minecraftforge.common"><span class="strong">WorldSpecificSaveHandler</span></a> (implements net.minecraft.world.storage.<a href="../../../net/minecraft/world/storage/ISaveHandler.html" title="interface in net.minecraft.world.storage">ISaveHandler</a>)</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">ForgeChunkManager.LoadingCallback</span></a> +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">ForgeChunkManager.OrderedLoadingCallback</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html" title="interface in net.minecraftforge.common"><span class="strong">ForgeChunkManager.PlayerOrderedLoadingCallback</span></a></li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/IExtendedEntityProperties.html" title="interface in net.minecraftforge.common"><span class="strong">IExtendedEntityProperties</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/IMinecartCollisionHandler.html" title="interface in net.minecraftforge.common"><span class="strong">IMinecartCollisionHandler</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/IPlantable.html" title="interface in net.minecraftforge.common"><span class="strong">IPlantable</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/IShearable.html" title="interface in net.minecraftforge.common"><span class="strong">IShearable</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ISpecialArmor.html" title="interface in net.minecraftforge.common"><span class="strong">ISpecialArmor</span></a></li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/EnumPlantType.html" title="enum in net.minecraftforge.common"><span class="strong">EnumPlantType</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeChunkManager.Type.html" title="enum in net.minecraftforge.common"><span class="strong">ForgeChunkManager.Type</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/ForgeVersion.Status.html" title="enum in net.minecraftforge.common"><span class="strong">ForgeVersion.Status</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/BiomeManager.BiomeType.html" title="enum in net.minecraftforge.common"><span class="strong">BiomeManager.BiomeType</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/FishingHooks.FishableCategory.html" title="enum in net.minecraftforge.common"><span class="strong">FishingHooks.FishableCategory</span></a></li> +<li type="circle">net.minecraftforge.common.<a href="../../../net/minecraftforge/common/BiomeDictionary.Type.html" title="enum in net.minecraftforge.common"><span class="strong">BiomeDictionary.Type</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/client/model/techne/package-tree.html">Prev</a></li> +<li><a href="../../../net/minecraftforge/common/chunkio/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?net/minecraftforge/common/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html new file mode 100644 index 0000000..d3e4c49 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html @@ -0,0 +1,280 @@ +<!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:20 EST 2015 --> +<title>AsynchronousExecutor.CallBackProvider (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="AsynchronousExecutor.CallBackProvider (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/util/AsynchronousExecutor.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" target="_top">Frames</a></li> +<li><a href="AsynchronousExecutor.CallBackProvider.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.util</div> +<h2 title="Interface AsynchronousExecutor.CallBackProvider" class="title">Interface AsynchronousExecutor.CallBackProvider<P,T,C,E extends java.lang.Throwable></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.util.concurrent.ThreadFactory</dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="class in net.minecraftforge.common.util">AsynchronousExecutor</a><<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="strong">AsynchronousExecutor.CallBackProvider<P,T,C,E extends java.lang.Throwable></span> +extends java.util.concurrent.ThreadFactory</pre> +</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><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html#callStage1(P)">callStage1</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a> parameter)</code> +<div class="block">Normally an asynchronous call, but can be synchronous</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html#callStage2(P,%20T)">callStage2</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a> object)</code> +<div class="block">Synchronous call</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html#callStage3(P,%20T,%20C)">callStage3</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a> object, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">C</a> callback)</code> +<div class="block">Synchronous call, called multiple times, once per registered callback</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.concurrent.ThreadFactory"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.concurrent.ThreadFactory</h3> +<code>newThread</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="callStage1(java.lang.Object)"> +<!-- --> +</a><a name="callStage1(P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callStage1</h4> +<pre><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a> callStage1(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a> parameter) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable</pre> +<div class="block">Normally an asynchronous call, but can be synchronous</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - parameter object provided</dd> +<dt><span class="strong">Returns:</span></dt><dd>the created object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="callStage2(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="callStage2(P, T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callStage2</h4> +<pre>void callStage2(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a> object) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable</pre> +<div class="block">Synchronous call</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - parameter object provided</dd><dd><code>object</code> - the previously created object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="callStage3(java.lang.Object,java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="callStage3(P, T, C)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>callStage3</h4> +<pre>void callStage3(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a> object, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">C</a> callback) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable</pre> +<div class="block">Synchronous call, called multiple times, once per registered callback</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parameter</code> - parameter object provided</dd><dd><code>object</code> - the previously created object</dd><dd><code>callback</code> - the current callback to execute</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable</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="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/util/AsynchronousExecutor.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" target="_top">Frames</a></li> +<li><a href="AsynchronousExecutor.CallBackProvider.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> diff --git a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html new file mode 100644 index 0000000..98f08a3 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html @@ -0,0 +1,474 @@ +<!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:20 EST 2015 --> +<title>AsynchronousExecutor (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="AsynchronousExecutor (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>Prev Class</li> +<li><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/AsynchronousExecutor.html" target="_top">Frames</a></li> +<li><a href="AsynchronousExecutor.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.util</div> +<h2 title="Class AsynchronousExecutor" class="title">Class AsynchronousExecutor<P,T,C,E extends java.lang.Throwable></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.AsynchronousExecutor<P,T,C,E></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>P</code> - The type of parameter you provide to make the object that will be created. It should implement <code>Object.hashCode()</code> and <code>Object.equals(Object)</code> if you want to get the value early.</dd><dd><code>T</code> - The type of object you provide. This is created in stage 1, and passed to stage 2, 3, and returned if get() is called.</dd><dd><code>C</code> - The type of callback you provide. You may register many of these to be passed to the provider in stage 3, one at a time.</dd><dd><code>E</code> - A type of exception you may throw and expect to be handled by the main thread</dd></dl> +<hr> +<br> +<pre>public final class <span class="strong">AsynchronousExecutor<P,T,C,E extends java.lang.Throwable></span> +extends java.lang.Object</pre> +<div class="block">Executes tasks using a multi-stage process executor. Synchronous executions are via <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#finishActive()"><code>finishActive()</code></a> or the <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#get(P)"><code>get(Object)</code></a> methods. + <li \> Stage 1 creates the object from a parameter, and is usually called asynchronously. + <li \> Stage 2 takes the parameter and object from stage 1 and does any synchronous processing to prepare it. + <li \> Stage 3 takes the parameter and object from stage 1, as well as a callback that was registered, and performs any synchronous calculations.</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 interface </code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util">AsynchronousExecutor.CallBackProvider</a><<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">P</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">T</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">C</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="type parameter in AsynchronousExecutor.CallBackProvider">E</a> extends java.lang.Throwable></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/util/AsynchronousExecutor.html#AsynchronousExecutor(net.minecraftforge.common.util.AsynchronousExecutor.CallBackProvider,%20int)">AsynchronousExecutor</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util">AsynchronousExecutor.CallBackProvider</a><<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a>> provider, + int coreSize)</code> +<div class="block">Uses a thread pool to pass executions to the provider.</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"> </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/util/AsynchronousExecutor.html#add(P,%20C)">add</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a> callback)</code> +<div class="block">Adds a callback to the parameter provided, adding parameter to the queue if needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#drop(P,%20C)">drop</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a> callback)</code> +<div class="block">This removes a particular callback from the specified parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#finishActive()">finishActive</a></strong>()</code> +<div class="block">This is the 'heartbeat' that should be called synchronously to finish any pending tasks</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#get(P)">get</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter)</code> +<div class="block">This method attempts to skip the waiting period for said parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#getSkipQueue(P)">getSkipQueue</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter)</code> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#getSkipQueue(P,%20C...)">getSkipQueue</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>... callbacks)</code> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#getSkipQueue(P,%20C)">getSkipQueue</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a> callback)</code> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#getSkipQueue(P,%20java.lang.Iterable)">getSkipQueue</a></strong>(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + java.lang.Iterable<<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>> callbacks)</code> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#setActiveThreads(int)">setActiveThreads</a></strong>(int coreSize)</code> </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="AsynchronousExecutor(net.minecraftforge.common.util.AsynchronousExecutor.CallBackProvider, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AsynchronousExecutor</h4> +<pre>public AsynchronousExecutor(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util">AsynchronousExecutor.CallBackProvider</a><<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>,<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a>> provider, + int coreSize)</pre> +<div class="block">Uses a thread pool to pass executions to the provider.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="class in net.minecraftforge.common.util"><code>AsynchronousExecutor</code></a></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="add(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="add(P, C)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>add</h4> +<pre>public void add(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a> callback)</pre> +<div class="block">Adds a callback to the parameter provided, adding parameter to the queue if needed. + <p> + This should always be synchronous.</div> +</li> +</ul> +<a name="drop(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="drop(P, C)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>drop</h4> +<pre>public boolean drop(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a> callback) + throws java.lang.IllegalStateException</pre> +<div class="block">This removes a particular callback from the specified parameter. + <p> + If no callbacks remain for a given parameter, then the <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util"><code>CallBackProvider's</code></a> stages may be omitted from execution. + Stage 3 will have no callbacks, stage 2 will be skipped unless a <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#get(P)"><code>get(Object)</code></a> is used, and stage 1 will be avoided on a best-effort basis. + <p> + Subsequent calls to <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#getSkipQueue(P)"><code>getSkipQueue(Object)</code></a> will always work. + <p> + Subsequent calls to <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#get(P)"><code>get(Object)</code></a> might work. + <p> + This should always be synchronous</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if no further execution for the parameter is possible, such that, no exceptions will be thrown in <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#finishActive()"><code>finishActive()</code></a> for the parameter, and <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html#get(P)"><code>get(Object)</code></a> will throw an <code>IllegalStateException</code>, false otherwise</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if parameter is not in the queue anymore</dd> +<dd><code>java.lang.IllegalStateException</code> - if the callback was not specified for given parameter</dd></dl> +</li> +</ul> +<a name="get(java.lang.Object)"> +<!-- --> +</a><a name="get(P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a> get(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable, + java.lang.IllegalStateException</pre> +<div class="block">This method attempts to skip the waiting period for said parameter. + <p> + This should always be synchronous.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if the parameter is not in the queue anymore, or sometimes if called from asynchronous thread</dd> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="getSkipQueue(java.lang.Object)"> +<!-- --> +</a><a name="getSkipQueue(P)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkipQueue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a> getSkipQueue(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</pre> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="getSkipQueue(java.lang.Object,java.lang.Object)"> +<!-- --> +</a><a name="getSkipQueue(P, C)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkipQueue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a> getSkipQueue(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a> callback) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</pre> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="getSkipQueue(java.lang.Object,java.lang.Object[])"> +<!-- --> +</a><a name="getSkipQueue(P, C...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkipQueue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a> getSkipQueue(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>... callbacks) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</pre> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="getSkipQueue(java.lang.Object,java.lang.Iterable)"> +<!-- --> +</a><a name="getSkipQueue(P, java.lang.Iterable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSkipQueue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">T</a> getSkipQueue(<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">P</a> parameter, + java.lang.Iterable<<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">C</a>> callbacks) + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</pre> +<div class="block">Processes a parameter as if it was in the queue, without ever passing to another thread.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="finishActive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finishActive</h4> +<pre>public void finishActive() + throws <a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</pre> +<div class="block">This is the 'heartbeat' that should be called synchronously to finish any pending tasks</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="type parameter in AsynchronousExecutor">E</a> extends java.lang.Throwable</code></dd></dl> +</li> +</ul> +<a name="setActiveThreads(int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setActiveThreads</h4> +<pre>public void setActiveThreads(int coreSize)</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>Prev Class</li> +<li><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/AsynchronousExecutor.html" target="_top">Frames</a></li> +<li><a href="AsynchronousExecutor.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> diff --git a/javadoc/net/minecraftforge/common/util/BlockSnapshot.html b/javadoc/net/minecraftforge/common/util/BlockSnapshot.html new file mode 100644 index 0000000..df83bce --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/BlockSnapshot.html @@ -0,0 +1,697 @@ +<!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:20 EST 2015 --> +<title>BlockSnapshot (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="BlockSnapshot (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/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/ChunkCoordComparator.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/BlockSnapshot.html" target="_top">Frames</a></li> +<li><a href="BlockSnapshot.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><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.util</div> +<h2 title="Class BlockSnapshot" class="title">Class BlockSnapshot</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.BlockSnapshot</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">BlockSnapshot</span> +extends java.lang.Object +implements java.io.Serializable</pre> +<div class="block">Represents a captured snapshot of a block which will not change + automatically. + <p> + Unlike Block, which only one object can exist per coordinate, BlockSnapshot + can exist multiple times for any given Block.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#net.minecraftforge.common.util.BlockSnapshot">Serialized Form</a></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"> </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="../../../../cpw/mods/fml/common/registry/GameRegistry.UniqueIdentifier.html" title="class in cpw.mods.fml.common.registry">GameRegistry.UniqueIdentifier</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#blockIdentifier">blockIdentifier</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#dimId">dimId</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#flag">flag</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#meta">meta</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#replacedBlock">replacedBlock</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<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/util/BlockSnapshot.html#world">world</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#x">x</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#y">y</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#z">z</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/util/BlockSnapshot.html#BlockSnapshot(int,%20int,%20int,%20int,%20java.lang.String,%20java.lang.String,%20int,%20int,%20net.minecraft.nbt.NBTTagCompound)">BlockSnapshot</a></strong>(int dimension, + int x, + int y, + int z, + java.lang.String modid, + java.lang.String blockName, + int meta, + int flag, + <a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> nbt)</code> +<div class="block">Raw constructor designed for serialization usages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#BlockSnapshot(net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraft.block.Block,%20int)">BlockSnapshot</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int meta)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#BlockSnapshot(net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraft.block.Block,%20int,%20int)">BlockSnapshot</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int meta, + int flag)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#BlockSnapshot(net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraft.block.Block,%20int,%20net.minecraft.nbt.NBTTagCompound)">BlockSnapshot</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int meta, + <a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> nbt)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#getBlockSnapshot(net.minecraft.world.World,%20int,%20int,%20int)">getBlockSnapshot</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#getBlockSnapshot(net.minecraft.world.World,%20int,%20int,%20int,%20int)">getBlockSnapshot</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + int flag)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#getCurrentBlock()">getCurrentBlock</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#getReplacedBlock()">getReplacedBlock</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#getTileEntity()">getTileEntity</a></strong>()</code> </td> +</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/util/BlockSnapshot.html#getWorld()">getWorld</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#readFromNBT(net.minecraft.nbt.NBTTagCompound)">readFromNBT</a></strong>(<a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#restore()">restore</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#restore(boolean)">restore</a></strong>(boolean force)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#restore(boolean,%20boolean)">restore</a></strong>(boolean force, + boolean applyPhysics)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#restoreToLocation(net.minecraft.world.World,%20int,%20int,%20int,%20boolean,%20boolean)">restoreToLocation</a></strong>(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + boolean force, + boolean applyPhysics)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html#writeToNBT(net.minecraft.nbt.NBTTagCompound)">writeToNBT</a></strong>(<a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compound)</code> </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, 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="x"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>x</h4> +<pre>public final int x</pre> +</li> +</ul> +<a name="y"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>y</h4> +<pre>public final int y</pre> +</li> +</ul> +<a name="z"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>z</h4> +<pre>public final int z</pre> +</li> +</ul> +<a name="dimId"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>dimId</h4> +<pre>public final int dimId</pre> +</li> +</ul> +<a name="replacedBlock"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>replacedBlock</h4> +<pre>public transient <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> replacedBlock</pre> +</li> +</ul> +<a name="meta"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>meta</h4> +<pre>public final int meta</pre> +</li> +</ul> +<a name="flag"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flag</h4> +<pre>public int flag</pre> +</li> +</ul> +<a name="world"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>world</h4> +<pre>public transient <a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world</pre> +</li> +</ul> +<a name="blockIdentifier"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>blockIdentifier</h4> +<pre>public final <a href="../../../../cpw/mods/fml/common/registry/GameRegistry.UniqueIdentifier.html" title="class in cpw.mods.fml.common.registry">GameRegistry.UniqueIdentifier</a> blockIdentifier</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BlockSnapshot(net.minecraft.world.World, int, int, int, net.minecraft.block.Block, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BlockSnapshot</h4> +<pre>public BlockSnapshot(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int meta)</pre> +</li> +</ul> +<a name="BlockSnapshot(net.minecraft.world.World, int, int, int, net.minecraft.block.Block, int, net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BlockSnapshot</h4> +<pre>public BlockSnapshot(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int meta, + <a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> nbt)</pre> +</li> +</ul> +<a name="BlockSnapshot(net.minecraft.world.World, int, int, int, net.minecraft.block.Block, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>BlockSnapshot</h4> +<pre>public BlockSnapshot(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + int meta, + int flag)</pre> +</li> +</ul> +<a name="BlockSnapshot(int, int, int, int, java.lang.String, java.lang.String, int, int, net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BlockSnapshot</h4> +<pre>public BlockSnapshot(int dimension, + int x, + int y, + int z, + java.lang.String modid, + java.lang.String blockName, + int meta, + int flag, + <a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> nbt)</pre> +<div class="block">Raw constructor designed for serialization usages.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getBlockSnapshot(net.minecraft.world.World, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockSnapshot</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a> getBlockSnapshot(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</pre> +</li> +</ul> +<a name="getBlockSnapshot(net.minecraft.world.World, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlockSnapshot</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a> getBlockSnapshot(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + int flag)</pre> +</li> +</ul> +<a name="readFromNBT(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readFromNBT</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a> readFromNBT(<a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> tag)</pre> +</li> +</ul> +<a name="getCurrentBlock()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentBlock</h4> +<pre>public <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> getCurrentBlock()</pre> +</li> +</ul> +<a name="getWorld()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWorld</h4> +<pre>public <a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> getWorld()</pre> +</li> +</ul> +<a name="getReplacedBlock()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReplacedBlock</h4> +<pre>public <a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> getReplacedBlock()</pre> +</li> +</ul> +<a name="getTileEntity()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTileEntity</h4> +<pre>public <a href="../../../../net/minecraft/tileentity/TileEntity.html" title="class in net.minecraft.tileentity">TileEntity</a> getTileEntity()</pre> +</li> +</ul> +<a name="restore()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restore</h4> +<pre>public boolean restore()</pre> +</li> +</ul> +<a name="restore(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restore</h4> +<pre>public boolean restore(boolean force)</pre> +</li> +</ul> +<a name="restore(boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restore</h4> +<pre>public boolean restore(boolean force, + boolean applyPhysics)</pre> +</li> +</ul> +<a name="restoreToLocation(net.minecraft.world.World, int, int, int, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>restoreToLocation</h4> +<pre>public boolean restoreToLocation(<a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z, + boolean force, + boolean applyPhysics)</pre> +</li> +</ul> +<a name="writeToNBT(net.minecraft.nbt.NBTTagCompound)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeToNBT</h4> +<pre>public void writeToNBT(<a href="../../../../net/minecraft/nbt/NBTTagCompound.html" title="class in net.minecraft.nbt">NBTTagCompound</a> compound)</pre> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <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="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/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/ChunkCoordComparator.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/BlockSnapshot.html" target="_top">Frames</a></li> +<li><a href="BlockSnapshot.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><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> diff --git a/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html b/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html new file mode 100644 index 0000000..8ff601c --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html @@ -0,0 +1,272 @@ +<!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:20 EST 2015 --> +<title>ChunkCoordComparator (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="ChunkCoordComparator (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/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/Constants.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/ChunkCoordComparator.html" target="_top">Frames</a></li> +<li><a href="ChunkCoordComparator.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><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.util</div> +<h2 title="Class ChunkCoordComparator" class="title">Class ChunkCoordComparator</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.ChunkCoordComparator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Comparator<<a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ChunkCoordComparator</span> +extends java.lang.Object +implements java.util.Comparator<<a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/ChunkCoordComparator.html#ChunkCoordComparator(net.minecraft.entity.player.EntityPlayerMP)">ChunkCoordComparator</a></strong>(<a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a> entityplayer)</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ChunkCoordComparator.html#compare(net.minecraft.world.ChunkCoordIntPair,%20net.minecraft.world.ChunkCoordIntPair)">compare</a></strong>(<a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> a, + <a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> b)</code> </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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Comparator"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Comparator</h3> +<code>equals</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="ChunkCoordComparator(net.minecraft.entity.player.EntityPlayerMP)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ChunkCoordComparator</h4> +<pre>public ChunkCoordComparator(<a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a> entityplayer)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="compare(net.minecraft.world.ChunkCoordIntPair, net.minecraft.world.ChunkCoordIntPair)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>compare</h4> +<pre>public int compare(<a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> a, + <a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a> b)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compare</code> in interface <code>java.util.Comparator<<a href="../../../../net/minecraft/world/ChunkCoordIntPair.html" title="class in net.minecraft.world">ChunkCoordIntPair</a>></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="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/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/Constants.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/ChunkCoordComparator.html" target="_top">Frames</a></li> +<li><a href="ChunkCoordComparator.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><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> diff --git a/javadoc/net/minecraftforge/common/util/Constants.NBT.html b/javadoc/net/minecraftforge/common/util/Constants.NBT.html new file mode 100644 index 0000000..4cc53fa --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/Constants.NBT.html @@ -0,0 +1,439 @@ +<!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:20 EST 2015 --> +<title>Constants.NBT (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="Constants.NBT (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/util/Constants.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/EnumHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/Constants.NBT.html" target="_top">Frames</a></li> +<li><a href="Constants.NBT.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">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>Method</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.util</div> +<h2 title="Class Constants.NBT" class="title">Class Constants.NBT</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.Constants.NBT</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../net/minecraftforge/common/util/Constants.html" title="class in net.minecraftforge.common.util">Constants</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">Constants.NBT</span> +extends java.lang.Object</pre> +<div class="block">NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, + table used in NBTBase.func_150283_g + + Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)</div> +</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_ANY_NUMERIC">TAG_ANY_NUMERIC</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_BYTE">TAG_BYTE</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/util/Constants.NBT.html#TAG_BYTE_ARRAY">TAG_BYTE_ARRAY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_COMPOUND">TAG_COMPOUND</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/util/Constants.NBT.html#TAG_DOUBLE">TAG_DOUBLE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_END">TAG_END</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/util/Constants.NBT.html#TAG_FLOAT">TAG_FLOAT</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_INT">TAG_INT</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/util/Constants.NBT.html#TAG_INT_ARRAY">TAG_INT_ARRAY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_LIST">TAG_LIST</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/util/Constants.NBT.html#TAG_LONG">TAG_LONG</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html#TAG_SHORT">TAG_SHORT</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/util/Constants.NBT.html#TAG_STRING">TAG_STRING</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/util/Constants.NBT.html#Constants.NBT()">Constants.NBT</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> +<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="TAG_END"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_END</h4> +<pre>public static final int TAG_END</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_END">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_BYTE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_BYTE</h4> +<pre>public static final int TAG_BYTE</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_BYTE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_SHORT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_SHORT</h4> +<pre>public static final int TAG_SHORT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_SHORT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_INT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_INT</h4> +<pre>public static final int TAG_INT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_INT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_LONG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_LONG</h4> +<pre>public static final int TAG_LONG</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_LONG">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_FLOAT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_FLOAT</h4> +<pre>public static final int TAG_FLOAT</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_FLOAT">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_DOUBLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_DOUBLE</h4> +<pre>public static final int TAG_DOUBLE</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_DOUBLE">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_BYTE_ARRAY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_BYTE_ARRAY</h4> +<pre>public static final int TAG_BYTE_ARRAY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_BYTE_ARRAY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_STRING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_STRING</h4> +<pre>public static final int TAG_STRING</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_STRING">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_LIST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_LIST</h4> +<pre>public static final int TAG_LIST</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_LIST">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_COMPOUND"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_COMPOUND</h4> +<pre>public static final int TAG_COMPOUND</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_COMPOUND">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_INT_ARRAY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAG_INT_ARRAY</h4> +<pre>public static final int TAG_INT_ARRAY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_INT_ARRAY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="TAG_ANY_NUMERIC"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TAG_ANY_NUMERIC</h4> +<pre>public static final int TAG_ANY_NUMERIC</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#net.minecraftforge.common.util.Constants.NBT.TAG_ANY_NUMERIC">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Constants.NBT()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Constants.NBT</h4> +<pre>public Constants.NBT()</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/util/Constants.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/EnumHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/Constants.NBT.html" target="_top">Frames</a></li> +<li><a href="Constants.NBT.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#methods_inherited_from_class_java.lang.Object">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>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/util/Constants.html b/javadoc/net/minecraftforge/common/util/Constants.html new file mode 100644 index 0000000..e1a8cc9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/Constants.html @@ -0,0 +1,252 @@ +<!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:20 EST 2015 --> +<title>Constants (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="Constants (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/util/ChunkCoordComparator.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/Constants.html" target="_top">Frames</a></li> +<li><a href="Constants.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="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.util</div> +<h2 title="Class Constants" class="title">Class Constants</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.Constants</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Constants</span> +extends java.lang.Object</pre> +<div class="block">A class containing constants for magic numbers used in the minecraft codebase. + Everything here should be checked each update, and have a comment relating to where to check it.</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/util/Constants.NBT.html" title="class in net.minecraftforge.common.util">Constants.NBT</a></strong></code> +<div class="block">NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, + table used in NBTBase.func_150283_g + + Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)</div> +</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/util/Constants.html#Constants()">Constants</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> +<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="Constants()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Constants</h4> +<pre>public Constants()</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/util/ChunkCoordComparator.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/Constants.html" target="_top">Frames</a></li> +<li><a href="Constants.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="#methods_inherited_from_class_java.lang.Object">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/util/EnumHelper.html b/javadoc/net/minecraftforge/common/util/EnumHelper.html new file mode 100644 index 0000000..dff6c7b --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/EnumHelper.html @@ -0,0 +1,544 @@ +<!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:20 EST 2015 --> +<title>EnumHelper (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="EnumHelper (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/util/Constants.NBT.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/EnumHelper.html" target="_top">Frames</a></li> +<li><a href="EnumHelper.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><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.util</div> +<h2 title="Class EnumHelper" class="title">Class EnumHelper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.EnumHelper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../net/minecraftforge/client/EnumHelperClient.html" title="class in net.minecraftforge.client">EnumHelperClient</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">EnumHelper</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/EnumHelper.html#EnumHelper()">EnumHelper</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 <a href="../../../../net/minecraft/item/EnumAction.html" title="enum in net.minecraft.item">EnumAction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addAction(java.lang.String)">addAction</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/item/ItemArmor.ArmorMaterial.html" title="enum in net.minecraft.item">ItemArmor.ArmorMaterial</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addArmorMaterial(java.lang.String,%20int,%20int[],%20int)">addArmorMaterial</a></strong>(java.lang.String name, + int durability, + int[] reductionAmounts, + int enchantability)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/entity/item/EntityPainting.EnumArt.html" title="enum in net.minecraft.entity.item">EntityPainting.EnumArt</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addArt(java.lang.String,%20java.lang.String,%20int,%20int,%20int,%20int)">addArt</a></strong>(java.lang.String name, + java.lang.String tile, + int sizeX, + int sizeY, + int offsetX, + int offsetY)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/entity/EnumCreatureAttribute.html" title="enum in net.minecraft.entity">EnumCreatureAttribute</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addCreatureAttribute(java.lang.String)">addCreatureAttribute</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/entity/EnumCreatureType.html" title="enum in net.minecraft.entity">EnumCreatureType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addCreatureType(java.lang.String,%20java.lang.Class,%20int,%20net.minecraft.block.material.Material,%20boolean,%20boolean)">addCreatureType</a></strong>(java.lang.String name, + java.lang.Class typeClass, + int maxNumber, + <a href="../../../../net/minecraft/block/material/Material.html" title="class in net.minecraft.block.material">Material</a> material, + boolean peaceful, + boolean animal)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/world/gen/structure/StructureStrongholdPieces.Stronghold.Door.html" title="enum in net.minecraft.world.gen.structure">StructureStrongholdPieces.Stronghold.Door</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addDoor(java.lang.String)">addDoor</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/enchantment/EnumEnchantmentType.html" title="enum in net.minecraft.enchantment">EnumEnchantmentType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addEnchantmentType(java.lang.String)">addEnchantmentType</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/entity/Entity.EnumEntitySize.html" title="enum in net.minecraft.entity">Entity.EnumEntitySize</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addEntitySize(java.lang.String)">addEntitySize</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends java.lang.Enum<?>> <br>T</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addEnum(java.lang.Class[][],%20java.lang.Class,%20java.lang.String,%20java.lang.Object...)">addEnum</a></strong>(java.lang.Class[][] map, + java.lang.Class<T> enumType, + java.lang.String enumName, + java.lang.Object... paramValues)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <T extends java.lang.Enum<?>> <br>T</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addEnum(java.lang.Class,%20java.lang.String,%20java.lang.Class[],%20java.lang.Object[])">addEnum</a></strong>(java.lang.Class<T> enumType, + java.lang.String enumName, + java.lang.Class<?>[] paramTypes, + java.lang.Object[] paramValues)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <T extends java.lang.Enum<?>> <br>T</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addEnum(java.lang.Class,%20java.lang.String,%20java.lang.Object...)">addEnum</a></strong>(java.lang.Class<T> enumType, + java.lang.String enumName, + java.lang.Object... paramValues)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/util/MovingObjectPosition.MovingObjectType.html" title="enum in net.minecraft.util">MovingObjectPosition.MovingObjectType</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addMovingObjectType(java.lang.String)">addMovingObjectType</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/item/EnumRarity.html" title="enum in net.minecraft.item">EnumRarity</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addRarity(java.lang.String,%20net.minecraft.util.EnumChatFormatting,%20java.lang.String)">addRarity</a></strong>(java.lang.String name, + <a href="../../../../net/minecraft/util/EnumChatFormatting.html" title="enum in net.minecraft.util">EnumChatFormatting</a> color, + java.lang.String displayName)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/block/BlockPressurePlate.Sensitivity.html" title="enum in net.minecraft.block">BlockPressurePlate.Sensitivity</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addSensitivity(java.lang.String)">addSensitivity</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/world/EnumSkyBlock.html" title="enum in net.minecraft.world">EnumSkyBlock</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addSkyBlock(java.lang.String,%20int)">addSkyBlock</a></strong>(java.lang.String name, + int lightValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/entity/player/EntityPlayer.EnumStatus.html" title="enum in net.minecraft.entity.player">EntityPlayer.EnumStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addStatus(java.lang.String)">addStatus</a></strong>(java.lang.String name)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraft/item/Item.ToolMaterial.html" title="enum in net.minecraft.item">Item.ToolMaterial</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#addToolMaterial(java.lang.String,%20int,%20int,%20float,%20float,%20int)">addToolMaterial</a></strong>(java.lang.String name, + int harvestLevel, + int maxUses, + float efficiency, + float damage, + int enchantability)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/EnumHelper.html#setFailsafeFieldValue(java.lang.reflect.Field,%20java.lang.Object,%20java.lang.Object)">setFailsafeFieldValue</a></strong>(java.lang.reflect.Field field, + java.lang.Object target, + java.lang.Object value)</code> </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="EnumHelper()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EnumHelper</h4> +<pre>public EnumHelper()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="addAction(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addAction</h4> +<pre>public static <a href="../../../../net/minecraft/item/EnumAction.html" title="enum in net.minecraft.item">EnumAction</a> addAction(java.lang.String name)</pre> +</li> +</ul> +<a name="addArmorMaterial(java.lang.String, int, int[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addArmorMaterial</h4> +<pre>public static <a href="../../../../net/minecraft/item/ItemArmor.ArmorMaterial.html" title="enum in net.minecraft.item">ItemArmor.ArmorMaterial</a> addArmorMaterial(java.lang.String name, + int durability, + int[] reductionAmounts, + int enchantability)</pre> +</li> +</ul> +<a name="addArt(java.lang.String, java.lang.String, int, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addArt</h4> +<pre>public static <a href="../../../../net/minecraft/entity/item/EntityPainting.EnumArt.html" title="enum in net.minecraft.entity.item">EntityPainting.EnumArt</a> addArt(java.lang.String name, + java.lang.String tile, + int sizeX, + int sizeY, + int offsetX, + int offsetY)</pre> +</li> +</ul> +<a name="addCreatureAttribute(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCreatureAttribute</h4> +<pre>public static <a href="../../../../net/minecraft/entity/EnumCreatureAttribute.html" title="enum in net.minecraft.entity">EnumCreatureAttribute</a> addCreatureAttribute(java.lang.String name)</pre> +</li> +</ul> +<a name="addCreatureType(java.lang.String, java.lang.Class, int, net.minecraft.block.material.Material, boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addCreatureType</h4> +<pre>public static <a href="../../../../net/minecraft/entity/EnumCreatureType.html" title="enum in net.minecraft.entity">EnumCreatureType</a> addCreatureType(java.lang.String name, + java.lang.Class typeClass, + int maxNumber, + <a href="../../../../net/minecraft/block/material/Material.html" title="class in net.minecraft.block.material">Material</a> material, + boolean peaceful, + boolean animal)</pre> +</li> +</ul> +<a name="addDoor(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addDoor</h4> +<pre>public static <a href="../../../../net/minecraft/world/gen/structure/StructureStrongholdPieces.Stronghold.Door.html" title="enum in net.minecraft.world.gen.structure">StructureStrongholdPieces.Stronghold.Door</a> addDoor(java.lang.String name)</pre> +</li> +</ul> +<a name="addEnchantmentType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEnchantmentType</h4> +<pre>public static <a href="../../../../net/minecraft/enchantment/EnumEnchantmentType.html" title="enum in net.minecraft.enchantment">EnumEnchantmentType</a> addEnchantmentType(java.lang.String name)</pre> +</li> +</ul> +<a name="addEntitySize(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEntitySize</h4> +<pre>public static <a href="../../../../net/minecraft/entity/Entity.EnumEntitySize.html" title="enum in net.minecraft.entity">Entity.EnumEntitySize</a> addEntitySize(java.lang.String name)</pre> +</li> +</ul> +<a name="addSensitivity(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSensitivity</h4> +<pre>public static <a href="../../../../net/minecraft/block/BlockPressurePlate.Sensitivity.html" title="enum in net.minecraft.block">BlockPressurePlate.Sensitivity</a> addSensitivity(java.lang.String name)</pre> +</li> +</ul> +<a name="addMovingObjectType(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addMovingObjectType</h4> +<pre>public static <a href="../../../../net/minecraft/util/MovingObjectPosition.MovingObjectType.html" title="enum in net.minecraft.util">MovingObjectPosition.MovingObjectType</a> addMovingObjectType(java.lang.String name)</pre> +</li> +</ul> +<a name="addSkyBlock(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addSkyBlock</h4> +<pre>public static <a href="../../../../net/minecraft/world/EnumSkyBlock.html" title="enum in net.minecraft.world">EnumSkyBlock</a> addSkyBlock(java.lang.String name, + int lightValue)</pre> +</li> +</ul> +<a name="addStatus(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addStatus</h4> +<pre>public static <a href="../../../../net/minecraft/entity/player/EntityPlayer.EnumStatus.html" title="enum in net.minecraft.entity.player">EntityPlayer.EnumStatus</a> addStatus(java.lang.String name)</pre> +</li> +</ul> +<a name="addToolMaterial(java.lang.String, int, int, float, float, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addToolMaterial</h4> +<pre>public static <a href="../../../../net/minecraft/item/Item.ToolMaterial.html" title="enum in net.minecraft.item">Item.ToolMaterial</a> addToolMaterial(java.lang.String name, + int harvestLevel, + int maxUses, + float efficiency, + float damage, + int enchantability)</pre> +</li> +</ul> +<a name="addRarity(java.lang.String, net.minecraft.util.EnumChatFormatting, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addRarity</h4> +<pre>public static <a href="../../../../net/minecraft/item/EnumRarity.html" title="enum in net.minecraft.item">EnumRarity</a> addRarity(java.lang.String name, + <a href="../../../../net/minecraft/util/EnumChatFormatting.html" title="enum in net.minecraft.util">EnumChatFormatting</a> color, + java.lang.String displayName)</pre> +</li> +</ul> +<a name="setFailsafeFieldValue(java.lang.reflect.Field, java.lang.Object, java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailsafeFieldValue</h4> +<pre>public static void setFailsafeFieldValue(java.lang.reflect.Field field, + java.lang.Object target, + java.lang.Object value) + throws java.lang.Exception</pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="addEnum(java.lang.Class, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEnum</h4> +<pre>public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType, + java.lang.String enumName, + java.lang.Object... paramValues)</pre> +</li> +</ul> +<a name="addEnum(java.lang.Class[][], java.lang.Class, java.lang.String, java.lang.Object...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEnum</h4> +<pre>public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class[][] map, + java.lang.Class<T> enumType, + java.lang.String enumName, + java.lang.Object... paramValues)</pre> +</li> +</ul> +<a name="addEnum(java.lang.Class, java.lang.String, java.lang.Class[], java.lang.Object[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>addEnum</h4> +<pre>public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType, + java.lang.String enumName, + java.lang.Class<?>[] paramTypes, + java.lang.Object[] paramValues)</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/util/Constants.NBT.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/EnumHelper.html" target="_top">Frames</a></li> +<li><a href="EnumHelper.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><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> diff --git a/javadoc/net/minecraftforge/common/util/FakePlayer.html b/javadoc/net/minecraftforge/common/util/FakePlayer.html new file mode 100644 index 0000000..e9da208 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/FakePlayer.html @@ -0,0 +1,558 @@ +<!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:20 EST 2015 --> +<title>FakePlayer (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="FakePlayer (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/util/EnumHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/FakePlayerFactory.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/FakePlayer.html" target="_top">Frames</a></li> +<li><a href="FakePlayer.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_classes_inherited_from_class_net.minecraft.entity.player.EntityPlayer">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_net.minecraft.entity.player.EntityPlayerMP">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>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.util</div> +<h2 title="Class FakePlayer" class="title">Class FakePlayer</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">net.minecraft.entity.Entity</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">net.minecraft.entity.EntityLivingBase</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">net.minecraft.entity.player.EntityPlayer</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">net.minecraft.entity.player.EntityPlayerMP</a></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.FakePlayer</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../net/minecraft/command/ICommandSender.html" title="interface in net.minecraft.command">ICommandSender</a>, <a href="../../../../net/minecraft/inventory/ICrafting.html" title="interface in net.minecraft.inventory">ICrafting</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FakePlayer</span> +extends <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_net.minecraft.entity.player.EntityPlayer"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a></h3> +<code><a href="../../../../net/minecraft/entity/player/EntityPlayer.EnumChatVisibility.html" title="enum in net.minecraft.entity.player">EntityPlayer.EnumChatVisibility</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.EnumStatus.html" title="enum in net.minecraft.entity.player">EntityPlayer.EnumStatus</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_net.minecraft.entity.Entity"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class net.minecraft.entity.<a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a></h3> +<code><a href="../../../../net/minecraft/entity/Entity.EnumEntitySize.html" title="enum in net.minecraft.entity">Entity.EnumEntitySize</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.entity.player.EntityPlayerMP"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></h3> +<code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#currentWindowId">currentWindowId</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#isChangingQuantityOnly">isChangingQuantityOnly</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#loadedChunks">loadedChunks</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#managedPosX">managedPosX</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#managedPosZ">managedPosZ</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#mcServer">mcServer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#ping">ping</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#playerConqueredTheEnd">playerConqueredTheEnd</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#playerNetServerHandler">playerNetServerHandler</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#theItemInWorldManager">theItemInWorldManager</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.entity.player.EntityPlayer"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a></h3> +<code><a href="../../../../net/minecraft/entity/player/EntityPlayer.html#cameraYaw">cameraYaw</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#capabilities">capabilities</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#experience">experience</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#experienceLevel">experienceLevel</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#experienceTotal">experienceTotal</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#eyeHeight">eyeHeight</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71079_bU">field_71079_bU</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71082_cx">field_71082_cx</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71085_bR">field_71085_bR</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71089_bV">field_71089_bV</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71091_bM">field_71091_bM</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71094_bP">field_71094_bP</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71095_bQ">field_71095_bQ</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71096_bN">field_71096_bN</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#field_71097_bO">field_71097_bO</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#fishEntity">fishEntity</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#flyToggleTimer">flyToggleTimer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#foodStats">foodStats</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#inventory">inventory</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#inventoryContainer">inventoryContainer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#openContainer">openContainer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#PERSISTED_NBT_TAG">PERSISTED_NBT_TAG</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#playerLocation">playerLocation</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#prevCameraYaw">prevCameraYaw</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#sleeping">sleeping</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#speedInAir">speedInAir</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#speedOnGround">speedOnGround</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#xpCooldown">xpCooldown</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.entity.EntityLivingBase"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.entity.<a href="../../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a></h3> +<code><a href="../../../../net/minecraft/entity/EntityLivingBase.html#arrowHitTimer">arrowHitTimer</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#attackedAtYaw">attackedAtYaw</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#attackingPlayer">attackingPlayer</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#attackTime">attackTime</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#cameraPitch">cameraPitch</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#dead">dead</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#deathTime">deathTime</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#entityAge">entityAge</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_110154_aX">field_110154_aX</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_70741_aB">field_70741_aB</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_70763_ax">field_70763_ax</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_70764_aw">field_70764_aw</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_70768_au">field_70768_au</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_70769_ao">field_70769_ao</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#field_70770_ap">field_70770_ap</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#hurtTime">hurtTime</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isJumping">isJumping</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isSwingInProgress">isSwingInProgress</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#jumpMovementFactor">jumpMovementFactor</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#lastDamage">lastDamage</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#limbSwing">limbSwing</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#limbSwingAmount">limbSwingAmount</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#maxHurtResistantTime">maxHurtResistantTime</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#maxHurtTime">maxHurtTime</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#moveForward">moveForward</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#moveStrafing">moveStrafing</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#newPosRotationIncrements">newPosRotationIncrements</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#newPosX">newPosX</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#newPosY">newPosY</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#newPosZ">newPosZ</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#newRotationPitch">newRotationPitch</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#newRotationYaw">newRotationYaw</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#prevCameraPitch">prevCameraPitch</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#prevHealth">prevHealth</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#prevLimbSwingAmount">prevLimbSwingAmount</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#prevRenderYawOffset">prevRenderYawOffset</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#prevRotationYawHead">prevRotationYawHead</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#prevSwingProgress">prevSwingProgress</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#randomYawVelocity">randomYawVelocity</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#recentlyHit">recentlyHit</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#renderYawOffset">renderYawOffset</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#rotationYawHead">rotationYawHead</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#scoreValue">scoreValue</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#swingProgress">swingProgress</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#swingProgressInt">swingProgressInt</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_net.minecraft.entity.Entity"> +<!-- --> +</a> +<h3>Fields inherited from class net.minecraft.entity.<a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a></h3> +<code><a href="../../../../net/minecraft/entity/Entity.html#addedToChunk">addedToChunk</a>, <a href="../../../../net/minecraft/entity/Entity.html#boundingBox">boundingBox</a>, <a href="../../../../net/minecraft/entity/Entity.html#capturedDrops">capturedDrops</a>, <a href="../../../../net/minecraft/entity/Entity.html#captureDrops">captureDrops</a>, <a href="../../../../net/minecraft/entity/Entity.html#chunkCoordX">chunkCoordX</a>, <a href="../../../../net/minecraft/entity/Entity.html#chunkCoordY">chunkCoordY</a>, <a href="../../../../net/minecraft/entity/Entity.html#chunkCoordZ">chunkCoordZ</a>, <a href="../../../../net/minecraft/entity/Entity.html#dataWatcher">dataWatcher</a>, <a href="../../../../net/minecraft/entity/Entity.html#dimension">dimension</a>, <a href="../../../../net/minecraft/entity/Entity.html#distanceWalkedModified">distanceWalkedModified</a>, <a href="../../../../net/minecraft/entity/Entity.html#distanceWalkedOnStepModified">distanceWalkedOnStepModified</a>, <a href="../../../../net/minecraft/entity/Entity.html#entityCollisionReduction">entityCollisionReduction</a>, <a href="../../../../net/minecraft/entity/Entity.html#entityUniqueID">entityUniqueID</a>, <a href="../../../../net/minecraft/entity/Entity.html#extendedProperties">extendedProperties</a>, <a href="../../../../net/minecraft/entity/Entity.html#fallDistance">fallDistance</a>, <a href="../../../../net/minecraft/entity/Entity.html#field_70135_K">field_70135_K</a>, <a href="../../../../net/minecraft/entity/Entity.html#fireResistance">fireResistance</a>, <a href="../../../../net/minecraft/entity/Entity.html#forceSpawn">forceSpawn</a>, <a href="../../../../net/minecraft/entity/Entity.html#height">height</a>, <a href="../../../../net/minecraft/entity/Entity.html#hurtResistantTime">hurtResistantTime</a>, <a href="../../../../net/minecraft/entity/Entity.html#ignoreFrustumCheck">ignoreFrustumCheck</a>, <a href="../../../../net/minecraft/entity/Entity.html#inPortal">inPortal</a>, <a href="../../../../net/minecraft/entity/Entity.html#inWater">inWater</a>, <a href="../../../../net/minecraft/entity/Entity.html#isAirBorne">isAirBorne</a>, <a href="../../../../net/minecraft/entity/Entity.html#isCollided">isCollided</a>, <a href="../../../../net/minecraft/entity/Entity.html#isCollidedHorizontally">isCollidedHorizontally</a>, <a href="../../../../net/minecraft/entity/Entity.html#isCollidedVertically">isCollidedVertically</a>, <a href="../../../../net/minecraft/entity/Entity.html#isDead">isDead</a>, <a href="../../../../net/minecraft/entity/Entity.html#isImmuneToFire">isImmuneToFire</a>, <a href="../../../../net/minecraft/entity/Entity.html#isInWeb">isInWeb</a>, <a href="../../../../net/minecraft/entity/Entity.html#lastTickPosX">lastTickPosX</a>, <a href="../../../../net/minecraft/entity/Entity.html#lastTickPosY">lastTickPosY</a>, <a href="../../../../net/minecraft/entity/Entity.html#lastTickPosZ">lastTickPosZ</a>, <a href="../../../../net/minecraft/entity/Entity.html#motionX">motionX</a>, <a href="../../../../net/minecraft/entity/Entity.html#motionY">motionY</a>, <a href="../../../../net/minecraft/entity/Entity.html#motionZ">motionZ</a>, <a href="../../../../net/minecraft/entity/Entity.html#myEntitySize">myEntitySize</a>, <a href="../../../../net/minecraft/entity/Entity.html#noClip">noClip</a>, <a href="../../../../net/minecraft/entity/Entity.html#onGround">onGround</a>, <a href="../../../../net/minecraft/entity/Entity.html#portalCounter">portalCounter</a>, <a href="../../../../net/minecraft/entity/Entity.html#posX">posX</a>, <a href="../../../../net/minecraft/entity/Entity.html#posY">posY</a>, <a href="../../../../net/minecraft/entity/Entity.html#posZ">posZ</a>, <a href="../../../../net/minecraft/entity/Entity.html#prevDistanceWalkedModified">prevDistanceWalkedModified</a>, <a href="../../../../net/minecraft/entity/Entity.html#preventEntitySpawning">preventEntitySpawning</a>, <a href="../../../../net/minecraft/entity/Entity.html#prevPosX">prevPosX</a>, <a href="../../../../net/minecraft/entity/Entity.html#prevPosY">prevPosY</a>, <a href="../../../../net/minecraft/entity/Entity.html#prevPosZ">prevPosZ</a>, <a href="../../../../net/minecraft/entity/Entity.html#prevRotationPitch">prevRotationPitch</a>, <a href="../../../../net/minecraft/entity/Entity.html#prevRotationYaw">prevRotationYaw</a>, <a href="../../../../net/minecraft/entity/Entity.html#rand">rand</a>, <a href="../../../../net/minecraft/entity/Entity.html#renderDistanceWeight">renderDistanceWeight</a>, <a href="../../../../net/minecraft/entity/Entity.html#riddenByEntity">riddenByEntity</a>, <a href="../../../../net/minecraft/entity/Entity.html#ridingEntity">ridingEntity</a>, <a href="../../../../net/minecraft/entity/Entity.html#rotationPitch">rotationPitch</a>, <a href="../../../../net/minecraft/entity/Entity.html#rotationYaw">rotationYaw</a>, <a href="../../../../net/minecraft/entity/Entity.html#serverPosX">serverPosX</a>, <a href="../../../../net/minecraft/entity/Entity.html#serverPosY">serverPosY</a>, <a href="../../../../net/minecraft/entity/Entity.html#serverPosZ">serverPosZ</a>, <a href="../../../../net/minecraft/entity/Entity.html#stepHeight">stepHeight</a>, <a href="../../../../net/minecraft/entity/Entity.html#teleportDirection">teleportDirection</a>, <a href="../../../../net/minecraft/entity/Entity.html#ticksExisted">ticksExisted</a>, <a href="../../../../net/minecraft/entity/Entity.html#timeUntilPortal">timeUntilPortal</a>, <a href="../../../../net/minecraft/entity/Entity.html#velocityChanged">velocityChanged</a>, <a href="../../../../net/minecraft/entity/Entity.html#width">width</a>, <a href="../../../../net/minecraft/entity/Entity.html#worldObj">worldObj</a>, <a href="../../../../net/minecraft/entity/Entity.html#yOffset">yOffset</a>, <a href="../../../../net/minecraft/entity/Entity.html#ySize">ySize</a></code></li> +</ul> +</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/util/FakePlayer.html#FakePlayer(net.minecraft.world.WorldServer,%20com.mojang.authlib.GameProfile)">FakePlayer</a></strong>(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world, + com.mojang.authlib.GameProfile name)</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/util/FakePlayer.html#addChatComponentMessage(net.minecraft.util.IChatComponent)">addChatComponentMessage</a></strong>(<a href="../../../../net/minecraft/util/IChatComponent.html" title="interface in net.minecraft.util">IChatComponent</a> chatmessagecomponent)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#addStat(net.minecraft.stats.StatBase,%20int)">addStat</a></strong>(<a href="../../../../net/minecraft/stats/StatBase.html" title="class in net.minecraft.stats">StatBase</a> par1StatBase, + int par2)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#canAttackPlayer(net.minecraft.entity.player.EntityPlayer)">canAttackPlayer</a></strong>(<a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#canCommandSenderUseCommand(int,%20java.lang.String)">canCommandSenderUseCommand</a></strong>(int i, + java.lang.String s)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#func_147100_a(net.minecraft.network.play.client.C15PacketClientSettings)">func_147100_a</a></strong>(<a href="../../../../net/minecraft/network/play/client/C15PacketClientSettings.html" title="class in net.minecraft.network.play.client">C15PacketClientSettings</a> pkt)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraft/util/ChunkCoordinates.html" title="class in net.minecraft.util">ChunkCoordinates</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#getPlayerCoordinates()">getPlayerCoordinates</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#isEntityInvulnerable()">isEntityInvulnerable</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#onDeath(net.minecraft.util.DamageSource)">onDeath</a></strong>(<a href="../../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#onUpdate()">onUpdate</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#openGui(java.lang.Object,%20int,%20net.minecraft.world.World,%20int,%20int,%20int)">openGui</a></strong>(java.lang.Object mod, + int modGuiId, + <a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayer.html#travelToDimension(int)">travelToDimension</a></strong>(int dim)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_net.minecraft.entity.player.EntityPlayerMP"> +<!-- --> +</a> +<h3>Methods inherited from class net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></h3> +<code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#addChatMessage(net.minecraft.util.IChatComponent)">addChatMessage</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#addExperienceLevel(int)">addExperienceLevel</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#addSelfToInternalCraftingInventory()">addSelfToInternalCraftingInventory</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#attackEntityFrom(net.minecraft.util.DamageSource,%20float)">attackEntityFrom</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#clonePlayer(net.minecraft.entity.player.EntityPlayer,%20boolean)">clonePlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#closeContainer()">closeContainer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#closeScreen()">closeScreen</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIAnvil(int,%20int,%20int)">displayGUIAnvil</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIChest(net.minecraft.inventory.IInventory)">displayGUIChest</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIEnchantment(int,%20int,%20int,%20java.lang.String)">displayGUIEnchantment</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIHopperMinecart(net.minecraft.entity.item.EntityMinecartHopper)">displayGUIHopperMinecart</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIHorse(net.minecraft.entity.passive.EntityHorse,%20net.minecraft.inventory.IInventory)">displayGUIHorse</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIMerchant(net.minecraft.entity.IMerchant,%20java.lang.String)">displayGUIMerchant</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#displayGUIWorkbench(int,%20int,%20int)">displayGUIWorkbench</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_143004_u()">func_143004_u</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_146093_a(net.minecraft.tileentity.TileEntityHopper)">func_146093_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_146098_a(net.minecraft.tileentity.TileEntityBrewingStand)">func_146098_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_146100_a(net.minecraft.tileentity.TileEntity)">func_146100_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_146101_a(net.minecraft.tileentity.TileEntityFurnace)">func_146101_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_146102_a(net.minecraft.tileentity.TileEntityDispenser)">func_146102_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_146104_a(net.minecraft.tileentity.TileEntityBeacon)">func_146104_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_147096_v()">func_147096_v</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_147098_j()">func_147098_j</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_147099_x()">func_147099_x</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_152339_d(net.minecraft.entity.Entity)">func_152339_d</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_154331_x()">func_154331_x</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#getDefaultEyeHeight()">getDefaultEyeHeight</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#getEyeHeight()">getEyeHeight</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#getNextWindowId()">getNextWindowId</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#getPlayerIP()">getPlayerIP</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#getServerForPlayer()">getServerForPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#handleFalling(double,%20boolean)">handleFalling</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#mountEntity(net.minecraft.entity.Entity)">mountEntity</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#mountEntityAndWakeUp()">mountEntityAndWakeUp</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onChangedPotionEffect(net.minecraft.potion.PotionEffect,%20boolean)">onChangedPotionEffect</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onCriticalHit(net.minecraft.entity.Entity)">onCriticalHit</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onEnchantmentCritical(net.minecraft.entity.Entity)">onEnchantmentCritical</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onFinishedPotionEffect(net.minecraft.potion.PotionEffect)">onFinishedPotionEffect</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onItemPickup(net.minecraft.entity.Entity,%20int)">onItemPickup</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onItemUseFinish()">onItemUseFinish</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onNewPotionEffect(net.minecraft.potion.PotionEffect)">onNewPotionEffect</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onUpdateEntity()">onUpdateEntity</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#readEntityFromNBT(net.minecraft.nbt.NBTTagCompound)">readEntityFromNBT</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#requestTexturePackLoad(java.lang.String)">requestTexturePackLoad</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#resetHeight()">resetHeight</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#sendContainerAndContentsToPlayer(net.minecraft.inventory.Container,%20java.util.List)">sendContainerAndContentsToPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#sendContainerToPlayer(net.minecraft.inventory.Container)">sendContainerToPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#sendPlayerAbilities()">sendPlayerAbilities</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#sendProgressBarUpdate(net.minecraft.inventory.Container,%20int,%20int)">sendProgressBarUpdate</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#sendSlotContents(net.minecraft.inventory.Container,%20int,%20net.minecraft.item.ItemStack)">sendSlotContents</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#setEntityActionState(float,%20float,%20boolean,%20boolean)">setEntityActionState</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#setGameType(net.minecraft.world.WorldSettings.GameType)">setGameType</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#setItemInUse(net.minecraft.item.ItemStack,%20int)">setItemInUse</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#setPlayerHealthUpdated()">setPlayerHealthUpdated</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#setPositionAndUpdate(double,%20double,%20double)">setPositionAndUpdate</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#sleepInBedAt(int,%20int,%20int)">sleepInBedAt</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#updateFallState(double,%20boolean)">updateFallState</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#updateHeldItem()">updateHeldItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#wakeUpPlayer(boolean,%20boolean,%20boolean)">wakeUpPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#writeEntityToNBT(net.minecraft.nbt.NBTTagCompound)">writeEntityToNBT</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_net.minecraft.entity.player.EntityPlayer"> +<!-- --> +</a> +<h3>Methods inherited from class net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a></h3> +<code><a href="../../../../net/minecraft/entity/player/EntityPlayer.html#addExhaustion(float)">addExhaustion</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#addExperience(int)">addExperience</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#addMovementStat(double,%20double,%20double)">addMovementStat</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#addScore(int)">addScore</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#addToPlayerScore(net.minecraft.entity.Entity,%20int)">addToPlayerScore</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#applyEntityAttributes()">applyEntityAttributes</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#attackTargetEntityWithCurrentItem(net.minecraft.entity.Entity)">attackTargetEntityWithCurrentItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#canEat(boolean)">canEat</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#canHarvestBlock(net.minecraft.block.Block)">canHarvestBlock</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#canPlayerEdit(int,%20int,%20int,%20int,%20net.minecraft.item.ItemStack)">canPlayerEdit</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#canTriggerWalking()">canTriggerWalking</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#clearItemInUse()">clearItemInUse</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#damageArmor(float)">damageArmor</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#damageEntity(net.minecraft.util.DamageSource,%20float)">damageEntity</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#destroyCurrentEquippedItem()">destroyCurrentEquippedItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#displayGUIBook(net.minecraft.item.ItemStack)">displayGUIBook</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#dropOneItem(boolean)">dropOneItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#dropPlayerItemWithRandomChoice(net.minecraft.item.ItemStack,%20boolean)">dropPlayerItemWithRandomChoice</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#entityInit()">entityInit</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#fall(float)">fall</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#func_145748_c_()">func_145748_c_</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#func_146067_o(int)">func_146067_o</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#func_146094_a(com.mojang.authlib.GameProfile)">func_146094_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#func_146095_a(net.minecraft.command.server.CommandBlockLogic)">func_146095_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#func_146097_a(net.minecraft.item.ItemStack,%20boolean,%20boolean)">func_146097_a</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getAbsorptionAmount()">getAbsorptionAmount</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getAIMoveSpeed()">getAIMoveSpeed</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getAlwaysRenderNameTagForRender()">getAlwaysRenderNameTagForRender</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getArmorVisibility()">getArmorVisibility</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getBedLocation()">getBedLocation</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getBedLocation(int)">getBedLocation</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getBedOrientationInDegrees()">getBedOrientationInDegrees</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getBreakSpeed(net.minecraft.block.Block,%20boolean,%20int)">getBreakSpeed</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getBreakSpeed(net.minecraft.block.Block,%20boolean,%20int,%20int,%20int,%20int)">getBreakSpeed</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getCommandSenderName()">getCommandSenderName</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getCurrentArmor(int)">getCurrentArmor</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getCurrentEquippedItem()">getCurrentEquippedItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getCurrentPlayerStrVsBlock(net.minecraft.block.Block,%20boolean)">getCurrentPlayerStrVsBlock</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getDeathSound()">getDeathSound</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getDisplayName()">getDisplayName</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getEntityWorld()">getEntityWorld</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getEquipmentInSlot(int)">getEquipmentInSlot</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getExperiencePoints(net.minecraft.entity.player.EntityPlayer)">getExperiencePoints</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getFoodStats()">getFoodStats</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getGameProfile()">getGameProfile</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getHeldItem()">getHeldItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getHideCape()">getHideCape</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getHideCape(int)">getHideCape</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getHurtSound()">getHurtSound</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getInventoryEnderChest()">getInventoryEnderChest</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getItemIcon(net.minecraft.item.ItemStack,%20int)">getItemIcon</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getItemInUse()">getItemInUse</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getItemInUseCount()">getItemInUseCount</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getItemInUseDuration()">getItemInUseDuration</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getLastActiveItems()">getLastActiveItems</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getMaxInPortalTime()">getMaxInPortalTime</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getPortalCooldown()">getPortalCooldown</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getPosition(float)">getPosition</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getScore()">getScore</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getSleepTimer()">getSleepTimer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getSplashSound()">getSplashSound</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getSwimSound()">getSwimSound</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getTeam()">getTeam</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getTotalArmorValue()">getTotalArmorValue</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getWorldScoreboard()">getWorldScoreboard</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#getYOffset()">getYOffset</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#handleHealthUpdate(byte)">handleHealthUpdate</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#interactWith(net.minecraft.entity.Entity)">interactWith</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isBlocking()">isBlocking</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isCurrentToolAdventureModeExempt(int,%20int,%20int)">isCurrentToolAdventureModeExempt</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isEntityInsideOpaqueBlock()">isEntityInsideOpaqueBlock</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isInvisibleToPlayer(net.minecraft.entity.player.EntityPlayer)">isInvisibleToPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isMovementBlocked()">isMovementBlocked</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isPlayer()">isPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isPlayerFullyAsleep()">isPlayerFullyAsleep</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isPlayerSleeping()">isPlayerSleeping</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isPushedByWater()">isPushedByWater</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isSpawnForced()">isSpawnForced</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isSpawnForced(int)">isSpawnForced</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#isUsingItem()">isUsingItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#joinEntityItemWithWorld(net.minecraft.entity.item.EntityItem)">joinEntityItemWithWorld</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#jump()">jump</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#moveEntityWithHeading(float,%20float)">moveEntityWithHeading</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#onKillEntity(net.minecraft.entity.EntityLivingBase)">onKillEntity</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#onLivingUpdate()">onLivingUpdate</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#playSound(java.lang.String,%20float,%20float)">playSound</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#preparePlayerToSpawn()">preparePlayerToSpawn</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#refreshDisplayName()">refreshDisplayName</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#respawnPlayer()">respawnPlayer</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setAbsorptionAmount(float)">setAbsorptionAmount</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setCurrentItemOrArmor(int,%20net.minecraft.item.ItemStack)">setCurrentItemOrArmor</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setDead()">setDead</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setHideCape(int,%20boolean)">setHideCape</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setInWeb()">setInWeb</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setScore(int)">setScore</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setSpawnChunk(net.minecraft.util.ChunkCoordinates,%20boolean)">setSpawnChunk</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#setSpawnChunk(net.minecraft.util.ChunkCoordinates,%20boolean,%20int)">setSpawnChunk</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#shouldHeal()">shouldHeal</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#stopUsingItem()">stopUsingItem</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#triggerAchievement(net.minecraft.stats.StatBase)">triggerAchievement</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#updateEntityActionState()">updateEntityActionState</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#updateItemUse(net.minecraft.item.ItemStack,%20int)">updateItemUse</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#updateRidden()">updateRidden</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#verifyRespawnCoordinates(net.minecraft.world.World,%20net.minecraft.util.ChunkCoordinates,%20boolean)">verifyRespawnCoordinates</a>, <a href="../../../../net/minecraft/entity/player/EntityPlayer.html#xpBarCap()">xpBarCap</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_net.minecraft.entity.EntityLivingBase"> +<!-- --> +</a> +<h3>Methods inherited from class net.minecraft.entity.<a href="../../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity">EntityLivingBase</a></h3> +<code><a href="../../../../net/minecraft/entity/EntityLivingBase.html#addPotionEffect(net.minecraft.potion.PotionEffect)">addPotionEffect</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#applyArmorCalculations(net.minecraft.util.DamageSource,%20float)">applyArmorCalculations</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#applyPotionDamageCalculations(net.minecraft.util.DamageSource,%20float)">applyPotionDamageCalculations</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#attackEntityAsMob(net.minecraft.entity.Entity)">attackEntityAsMob</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#canBeCollidedWith()">canBeCollidedWith</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#canBePushed()">canBePushed</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#canBreatheUnderwater()">canBreatheUnderwater</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#canEntityBeSeen(net.minecraft.entity.Entity)">canEntityBeSeen</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#clearActivePotions()">clearActivePotions</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#collideWithEntity(net.minecraft.entity.Entity)">collideWithEntity</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#collideWithNearbyEntities()">collideWithNearbyEntities</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#curePotionEffects(net.minecraft.item.ItemStack)">curePotionEffects</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#decreaseAirSupply(int)">decreaseAirSupply</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#dismountEntity(net.minecraft.entity.Entity)">dismountEntity</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#dropEquipment(boolean,%20int)">dropEquipment</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#dropFewItems(boolean,%20int)">dropFewItems</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#dropRareDrop(int)">dropRareDrop</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_110142_aN()">func_110142_aN</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_110146_f(float,%20float)">func_110146_f</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_142015_aE()">func_142015_aE</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_146066_aG()">func_146066_aG</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_152111_bt()">func_152111_bt</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_152112_bu()">func_152112_bu</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#func_94060_bK()">func_94060_bK</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getActivePotionEffect(net.minecraft.potion.Potion)">getActivePotionEffect</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getActivePotionEffects()">getActivePotionEffects</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getAge()">getAge</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getAITarget()">getAITarget</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getArrowCountInEntity()">getArrowCountInEntity</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getAttributeMap()">getAttributeMap</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getCreatureAttribute()">getCreatureAttribute</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getEntityAttribute(net.minecraft.entity.ai.attributes.IAttribute)">getEntityAttribute</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getHealth()">getHealth</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getLastAttacker()">getLastAttacker</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getLastAttackerTime()">getLastAttackerTime</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getLook(float)">getLook</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getLookVec()">getLookVec</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getMaxHealth()">getMaxHealth</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getRNG()">getRNG</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getRotationYawHead()">getRotationYawHead</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getSoundPitch()">getSoundPitch</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getSoundVolume()">getSoundVolume</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#getSwingProgress(float)">getSwingProgress</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#heal(float)">heal</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isAIEnabled()">isAIEnabled</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isChild()">isChild</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isClientWorld()">isClientWorld</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isEntityAlive()">isEntityAlive</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isEntityUndead()">isEntityUndead</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isOnLadder()">isOnLadder</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isOnSameTeam(net.minecraft.entity.EntityLivingBase)">isOnSameTeam</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isOnTeam(net.minecraft.scoreboard.Team)">isOnTeam</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isPotionActive(int)">isPotionActive</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isPotionActive(net.minecraft.potion.Potion)">isPotionActive</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#isPotionApplicable(net.minecraft.potion.PotionEffect)">isPotionApplicable</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#kill()">kill</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#knockBack(net.minecraft.entity.Entity,%20float,%20double,%20double)">knockBack</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#onDeathUpdate()">onDeathUpdate</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#onEntityUpdate()">onEntityUpdate</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#performHurtAnimation()">performHurtAnimation</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#rayTrace(double,%20float)">rayTrace</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#removePotionEffect(int)">removePotionEffect</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#removePotionEffectClient(int)">removePotionEffectClient</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#renderBrokenItemStack(net.minecraft.item.ItemStack)">renderBrokenItemStack</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setAIMoveSpeed(float)">setAIMoveSpeed</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setArrowCountInEntity(int)">setArrowCountInEntity</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setBeenAttacked()">setBeenAttacked</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setHealth(float)">setHealth</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setJumping(boolean)">setJumping</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setLastAttacker(net.minecraft.entity.Entity)">setLastAttacker</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setPositionAndRotation2(double,%20double,%20double,%20float,%20float,%20int)">setPositionAndRotation2</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setRevengeTarget(net.minecraft.entity.EntityLivingBase)">setRevengeTarget</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setRotationYawHead(float)">setRotationYawHead</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#setSprinting(boolean)">setSprinting</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#shouldRiderFaceForward(net.minecraft.entity.player.EntityPlayer)">shouldRiderFaceForward</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#swingItem()">swingItem</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#updateAITasks()">updateAITasks</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#updateAITick()">updateAITick</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#updateArmSwingProgress()">updateArmSwingProgress</a>, <a href="../../../../net/minecraft/entity/EntityLivingBase.html#updatePotionEffects()">updatePotionEffects</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_net.minecraft.entity.Entity"> +<!-- --> +</a> +<h3>Methods inherited from class net.minecraft.entity.<a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a></h3> +<code><a href="../../../../net/minecraft/entity/Entity.html#addEntityCrashInfo(net.minecraft.crash.CrashReportCategory)">addEntityCrashInfo</a>, <a href="../../../../net/minecraft/entity/Entity.html#addVelocity(double,%20double,%20double)">addVelocity</a>, <a href="../../../../net/minecraft/entity/Entity.html#applyEntityCollision(net.minecraft.entity.Entity)">applyEntityCollision</a>, <a href="../../../../net/minecraft/entity/Entity.html#canAttackWithItem()">canAttackWithItem</a>, <a href="../../../../net/minecraft/entity/Entity.html#canRenderOnFire()">canRenderOnFire</a>, <a href="../../../../net/minecraft/entity/Entity.html#canRiderInteract()">canRiderInteract</a>, <a href="../../../../net/minecraft/entity/Entity.html#copyDataFrom(net.minecraft.entity.Entity,%20boolean)">copyDataFrom</a>, <a href="../../../../net/minecraft/entity/Entity.html#copyLocationAndAnglesFrom(net.minecraft.entity.Entity)">copyLocationAndAnglesFrom</a>, <a href="../../../../net/minecraft/entity/Entity.html#dealFireDamage(int)">dealFireDamage</a>, <a href="../../../../net/minecraft/entity/Entity.html#doesEntityNotTriggerPressurePlate()">doesEntityNotTriggerPressurePlate</a>, <a href="../../../../net/minecraft/entity/Entity.html#dropItem(net.minecraft.item.Item,%20int)">dropItem</a>, <a href="../../../../net/minecraft/entity/Entity.html#entityDropItem(net.minecraft.item.ItemStack,%20float)">entityDropItem</a>, <a href="../../../../net/minecraft/entity/Entity.html#equals(java.lang.Object)">equals</a>, <a href="../../../../net/minecraft/entity/Entity.html#extinguish()">extinguish</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145771_j(double,%20double,%20double)">func_145771_j</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145772_a(net.minecraft.world.Explosion,%20net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraft.block.Block)">func_145772_a</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145774_a(net.minecraft.world.Explosion,%20net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraft.block.Block,%20float)">func_145774_a</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145775_I()">func_145775_I</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145778_a(net.minecraft.item.Item,%20int,%20float)">func_145778_a</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145780_a(int,%20int,%20int,%20net.minecraft.block.Block)">func_145780_a</a>, <a href="../../../../net/minecraft/entity/Entity.html#func_145781_i(int)">func_145781_i</a>, <a href="../../../../net/minecraft/entity/Entity.html#getAir()">getAir</a>, <a href="../../../../net/minecraft/entity/Entity.html#getBoundingBox()">getBoundingBox</a>, <a href="../../../../net/minecraft/entity/Entity.html#getBrightness(float)">getBrightness</a>, <a href="../../../../net/minecraft/entity/Entity.html#getBrightnessForRender(float)">getBrightnessForRender</a>, <a href="../../../../net/minecraft/entity/Entity.html#getCollisionBorderSize()">getCollisionBorderSize</a>, <a href="../../../../net/minecraft/entity/Entity.html#getCollisionBox(net.minecraft.entity.Entity)">getCollisionBox</a>, <a href="../../../../net/minecraft/entity/Entity.html#getDataWatcher()">getDataWatcher</a>, <a href="../../../../net/minecraft/entity/Entity.html#getDistance(double,%20double,%20double)">getDistance</a>, <a href="../../../../net/minecraft/entity/Entity.html#getDistanceSq(double,%20double,%20double)">getDistanceSq</a>, <a href="../../../../net/minecraft/entity/Entity.html#getDistanceSqToEntity(net.minecraft.entity.Entity)">getDistanceSqToEntity</a>, <a href="../../../../net/minecraft/entity/Entity.html#getDistanceToEntity(net.minecraft.entity.Entity)">getDistanceToEntity</a>, <a href="../../../../net/minecraft/entity/Entity.html#getEntityData()">getEntityData</a>, <a href="../../../../net/minecraft/entity/Entity.html#getEntityId()">getEntityId</a>, <a href="../../../../net/minecraft/entity/Entity.html#getEntityString()">getEntityString</a>, <a href="../../../../net/minecraft/entity/Entity.html#getExtendedProperties(java.lang.String)">getExtendedProperties</a>, <a href="../../../../net/minecraft/entity/Entity.html#getFlag(int)">getFlag</a>, <a href="../../../../net/minecraft/entity/Entity.html#getMaxSafePointTries()">getMaxSafePointTries</a>, <a href="../../../../net/minecraft/entity/Entity.html#getMountedYOffset()">getMountedYOffset</a>, <a href="../../../../net/minecraft/entity/Entity.html#getParts()">getParts</a>, <a href="../../../../net/minecraft/entity/Entity.html#getPersistentID()">getPersistentID</a>, <a href="../../../../net/minecraft/entity/Entity.html#getPickedResult(net.minecraft.util.MovingObjectPosition)">getPickedResult</a>, <a href="../../../../net/minecraft/entity/Entity.html#getShadowSize()">getShadowSize</a>, <a href="../../../../net/minecraft/entity/Entity.html#getTeleportDirection()">getTeleportDirection</a>, <a href="../../../../net/minecraft/entity/Entity.html#getUniqueID()">getUniqueID</a>, <a href="../../../../net/minecraft/entity/Entity.html#handleLavaMovement()">handleLavaMovement</a>, <a href="../../../../net/minecraft/entity/Entity.html#handleWaterMovement()">handleWaterMovement</a>, <a href="../../../../net/minecraft/entity/Entity.html#hashCode()">hashCode</a>, <a href="../../../../net/minecraft/entity/Entity.html#hitByEntity(net.minecraft.entity.Entity)">hitByEntity</a>, <a href="../../../../net/minecraft/entity/Entity.html#interactFirst(net.minecraft.entity.player.EntityPlayer)">interactFirst</a>, <a href="../../../../net/minecraft/entity/Entity.html#isBurning()">isBurning</a>, <a href="../../../../net/minecraft/entity/Entity.html#isCreatureType(net.minecraft.entity.EnumCreatureType,%20boolean)">isCreatureType</a>, <a href="../../../../net/minecraft/entity/Entity.html#isEating()">isEating</a>, <a href="../../../../net/minecraft/entity/Entity.html#isEntityEqual(net.minecraft.entity.Entity)">isEntityEqual</a>, <a href="../../../../net/minecraft/entity/Entity.html#isImmuneToFire()">isImmuneToFire</a>, <a href="../../../../net/minecraft/entity/Entity.html#isInRangeToRender3d(double,%20double,%20double)">isInRangeToRender3d</a>, <a href="../../../../net/minecraft/entity/Entity.html#isInRangeToRenderDist(double)">isInRangeToRenderDist</a>, <a href="../../../../net/minecraft/entity/Entity.html#isInsideOfMaterial(net.minecraft.block.material.Material)">isInsideOfMaterial</a>, <a href="../../../../net/minecraft/entity/Entity.html#isInvisible()">isInvisible</a>, <a href="../../../../net/minecraft/entity/Entity.html#isInWater()">isInWater</a>, <a href="../../../../net/minecraft/entity/Entity.html#isOffsetPositionInLiquid(double,%20double,%20double)">isOffsetPositionInLiquid</a>, <a href="../../../../net/minecraft/entity/Entity.html#isRiding()">isRiding</a>, <a href="../../../../net/minecraft/entity/Entity.html#isSneaking()">isSneaking</a>, <a href="../../../../net/minecraft/entity/Entity.html#isSprinting()">isSprinting</a>, <a href="../../../../net/minecraft/entity/Entity.html#isWet()">isWet</a>, <a href="../../../../net/minecraft/entity/Entity.html#moveEntity(double,%20double,%20double)">moveEntity</a>, <a href="../../../../net/minecraft/entity/Entity.html#moveFlying(float,%20float,%20float)">moveFlying</a>, <a href="../../../../net/minecraft/entity/Entity.html#newDoubleNBTList(double...)">newDoubleNBTList</a>, <a href="../../../../net/minecraft/entity/Entity.html#newFloatNBTList(float...)">newFloatNBTList</a>, <a href="../../../../net/minecraft/entity/Entity.html#onChunkLoad()">onChunkLoad</a>, <a href="../../../../net/minecraft/entity/Entity.html#onCollideWithPlayer(net.minecraft.entity.player.EntityPlayer)">onCollideWithPlayer</a>, <a href="../../../../net/minecraft/entity/Entity.html#onStruckByLightning(net.minecraft.entity.effect.EntityLightningBolt)">onStruckByLightning</a>, <a href="../../../../net/minecraft/entity/Entity.html#readFromNBT(net.minecraft.nbt.NBTTagCompound)">readFromNBT</a>, <a href="../../../../net/minecraft/entity/Entity.html#registerExtendedProperties(java.lang.String,%20net.minecraftforge.common.IExtendedEntityProperties)">registerExtendedProperties</a>, <a href="../../../../net/minecraft/entity/Entity.html#resetEntityId()">resetEntityId</a>, <a href="../../../../net/minecraft/entity/Entity.html#setAir(int)">setAir</a>, <a href="../../../../net/minecraft/entity/Entity.html#setAngles(float,%20float)">setAngles</a>, <a href="../../../../net/minecraft/entity/Entity.html#setEating(boolean)">setEating</a>, <a href="../../../../net/minecraft/entity/Entity.html#setEntityId(int)">setEntityId</a>, <a href="../../../../net/minecraft/entity/Entity.html#setFire(int)">setFire</a>, <a href="../../../../net/minecraft/entity/Entity.html#setFlag(int,%20boolean)">setFlag</a>, <a href="../../../../net/minecraft/entity/Entity.html#setInPortal()">setInPortal</a>, <a href="../../../../net/minecraft/entity/Entity.html#setInvisible(boolean)">setInvisible</a>, <a href="../../../../net/minecraft/entity/Entity.html#setLocationAndAngles(double,%20double,%20double,%20float,%20float)">setLocationAndAngles</a>, <a href="../../../../net/minecraft/entity/Entity.html#setOnFireFromLava()">setOnFireFromLava</a>, <a href="../../../../net/minecraft/entity/Entity.html#setPosition(double,%20double,%20double)">setPosition</a>, <a href="../../../../net/minecraft/entity/Entity.html#setPositionAndRotation(double,%20double,%20double,%20float,%20float)">setPositionAndRotation</a>, <a href="../../../../net/minecraft/entity/Entity.html#setRotation(float,%20float)">setRotation</a>, <a href="../../../../net/minecraft/entity/Entity.html#setSize(float,%20float)">setSize</a>, <a href="../../../../net/minecraft/entity/Entity.html#setSneaking(boolean)">setSneaking</a>, <a href="../../../../net/minecraft/entity/Entity.html#setVelocity(double,%20double,%20double)">setVelocity</a>, <a href="../../../../net/minecraft/entity/Entity.html#setWorld(net.minecraft.world.World)">setWorld</a>, <a href="../../../../net/minecraft/entity/Entity.html#shouldDismountInWater(net.minecraft.entity.Entity)">shouldDismountInWater</a>, <a href="../../../../net/minecraft/entity/Entity.html#shouldRenderInPass(int)">shouldRenderInPass</a>, <a href="../../../../net/minecraft/entity/Entity.html#shouldRiderSit()">shouldRiderSit</a>, <a href="../../../../net/minecraft/entity/Entity.html#shouldSetPosAfterLoading()">shouldSetPosAfterLoading</a>, <a href="../../../../net/minecraft/entity/Entity.html#toString()">toString</a>, <a href="../../../../net/minecraft/entity/Entity.html#updateRiderPosition()">updateRiderPosition</a>, <a href="../../../../net/minecraft/entity/Entity.html#writeMountToNBT(net.minecraft.nbt.NBTTagCompound)">writeMountToNBT</a>, <a href="../../../../net/minecraft/entity/Entity.html#writeToNBT(net.minecraft.nbt.NBTTagCompound)">writeToNBT</a>, <a href="../../../../net/minecraft/entity/Entity.html#writeToNBTOptional(net.minecraft.nbt.NBTTagCompound)">writeToNBTOptional</a></code></li> +</ul> +<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, finalize, getClass, notify, notifyAll, 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="FakePlayer(net.minecraft.world.WorldServer, com.mojang.authlib.GameProfile)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FakePlayer</h4> +<pre>public FakePlayer(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world, + com.mojang.authlib.GameProfile name)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="canCommandSenderUseCommand(int, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canCommandSenderUseCommand</h4> +<pre>public boolean canCommandSenderUseCommand(int i, + java.lang.String s)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../net/minecraft/command/ICommandSender.html#canCommandSenderUseCommand(int,%20java.lang.String)">canCommandSenderUseCommand</a></code> in interface <code><a href="../../../../net/minecraft/command/ICommandSender.html" title="interface in net.minecraft.command">ICommandSender</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#canCommandSenderUseCommand(int,%20java.lang.String)">canCommandSenderUseCommand</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="getPlayerCoordinates()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPlayerCoordinates</h4> +<pre>public <a href="../../../../net/minecraft/util/ChunkCoordinates.html" title="class in net.minecraft.util">ChunkCoordinates</a> getPlayerCoordinates()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../net/minecraft/command/ICommandSender.html#getPlayerCoordinates()">getPlayerCoordinates</a></code> in interface <code><a href="../../../../net/minecraft/command/ICommandSender.html" title="interface in net.minecraft.command">ICommandSender</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#getPlayerCoordinates()">getPlayerCoordinates</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="addChatComponentMessage(net.minecraft.util.IChatComponent)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addChatComponentMessage</h4> +<pre>public void addChatComponentMessage(<a href="../../../../net/minecraft/util/IChatComponent.html" title="interface in net.minecraft.util">IChatComponent</a> chatmessagecomponent)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#addChatComponentMessage(net.minecraft.util.IChatComponent)">addChatComponentMessage</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="addStat(net.minecraft.stats.StatBase, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addStat</h4> +<pre>public void addStat(<a href="../../../../net/minecraft/stats/StatBase.html" title="class in net.minecraft.stats">StatBase</a> par1StatBase, + int par2)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#addStat(net.minecraft.stats.StatBase,%20int)">addStat</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="openGui(java.lang.Object, int, net.minecraft.world.World, int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openGui</h4> +<pre>public void openGui(java.lang.Object mod, + int modGuiId, + <a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> world, + int x, + int y, + int z)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayer.html#openGui(java.lang.Object,%20int,%20net.minecraft.world.World,%20int,%20int,%20int)">openGui</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a></code></dd> +</dl> +</li> +</ul> +<a name="isEntityInvulnerable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEntityInvulnerable</h4> +<pre>public boolean isEntityInvulnerable()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/Entity.html#isEntityInvulnerable()">isEntityInvulnerable</a></code> in class <code><a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity">Entity</a></code></dd> +</dl> +</li> +</ul> +<a name="canAttackPlayer(net.minecraft.entity.player.EntityPlayer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canAttackPlayer</h4> +<pre>public boolean canAttackPlayer(<a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player">EntityPlayer</a> player)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#canAttackPlayer(net.minecraft.entity.player.EntityPlayer)">canAttackPlayer</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="onDeath(net.minecraft.util.DamageSource)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onDeath</h4> +<pre>public void onDeath(<a href="../../../../net/minecraft/util/DamageSource.html" title="class in net.minecraft.util">DamageSource</a> source)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onDeath(net.minecraft.util.DamageSource)">onDeath</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="onUpdate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onUpdate</h4> +<pre>public void onUpdate()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#onUpdate()">onUpdate</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="travelToDimension(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>travelToDimension</h4> +<pre>public void travelToDimension(int dim)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#travelToDimension(int)">travelToDimension</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></code></dd> +</dl> +</li> +</ul> +<a name="func_147100_a(net.minecraft.network.play.client.C15PacketClientSettings)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>func_147100_a</h4> +<pre>public void func_147100_a(<a href="../../../../net/minecraft/network/play/client/C15PacketClientSettings.html" title="class in net.minecraft.network.play.client">C15PacketClientSettings</a> pkt)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html#func_147100_a(net.minecraft.network.play.client.C15PacketClientSettings)">func_147100_a</a></code> in class <code><a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player">EntityPlayerMP</a></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="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/util/EnumHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/FakePlayerFactory.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/FakePlayer.html" target="_top">Frames</a></li> +<li><a href="FakePlayer.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_classes_inherited_from_class_net.minecraft.entity.player.EntityPlayer">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_net.minecraft.entity.player.EntityPlayerMP">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>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> diff --git a/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html b/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html new file mode 100644 index 0000000..aa30560 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html @@ -0,0 +1,289 @@ +<!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:20 EST 2015 --> +<title>FakePlayerFactory (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="FakePlayerFactory (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/util/FakePlayer.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/FakePlayerFactory.html" target="_top">Frames</a></li> +<li><a href="FakePlayerFactory.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><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.util</div> +<h2 title="Class FakePlayerFactory" class="title">Class FakePlayerFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.FakePlayerFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">FakePlayerFactory</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/FakePlayerFactory.html#FakePlayerFactory()">FakePlayerFactory</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 <a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util">FakePlayer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayerFactory.html#get(net.minecraft.world.WorldServer,%20com.mojang.authlib.GameProfile)">get</a></strong>(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world, + com.mojang.authlib.GameProfile username)</code> +<div class="block">Get a fake player with a given username, + Mods should either hold weak references to the return value, or listen for a + WorldEvent.Unload and kill all references to prevent worlds staying in memory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util">FakePlayer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/FakePlayerFactory.html#getMinecraft(net.minecraft.world.WorldServer)">getMinecraft</a></strong>(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</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/util/FakePlayerFactory.html#unloadWorld(net.minecraft.world.WorldServer)">unloadWorld</a></strong>(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world)</code> </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="FakePlayerFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FakePlayerFactory</h4> +<pre>public FakePlayerFactory()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getMinecraft(net.minecraft.world.WorldServer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinecraft</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util">FakePlayer</a> getMinecraft(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world)</pre> +</li> +</ul> +<a name="get(net.minecraft.world.WorldServer, com.mojang.authlib.GameProfile)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util">FakePlayer</a> get(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world, + com.mojang.authlib.GameProfile username)</pre> +<div class="block">Get a fake player with a given username, + Mods should either hold weak references to the return value, or listen for a + WorldEvent.Unload and kill all references to prevent worlds staying in memory.</div> +</li> +</ul> +<a name="unloadWorld(net.minecraft.world.WorldServer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>unloadWorld</h4> +<pre>public static void unloadWorld(<a href="../../../../net/minecraft/world/WorldServer.html" title="class in net.minecraft.world">WorldServer</a> world)</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/util/FakePlayer.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/FakePlayerFactory.html" target="_top">Frames</a></li> +<li><a href="FakePlayerFactory.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><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> diff --git a/javadoc/net/minecraftforge/common/util/ForgeDirection.html b/javadoc/net/minecraftforge/common/util/ForgeDirection.html new file mode 100644 index 0000000..80c84b4 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/ForgeDirection.html @@ -0,0 +1,551 @@ +<!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:20 EST 2015 --> +<title>ForgeDirection (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="ForgeDirection (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/util/FakePlayerFactory.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/RotationHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/ForgeDirection.html" target="_top">Frames</a></li> +<li><a href="ForgeDirection.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="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li><a href="#field_detail">Field</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.util</div> +<h2 title="Enum ForgeDirection" class="title">Enum ForgeDirection</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>></li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.ForgeDirection</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">ForgeDirection</span> +extends java.lang.Enum<<a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#DOWN">DOWN</a></strong></code> +<div class="block">-Y</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#EAST">EAST</a></strong></code> +<div class="block">+X</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#NORTH">NORTH</a></strong></code> +<div class="block">-Z</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#SOUTH">SOUTH</a></strong></code> +<div class="block">+Z</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#UNKNOWN">UNKNOWN</a></strong></code> +<div class="block">Used only by getOrientation, for invalid inputs</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#UP">UP</a></strong></code> +<div class="block">+Y</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#WEST">WEST</a></strong></code> +<div class="block">-X</div> +</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#flag">flag</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#offsetX">offsetX</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#offsetY">offsetY</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#offsetZ">offsetZ</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/util/ForgeDirection.html#OPPOSITES">OPPOSITES</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#ROTATION_MATRIX">ROTATION_MATRIX</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#VALID_DIRECTIONS">VALID_DIRECTIONS</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><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#getOpposite()">getOpposite</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#getOrientation(int)">getOrientation</a></strong>(int id)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#getRotation(net.minecraftforge.common.util.ForgeDirection)">getRotation</a></strong>(<a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> axis)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<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>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="DOWN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DOWN</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> DOWN</pre> +<div class="block">-Y</div> +</li> +</ul> +<a name="UP"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UP</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> UP</pre> +<div class="block">+Y</div> +</li> +</ul> +<a name="NORTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NORTH</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> NORTH</pre> +<div class="block">-Z</div> +</li> +</ul> +<a name="SOUTH"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SOUTH</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> SOUTH</pre> +<div class="block">+Z</div> +</li> +</ul> +<a name="WEST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WEST</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> WEST</pre> +<div class="block">-X</div> +</li> +</ul> +<a name="EAST"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EAST</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> EAST</pre> +<div class="block">+X</div> +</li> +</ul> +<a name="UNKNOWN"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNKNOWN</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> UNKNOWN</pre> +<div class="block">Used only by getOrientation, for invalid inputs</div> +</li> +</ul> +</li> +</ul> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="offsetX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offsetX</h4> +<pre>public final int offsetX</pre> +</li> +</ul> +<a name="offsetY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offsetY</h4> +<pre>public final int offsetY</pre> +</li> +</ul> +<a name="offsetZ"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offsetZ</h4> +<pre>public final int offsetZ</pre> +</li> +</ul> +<a name="flag"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>flag</h4> +<pre>public final int flag</pre> +</li> +</ul> +<a name="VALID_DIRECTIONS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALID_DIRECTIONS</h4> +<pre>public static final <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>[] VALID_DIRECTIONS</pre> +</li> +</ul> +<a name="OPPOSITES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OPPOSITES</h4> +<pre>public static final int[] OPPOSITES</pre> +</li> +</ul> +<a name="ROTATION_MATRIX"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ROTATION_MATRIX</h4> +<pre>public static final int[][] ROTATION_MATRIX</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ForgeDirection c : ForgeDirection.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="getOrientation(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrientation</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> getOrientation(int id)</pre> +</li> +</ul> +<a name="getOpposite()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOpposite</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> getOpposite()</pre> +</li> +</ul> +<a name="getRotation(net.minecraftforge.common.util.ForgeDirection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getRotation</h4> +<pre>public <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> getRotation(<a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> axis)</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/util/FakePlayerFactory.html" title="class in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/util/RotationHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/ForgeDirection.html" target="_top">Frames</a></li> +<li><a href="ForgeDirection.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="#enum_constant_summary">Enum Constants</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li><a href="#field_detail">Field</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> diff --git a/javadoc/net/minecraftforge/common/util/RotationHelper.html b/javadoc/net/minecraftforge/common/util/RotationHelper.html new file mode 100644 index 0000000..2676874 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/RotationHelper.html @@ -0,0 +1,279 @@ +<!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:20 EST 2015 --> +<title>RotationHelper (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="RotationHelper (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/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/RotationHelper.html" target="_top">Frames</a></li> +<li><a href="RotationHelper.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><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.util</div> +<h2 title="Class RotationHelper" class="title">Class RotationHelper</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.util.RotationHelper</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">RotationHelper</span> +extends java.lang.Object</pre> +<div class="block">This class is a helper function for vanilla blocks, and should not be called by Modders. + Refer to block.rotateBlock and block.getValidRotations instead.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/util/RotationHelper.html#RotationHelper()">RotationHelper</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 <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/RotationHelper.html#getValidVanillaBlockRotations(net.minecraft.block.Block)">getValidVanillaBlockRotations</a></strong>(<a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/util/RotationHelper.html#rotateVanillaBlock(net.minecraft.block.Block,%20net.minecraft.world.World,%20int,%20int,%20int,%20net.minecraftforge.common.util.ForgeDirection)">rotateVanillaBlock</a></strong>(<a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> worldObj, + int x, + int y, + int z, + <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> axis)</code> </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="RotationHelper()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RotationHelper</h4> +<pre>public RotationHelper()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getValidVanillaBlockRotations(net.minecraft.block.Block)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidVanillaBlockRotations</h4> +<pre>public static <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a>[] getValidVanillaBlockRotations(<a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block)</pre> +</li> +</ul> +<a name="rotateVanillaBlock(net.minecraft.block.Block, net.minecraft.world.World, int, int, int, net.minecraftforge.common.util.ForgeDirection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>rotateVanillaBlock</h4> +<pre>public static boolean rotateVanillaBlock(<a href="../../../../net/minecraft/block/Block.html" title="class in net.minecraft.block">Block</a> block, + <a href="../../../../net/minecraft/world/World.html" title="class in net.minecraft.world">World</a> worldObj, + int x, + int y, + int z, + <a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a> axis)</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/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/RotationHelper.html" target="_top">Frames</a></li> +<li><a href="RotationHelper.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><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> diff --git a/javadoc/net/minecraftforge/common/util/package-frame.html b/javadoc/net/minecraftforge/common/util/package-frame.html new file mode 100644 index 0000000..02ed6d9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/package-frame.html @@ -0,0 +1,35 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.util (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../net/minecraftforge/common/util/package-summary.html" target="classFrame">net.minecraftforge.common.util</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util" target="classFrame"><i>AsynchronousExecutor.CallBackProvider</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="AsynchronousExecutor.html" title="class in net.minecraftforge.common.util" target="classFrame">AsynchronousExecutor</a></li> +<li><a href="BlockSnapshot.html" title="class in net.minecraftforge.common.util" target="classFrame">BlockSnapshot</a></li> +<li><a href="ChunkCoordComparator.html" title="class in net.minecraftforge.common.util" target="classFrame">ChunkCoordComparator</a></li> +<li><a href="Constants.html" title="class in net.minecraftforge.common.util" target="classFrame">Constants</a></li> +<li><a href="Constants.NBT.html" title="class in net.minecraftforge.common.util" target="classFrame">Constants.NBT</a></li> +<li><a href="EnumHelper.html" title="class in net.minecraftforge.common.util" target="classFrame">EnumHelper</a></li> +<li><a href="FakePlayer.html" title="class in net.minecraftforge.common.util" target="classFrame">FakePlayer</a></li> +<li><a href="FakePlayerFactory.html" title="class in net.minecraftforge.common.util" target="classFrame">FakePlayerFactory</a></li> +<li><a href="RotationHelper.html" title="class in net.minecraftforge.common.util" target="classFrame">RotationHelper</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="ForgeDirection.html" title="enum in net.minecraftforge.common.util" target="classFrame">ForgeDirection</a></li> +</ul> +</div> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/util/package-summary.html b/javadoc/net/minecraftforge/common/util/package-summary.html new file mode 100644 index 0000000..4f8ebac --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/package-summary.html @@ -0,0 +1,207 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.util (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="net.minecraftforge.common.util (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 class="navBarCell1Rev">Package</li> +<li>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/network/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/event/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package net.minecraftforge.common.util</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util">AsynchronousExecutor.CallBackProvider</a><P,T,C,E extends java.lang.Throwable></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="class in net.minecraftforge.common.util">AsynchronousExecutor</a><P,T,C,E extends java.lang.Throwable></td> +<td class="colLast"> +<div class="block">Executes tasks using a multi-stage process executor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util">BlockSnapshot</a></td> +<td class="colLast"> +<div class="block">Represents a captured snapshot of a block which will not change + automatically.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/ChunkCoordComparator.html" title="class in net.minecraftforge.common.util">ChunkCoordComparator</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/Constants.html" title="class in net.minecraftforge.common.util">Constants</a></td> +<td class="colLast"> +<div class="block">A class containing constants for magic numbers used in the minecraft codebase.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/Constants.NBT.html" title="class in net.minecraftforge.common.util">Constants.NBT</a></td> +<td class="colLast"> +<div class="block">NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, + table used in NBTBase.func_150283_g + + Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/EnumHelper.html" title="class in net.minecraftforge.common.util">EnumHelper</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util">FakePlayer</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/FakePlayerFactory.html" title="class in net.minecraftforge.common.util">FakePlayerFactory</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/RotationHelper.html" title="class in net.minecraftforge.common.util">RotationHelper</a></td> +<td class="colLast"> +<div class="block">This class is a helper function for vanilla blocks, and should not be called by Modders.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util">ForgeDirection</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/network/package-summary.html">Prev Package</a></li> +<li><a href="../../../../net/minecraftforge/event/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> diff --git a/javadoc/net/minecraftforge/common/util/package-tree.html b/javadoc/net/minecraftforge/common/util/package-tree.html new file mode 100644 index 0000000..a714776 --- /dev/null +++ b/javadoc/net/minecraftforge/common/util/package-tree.html @@ -0,0 +1,170 @@ +<!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:25 EST 2015 --> +<title>net.minecraftforge.common.util Class Hierarchy (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="net.minecraftforge.common.util Class Hierarchy (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</li> +<li class="navBarCell1Rev">Tree</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/network/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/event/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package net.minecraftforge.common.util</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.html" title="class in net.minecraftforge.common.util"><span class="strong">AsynchronousExecutor</span></a><P,T,C,E></li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/BlockSnapshot.html" title="class in net.minecraftforge.common.util"><span class="strong">BlockSnapshot</span></a> (implements java.io.Serializable)</li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/ChunkCoordComparator.html" title="class in net.minecraftforge.common.util"><span class="strong">ChunkCoordComparator</span></a> (implements java.util.Comparator<T>)</li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/Constants.html" title="class in net.minecraftforge.common.util"><span class="strong">Constants</span></a></li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/Constants.NBT.html" title="class in net.minecraftforge.common.util"><span class="strong">Constants.NBT</span></a></li> +<li type="circle">net.minecraft.entity.<a href="../../../../net/minecraft/entity/Entity.html" title="class in net.minecraft.entity"><span class="strong">Entity</span></a> +<ul> +<li type="circle">net.minecraft.entity.<a href="../../../../net/minecraft/entity/EntityLivingBase.html" title="class in net.minecraft.entity"><span class="strong">EntityLivingBase</span></a> +<ul> +<li type="circle">net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayer.html" title="class in net.minecraft.entity.player"><span class="strong">EntityPlayer</span></a> (implements net.minecraft.command.<a href="../../../../net/minecraft/command/ICommandSender.html" title="interface in net.minecraft.command">ICommandSender</a>) +<ul> +<li type="circle">net.minecraft.entity.player.<a href="../../../../net/minecraft/entity/player/EntityPlayerMP.html" title="class in net.minecraft.entity.player"><span class="strong">EntityPlayerMP</span></a> (implements net.minecraft.inventory.<a href="../../../../net/minecraft/inventory/ICrafting.html" title="interface in net.minecraft.inventory">ICrafting</a>) +<ul> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/FakePlayer.html" title="class in net.minecraftforge.common.util"><span class="strong">FakePlayer</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/EnumHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">EnumHelper</span></a></li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/FakePlayerFactory.html" title="class in net.minecraftforge.common.util"><span class="strong">FakePlayerFactory</span></a></li> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/RotationHelper.html" title="class in net.minecraftforge.common.util"><span class="strong">RotationHelper</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">java.util.concurrent.ThreadFactory +<ul> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html" title="interface in net.minecraftforge.common.util"><span class="strong">AsynchronousExecutor.CallBackProvider</span></a><P,T,C,E></li> +</ul> +</li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">net.minecraftforge.common.util.<a href="../../../../net/minecraftforge/common/util/ForgeDirection.html" title="enum in net.minecraftforge.common.util"><span class="strong">ForgeDirection</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/network/package-tree.html">Prev</a></li> +<li><a href="../../../../net/minecraftforge/event/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/util/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |