diff options
| author | Foghrye4 <foghrye4@gmail.com> | 2017-08-10 18:52:45 +0300 |
|---|---|---|
| committer | Foghrye4 <foghrye4@gmail.com> | 2017-08-10 18:52:45 +0300 |
| commit | 0427ab89f1753a44b30cbc35ce021cbbdc845109 (patch) | |
| tree | abe418ff5ec174e712fe8dedd434548a945b15a3 /javadoc/net/minecraftforge/common/config | |
| parent | 877312184c472d9845e5ef1008bc538f4634059f (diff) | |
fix missing source folder
Diffstat (limited to 'javadoc/net/minecraftforge/common/config')
9 files changed, 6644 insertions, 0 deletions
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> |