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/Configuration.html | |
| parent | 877312184c472d9845e5ef1008bc538f4634059f (diff) | |
fix missing source folder
Diffstat (limited to 'javadoc/net/minecraftforge/common/config/Configuration.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/config/Configuration.html | 1988 |
1 files changed, 1988 insertions, 0 deletions
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> |