diff options
Diffstat (limited to 'javadoc/net/minecraftforge/common/config/Property.html')
| -rw-r--r-- | javadoc/net/minecraftforge/common/config/Property.html | 1733 |
1 files changed, 1733 insertions, 0 deletions
diff --git a/javadoc/net/minecraftforge/common/config/Property.html b/javadoc/net/minecraftforge/common/config/Property.html new file mode 100644 index 0000000..3c842c9 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Property.html @@ -0,0 +1,1733 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_65) on Thu Feb 05 20:10:11 EST 2015 --> +<title>Property (Forge API)</title> +<meta name="date" content="2015-02-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Property (Forge API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Property.html" target="_top">Frames</a></li> +<li><a href="Property.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">net.minecraftforge.common.config</div> +<h2 title="Class Property" class="title">Class Property</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>net.minecraftforge.common.config.Property</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">Property</span> +extends java.lang.Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#comment">comment</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String[],%20net.minecraftforge.common.config.Property.Type)">Property</a></strong>(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String[],%20net.minecraftforge.common.config.Property.Type,%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20boolean)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20boolean,%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read, + java.lang.String langKey)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20java.lang.String[])">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#Property(java.lang.String,%20java.lang.String,%20net.minecraftforge.common.config.Property.Type,%20java.lang.String[],%20java.lang.String)">Property</a></strong>(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues, + java.lang.String langKey)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getArrayEntryClass()">getArrayEntryClass</a></strong>()</code> +<div class="block">Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getBoolean()">getBoolean</a></strong>()</code> +<div class="block">Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getBoolean(boolean)">getBoolean</a></strong>(boolean _default)</code> +<div class="block">Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getBooleanList()">getBooleanList</a></strong>()</code> +<div class="block">Returns the boolean value of all values that can + be parsed in the list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getConfigEntryClass()">getConfigEntryClass</a></strong>()</code> +<div class="block">Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDefault()">getDefault</a></strong>()</code> +<div class="block">Gets the raw String default value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDefaults()">getDefaults</a></strong>()</code> +<div class="block">Gets the raw String[] default values of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDouble()">getDouble</a></strong>()</code> +<div class="block">Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDouble(double)">getDouble</a></strong>(double _default)</code> +<div class="block">Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getDoubleList()">getDoubleList</a></strong>()</code> +<div class="block">Returns the double value of all values that can + be parsed in the list.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getInt()">getInt</a></strong>()</code> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getInt(int)">getInt</a></strong>(int _default)</code> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getIntList()">getIntList</a></strong>()</code> +<div class="block">Returns the integer value of all values that can + be parsed in the list.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getLanguageKey()">getLanguageKey</a></strong>()</code> +<div class="block">Gets the language key string for this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getMaxListLength()">getMaxListLength</a></strong>()</code> +<div class="block">Gets the maximum length of this list/array Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getMaxValue()">getMaxValue</a></strong>()</code> +<div class="block">Gets the maximum value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getMinValue()">getMinValue</a></strong>()</code> +<div class="block">Gets the minimum value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getName()">getName</a></strong>()</code> +<div class="block">Gets the name/key for this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getString()">getString</a></strong>()</code> +<div class="block">Returns the value in this property as it's raw string.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getStringList()">getStringList</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getType()">getType</a></strong>()</code> +<div class="block">Gets the Property.Type enum value for this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.regex.Pattern</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getValidationPattern()">getValidationPattern</a></strong>()</code> +<div class="block">Gets the Pattern object used to validate user input for this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#getValidValues()">getValidValues</a></strong>()</code> +<div class="block">Gets the array of valid values that this String Property can be set to, or null if not defined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#hasChanged()">hasChanged</a></strong>()</code> +<div class="block">Gets the changed status of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isBooleanList()">isBooleanList</a></strong>()</code> +<div class="block">Checks if all of current values stored in this property can be converted to a boolean.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isBooleanValue()">isBooleanValue</a></strong>()</code> +<div class="block">Checks if the current value held by this property is a valid boolean value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isDefault()">isDefault</a></strong>()</code> +<div class="block">Returns whether or not this Property is defaulted.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isDoubleList()">isDoubleList</a></strong>()</code> +<div class="block">Checks if all of the current values stored in this property can be converted to a double.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isDoubleValue()">isDoubleValue</a></strong>()</code> +<div class="block">Checks if the current value held by this property is a valid double value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isIntList()">isIntList</a></strong>()</code> +<div class="block">Checks if all of the current values stored in this property can be converted to an integer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isIntValue()">isIntValue</a></strong>()</code> +<div class="block">Checks if the current value stored in this property can be converted to an integer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isList()">isList</a></strong>()</code> +<div class="block">Returns whether or not this Property is a list/array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#isListLengthFixed()">isListLengthFixed</a></strong>()</code> +<div class="block">Returns whether or not this list/array has a fixed length.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#requiresMcRestart()">requiresMcRestart</a></strong>()</code> +<div class="block">Gets whether or not this Property requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#requiresWorldRestart()">requiresWorldRestart</a></strong>()</code> +<div class="block">Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(boolean)">set</a></strong>(boolean value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(boolean[])">set</a></strong>(boolean[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(double)">set</a></strong>(double value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(double[])">set</a></strong>(double[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(int)">set</a></strong>(int value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(int[])">set</a></strong>(int[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(java.lang.String)">set</a></strong>(java.lang.String value)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#set(java.lang.String[])">set</a></strong>(java.lang.String[] values)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setArrayEntryClass(java.lang.Class)">setArrayEntryClass</a></strong>(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> clazz)</code> +<div class="block">Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setConfigEntryClass(java.lang.Class)">setConfigEntryClass</a></strong>(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</code> +<div class="block">Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(boolean)">setDefaultValue</a></strong>(boolean defaultValue)</code> +<div class="block">Sets the default boolean value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(double)">setDefaultValue</a></strong>(double defaultValue)</code> +<div class="block">Sets the default double value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(int)">setDefaultValue</a></strong>(int defaultValue)</code> +<div class="block">Sets the default int value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValue(java.lang.String)">setDefaultValue</a></strong>(java.lang.String defaultValue)</code> +<div class="block">Sets the default string value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(boolean[])">setDefaultValues</a></strong>(boolean[] defaultValues)</code> +<div class="block">Sets the default boolean[] values of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(double[])">setDefaultValues</a></strong>(double[] defaultValues)</code> +<div class="block">Sets the default double[] values of this Property</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(int[])">setDefaultValues</a></strong>(int[] defaultValues)</code> +<div class="block">Sets the default int[] values of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setDefaultValues(java.lang.String[])">setDefaultValues</a></strong>(java.lang.String[] defaultValues)</code> +<div class="block">Sets the default String[] values of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setIsListLengthFixed(boolean)">setIsListLengthFixed</a></strong>(boolean isListLengthFixed)</code> +<div class="block">Sets the flag for whether this list/array Property has a fixed length.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setLanguageKey(java.lang.String)">setLanguageKey</a></strong>(java.lang.String langKey)</code> +<div class="block">Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMaxListLength(int)">setMaxListLength</a></strong>(int max)</code> +<div class="block">Sets the maximum length of this list/array Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMaxValue(double)">setMaxValue</a></strong>(double maxValue)</code> +<div class="block">Sets the maximum double value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMaxValue(int)">setMaxValue</a></strong>(int maxValue)</code> +<div class="block">Sets the maximum int value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMinValue(double)">setMinValue</a></strong>(double minValue)</code> +<div class="block">Sets the minimum double value of this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setMinValue(int)">setMinValue</a></strong>(int minValue)</code> +<div class="block">Sets the minimum int value of this Property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Sets the name/key for this Property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setRequiresMcRestart(boolean)">setRequiresMcRestart</a></strong>(boolean requiresMcRestart)</code> +<div class="block">Sets whether or not this Property requires Minecraft to be restarted when changed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setRequiresWorldRestart(boolean)">setRequiresWorldRestart</a></strong>(boolean requiresWorldRestart)</code> +<div class="block">Sets the flag for whether or not this Property can be edited while a world is running.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setShowInGui(boolean)">setShowInGui</a></strong>(boolean showInGui)</code> +<div class="block">Sets whether or not this Property should be allowed to show on config GUIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setToDefault()">setToDefault</a></strong>()</code> +<div class="block">Sets the current value(s) of this Property to the default value(s).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValidationPattern(java.util.regex.Pattern)">setValidationPattern</a></strong>(java.util.regex.Pattern validationPattern)</code> +<div class="block">Sets a regex Pattern object used to validate user input for formatted String or String[] properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValidValues(java.lang.String[])">setValidValues</a></strong>(java.lang.String[] validValues)</code> +<div class="block">Sets the array of valid values that this String Property can be set to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(boolean)">setValue</a></strong>(boolean value)</code> +<div class="block">Sets the value of this Property to the provided boolean value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(double)">setValue</a></strong>(double value)</code> +<div class="block">Sets the value of this Property to the provided double value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(int)">setValue</a></strong>(int value)</code> +<div class="block">Sets the value of this Property to the provided int value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValue(java.lang.String)">setValue</a></strong>(java.lang.String value)</code> +<div class="block">Sets the value of this Property to the provided String value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(boolean[])">setValues</a></strong>(boolean[] values)</code> +<div class="block">Sets the values of this Property to the provided boolean[] values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(double[])">setValues</a></strong>(double[] values)</code> +<div class="block">Sets the values of this Property to the provided double[] values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(int[])">setValues</a></strong>(int[] values)</code> +<div class="block">Sets the values of this Property to the provided int[] values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a></code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#setValues(java.lang.String[])">setValues</a></strong>(java.lang.String[] values)</code> +<div class="block">Sets the values of this Property to the provided String[] values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#showInGui()">showInGui</a></strong>()</code> +<div class="block">Gets whether or not this Property should be allowed to show on config GUIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../net/minecraftforge/common/config/Property.html#wasRead()">wasRead</a></strong>()</code> +<div class="block">Determines if this config value was just created, or if it was read from the config file.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="comment"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>comment</h4> +<pre>public java.lang.String comment</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + boolean read, + java.lang.String langKey)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String, net.minecraftforge.common.config.Property.Type, java.lang.String[], java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String value, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String[] validValues, + java.lang.String langKey)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String[], net.minecraftforge.common.config.Property.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type)</pre> +</li> +</ul> +<a name="Property(java.lang.String, java.lang.String[], net.minecraftforge.common.config.Property.Type, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Property</h4> +<pre>public Property(java.lang.String name, + java.lang.String[] values, + <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> type, + java.lang.String langKey)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDefault</h4> +<pre>public boolean isDefault()</pre> +<div class="block">Returns whether or not this Property is defaulted.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if the current value(s) is(are) deeply equal to the default value(s)</dd></dl> +</li> +</ul> +<a name="setToDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setToDefault</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setToDefault()</pre> +<div class="block">Sets the current value(s) of this Property to the default value(s).</div> +</li> +</ul> +<a name="getDefault()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefault</h4> +<pre>public java.lang.String getDefault()</pre> +<div class="block">Gets the raw String default value of this Property. Check for isList() == false first.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the default value String</dd></dl> +</li> +</ul> +<a name="getDefaults()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaults</h4> +<pre>public java.lang.String[] getDefaults()</pre> +<div class="block">Gets the raw String[] default values of this Property. Check for isList() == true first.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the default values String[]</dd></dl> +</li> +</ul> +<a name="setRequiresWorldRestart(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequiresWorldRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setRequiresWorldRestart(boolean requiresWorldRestart)</pre> +<div class="block">Sets the flag for whether or not this Property can be edited while a world is running. Care should be taken to ensure + that only properties that are truly dynamic can be changed from the in-game options menu. When set to false the Property will be + editable from both the main menu Mods list config screen and the in-game Mod Options config screen. When set to true the Property + will only be editable from the main menu Mods list config screen.</div> +</li> +</ul> +<a name="requiresWorldRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresWorldRestart</h4> +<pre>public boolean requiresWorldRestart()</pre> +<div class="block">Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen. Setting this flag to true will disable editing of + this property while a world is running.</div> +</li> +</ul> +<a name="setShowInGui(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setShowInGui</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setShowInGui(boolean showInGui)</pre> +<div class="block">Sets whether or not this Property should be allowed to show on config GUIs. + Defaults to true.</div> +</li> +</ul> +<a name="showInGui()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>showInGui</h4> +<pre>public boolean showInGui()</pre> +<div class="block">Gets whether or not this Property should be allowed to show on config GUIs. + Defaults to true unless set to false.</div> +</li> +</ul> +<a name="setRequiresMcRestart(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequiresMcRestart</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setRequiresMcRestart(boolean requiresMcRestart)</pre> +<div class="block">Sets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false. Setting this flag to true will also disable editing of + this property while a world is running.</div> +</li> +</ul> +<a name="requiresMcRestart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>requiresMcRestart</h4> +<pre>public boolean requiresMcRestart()</pre> +<div class="block">Gets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false unless set to true.</div> +</li> +</ul> +<a name="setMaxListLength(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxListLength</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMaxListLength(int max)</pre> +<div class="block">Sets the maximum length of this list/array Property. Only important if isList() == true. If the current values array or default + values array is longer than the new maximum it will be resized. If calling both this method and setIsListLengthFixed(true), this + method should be called afterwards (but is not required).</div> +</li> +</ul> +<a name="getMaxListLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxListLength</h4> +<pre>public int getMaxListLength()</pre> +<div class="block">Gets the maximum length of this list/array Property. Only important if isList() == true.</div> +</li> +</ul> +<a name="setIsListLengthFixed(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIsListLengthFixed</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setIsListLengthFixed(boolean isListLengthFixed)</pre> +<div class="block">Sets the flag for whether this list/array Property has a fixed length. Only important if isList() == true. If calling both this + method and setMaxListLength(), this method should be called first (but is not required).</div> +</li> +</ul> +<a name="isListLengthFixed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isListLengthFixed</h4> +<pre>public boolean isListLengthFixed()</pre> +<div class="block">Returns whether or not this list/array has a fixed length. Only important if isList() == true.</div> +</li> +</ul> +<a name="setConfigEntryClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setConfigEntryClass</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setConfigEntryClass(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> clazz)</pre> +<div class="block">Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type. This class + MUST provide a constructor with the following parameter types: <code>GuiConfig</code> (the owning GuiConfig screen will be provided), + <code>GuiConfigEntries</code> (the owning GuiConfigEntries will be provided), <code>IConfigElement</code> (the IConfigElement for this Property + will be provided).</div> +</li> +</ul> +<a name="getConfigEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfigEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html" title="interface in cpw.mods.fml.client.config">GuiConfigEntries.IConfigEntry</a>> getConfigEntryClass()</pre> +<div class="block">Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a class that implements IConfigEntry</dd></dl> +</li> +</ul> +<a name="setArrayEntryClass(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setArrayEntryClass</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setArrayEntryClass(java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> clazz)</pre> +<div class="block">Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type. This class + MUST provide a constructor with the following parameter types: <code>GuiEditList</code> (the owning GuiEditList screen will be provided), + <code>GuiPropertyList</code> (the parent GuiPropertyList will be provided), <code>IConfigProperty</code> (the IConfigProperty for this Property + will be provided).</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>clazz</code> - a class that implements IConfigEntry</dd></dl> +</li> +</ul> +<a name="getArrayEntryClass()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getArrayEntryClass</h4> +<pre>public java.lang.Class<? extends <a href="../../../../cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html" title="interface in cpw.mods.fml.client.config">GuiEditArrayEntries.IArrayEntry</a>> getArrayEntryClass()</pre> +<div class="block">Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if + none has been set.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a class that implements IArrayEntry</dd></dl> +</li> +</ul> +<a name="setValidationPattern(java.util.regex.Pattern)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValidationPattern</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValidationPattern(java.util.regex.Pattern validationPattern)</pre> +<div class="block">Sets a regex Pattern object used to validate user input for formatted String or String[] properties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validationPattern</code> - </dd></dl> +</li> +</ul> +<a name="getValidationPattern()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidationPattern</h4> +<pre>public java.util.regex.Pattern getValidationPattern()</pre> +<div class="block">Gets the Pattern object used to validate user input for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the user input validation Pattern object, or null if none is set</dd></dl> +</li> +</ul> +<a name="setLanguageKey(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLanguageKey</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setLanguageKey(java.lang.String langKey)</pre> +<div class="block">Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3. The string languageKey + + ".tooltip" is used for tooltips when a user hovers the mouse over a GUI property label.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>langKey</code> - a string language key such as myawesomemod.config.myPropName</dd></dl> +</li> +</ul> +<a name="getLanguageKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLanguageKey</h4> +<pre>public java.lang.String getLanguageKey()</pre> +<div class="block">Gets the language key string for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the language key</dd></dl> +</li> +</ul> +<a name="setDefaultValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(java.lang.String defaultValue)</pre> +<div class="block">Sets the default string value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - a String value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(java.lang.String[] defaultValues)</pre> +<div class="block">Sets the default String[] values of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of String values</dd></dl> +</li> +</ul> +<a name="setDefaultValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(int defaultValue)</pre> +<div class="block">Sets the default int value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - an int value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(int[] defaultValues)</pre> +<div class="block">Sets the default int[] values of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of int values</dd></dl> +</li> +</ul> +<a name="setDefaultValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(double defaultValue)</pre> +<div class="block">Sets the default double value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - a double value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(double[] defaultValues)</pre> +<div class="block">Sets the default double[] values of this Property</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of double values</dd></dl> +</li> +</ul> +<a name="setDefaultValue(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValue(boolean defaultValue)</pre> +<div class="block">Sets the default boolean value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValue</code> - a boolean value</dd></dl> +</li> +</ul> +<a name="setDefaultValues(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setDefaultValues(boolean[] defaultValues)</pre> +<div class="block">Sets the default boolean[] values of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>defaultValues</code> - an array of boolean values</dd></dl> +</li> +</ul> +<a name="setMinValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMinValue(int minValue)</pre> +<div class="block">Sets the minimum int value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minValue</code> - an int value</dd></dl> +</li> +</ul> +<a name="setMaxValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMaxValue(int maxValue)</pre> +<div class="block">Sets the maximum int value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxValue</code> - an int value</dd></dl> +</li> +</ul> +<a name="setMinValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMinValue(double minValue)</pre> +<div class="block">Sets the minimum double value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minValue</code> - a double value</dd></dl> +</li> +</ul> +<a name="setMaxValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setMaxValue(double maxValue)</pre> +<div class="block">Sets the maximum double value of this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxValue</code> - a double value</dd></dl> +</li> +</ul> +<a name="getMinValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinValue</h4> +<pre>public java.lang.String getMinValue()</pre> +<div class="block">Gets the minimum value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the minimum value bound</dd></dl> +</li> +</ul> +<a name="getMaxValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxValue</h4> +<pre>public java.lang.String getMaxValue()</pre> +<div class="block">Gets the maximum value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the maximum value bound</dd></dl> +</li> +</ul> +<a name="getString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getString</h4> +<pre>public java.lang.String getString()</pre> +<div class="block">Returns the value in this property as it's raw string.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>current value</dd></dl> +</li> +</ul> +<a name="setValidValues(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValidValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValidValues(java.lang.String[] validValues)</pre> +<div class="block">Sets the array of valid values that this String Property can be set to. When an array of valid values is defined for a Property the + GUI control for that property will be a value cycle button.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validValues</code> - a String array of valid values</dd></dl> +</li> +</ul> +<a name="getValidValues()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValidValues</h4> +<pre>public java.lang.String[] getValidValues()</pre> +<div class="block">Gets the array of valid values that this String Property can be set to, or null if not defined.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a String array of valid values</dd></dl> +</li> +</ul> +<a name="getInt()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt()</pre> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="getInt(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(int _default)</pre> +<div class="block">Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide if the current value is not a valid integer</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="isIntValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIntValue</h4> +<pre>public boolean isIntValue()</pre> +<div class="block">Checks if the current value stored in this property can be converted to an integer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the type of the Property is an Integer</dd></dl> +</li> +</ul> +<a name="getBoolean(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(boolean _default)</pre> +<div class="block">Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value as a boolean, or the default</dd></dl> +</li> +</ul> +<a name="getBoolean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean()</pre> +<div class="block">Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The value as a boolean, or the default</dd></dl> +</li> +</ul> +<a name="isBooleanValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBooleanValue</h4> +<pre>public boolean isBooleanValue()</pre> +<div class="block">Checks if the current value held by this property is a valid boolean value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if it is a boolean value</dd></dl> +</li> +</ul> +<a name="isDoubleValue()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDoubleValue</h4> +<pre>public boolean isDoubleValue()</pre> +<div class="block">Checks if the current value held by this property is a valid double value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the value can be converted to an double</dd></dl> +</li> +</ul> +<a name="getDouble(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble(double _default)</pre> +<div class="block">Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide if the current value is not a valid double</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="getDouble()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble()</pre> +<div class="block">Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_default</code> - The default to provide if the current value is not a valid double</dd> +<dt><span class="strong">Returns:</span></dt><dd>The value</dd></dl> +</li> +</ul> +<a name="getStringList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStringList</h4> +<pre>public java.lang.String[] getStringList()</pre> +</li> +</ul> +<a name="getIntList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIntList</h4> +<pre>public int[] getIntList()</pre> +<div class="block">Returns the integer value of all values that can + be parsed in the list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Array of length 0 if none of the values could be parsed.</dd></dl> +</li> +</ul> +<a name="isIntList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIntList</h4> +<pre>public boolean isIntList()</pre> +<div class="block">Checks if all of the current values stored in this property can be converted to an integer.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the type of the Property is an Integer List</dd></dl> +</li> +</ul> +<a name="getBooleanList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBooleanList</h4> +<pre>public boolean[] getBooleanList()</pre> +<div class="block">Returns the boolean value of all values that can + be parsed in the list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Array of length 0 if none of the values could be parsed.</dd></dl> +</li> +</ul> +<a name="isBooleanList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isBooleanList</h4> +<pre>public boolean isBooleanList()</pre> +<div class="block">Checks if all of current values stored in this property can be converted to a boolean.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if it is a boolean value</dd></dl> +</li> +</ul> +<a name="getDoubleList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDoubleList</h4> +<pre>public double[] getDoubleList()</pre> +<div class="block">Returns the double value of all values that can + be parsed in the list.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Array of length 0 if none of the values could be parsed.</dd></dl> +</li> +</ul> +<a name="isDoubleList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDoubleList</h4> +<pre>public boolean isDoubleList()</pre> +<div class="block">Checks if all of the current values stored in this property can be converted to a double.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the type of the Property is a double List</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block">Gets the name/key for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the Property name</dd></dl> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block">Sets the name/key for this Property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a name</dd></dl> +</li> +</ul> +<a name="wasRead()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wasRead</h4> +<pre>public boolean wasRead()</pre> +<div class="block">Determines if this config value was just created, or if it was read from the config file. + This is useful for mods who auto-assign their blocks to determine if the ID returned is + a configured one, or a automatically generated one.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if this property was loaded from the config file with a value</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config">Property.Type</a> getType()</pre> +<div class="block">Gets the Property.Type enum value for this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the Property's type</dd></dl> +</li> +</ul> +<a name="isList()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isList</h4> +<pre>public boolean isList()</pre> +<div class="block">Returns whether or not this Property is a list/array.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if this Property is a list/array, false otherwise</dd></dl> +</li> +</ul> +<a name="hasChanged()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasChanged</h4> +<pre>public boolean hasChanged()</pre> +<div class="block">Gets the changed status of this Property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if this Property has changed, false otherwise</dd></dl> +</li> +</ul> +<a name="setValue(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(java.lang.String value)</pre> +<div class="block">Sets the value of this Property to the provided String value.</div> +</li> +</ul> +<a name="set(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(java.lang.String value)</pre> +</li> +</ul> +<a name="setValues(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(java.lang.String[] values)</pre> +<div class="block">Sets the values of this Property to the provided String[] values.</div> +</li> +</ul> +<a name="set(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(java.lang.String[] values)</pre> +</li> +</ul> +<a name="setValue(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(int value)</pre> +<div class="block">Sets the value of this Property to the provided int value.</div> +</li> +</ul> +<a name="setValue(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(boolean value)</pre> +<div class="block">Sets the value of this Property to the provided boolean value.</div> +</li> +</ul> +<a name="setValue(double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValue</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValue(double value)</pre> +<div class="block">Sets the value of this Property to the provided double value.</div> +</li> +</ul> +<a name="setValues(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(boolean[] values)</pre> +<div class="block">Sets the values of this Property to the provided boolean[] values.</div> +</li> +</ul> +<a name="set(boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(boolean[] values)</pre> +</li> +</ul> +<a name="setValues(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(int[] values)</pre> +<div class="block">Sets the values of this Property to the provided int[] values.</div> +</li> +</ul> +<a name="set(int[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(int[] values)</pre> +</li> +</ul> +<a name="setValues(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setValues</h4> +<pre>public <a href="../../../../net/minecraftforge/common/config/Property.html" title="class in net.minecraftforge.common.config">Property</a> setValues(double[] values)</pre> +<div class="block">Sets the values of this Property to the provided double[] values.</div> +</li> +</ul> +<a name="set(double[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(double[] values)</pre> +</li> +</ul> +<a name="set(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(int value)</pre> +</li> +</ul> +<a name="set(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(boolean value)</pre> +</li> +</ul> +<a name="set(double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>set</h4> +<pre>public void set(double value)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html" title="class in net.minecraftforge.common.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../net/minecraftforge/common/config/Property.Type.html" title="enum in net.minecraftforge.common.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?net/minecraftforge/common/config/Property.html" target="_top">Frames</a></li> +<li><a href="Property.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |