Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- .../common/config/ConfigCategory.html | 929 +++++++++ .../common/config/ConfigElement.html | 919 +++++++++ .../Configuration.UnicodeInputStreamReader.html | 340 ++++ .../common/config/Configuration.html | 1988 ++++++++++++++++++++ .../common/config/Property.Type.html | 395 ++++ .../net/minecraftforge/common/config/Property.html | 1733 +++++++++++++++++ .../common/config/package-frame.html | 27 + .../common/config/package-summary.html | 167 ++ .../minecraftforge/common/config/package-tree.html | 146 ++ 9 files changed, 6644 insertions(+) create mode 100644 javadoc/net/minecraftforge/common/config/ConfigCategory.html create mode 100644 javadoc/net/minecraftforge/common/config/ConfigElement.html create mode 100644 javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html create mode 100644 javadoc/net/minecraftforge/common/config/Configuration.html create mode 100644 javadoc/net/minecraftforge/common/config/Property.Type.html create mode 100644 javadoc/net/minecraftforge/common/config/Property.html create mode 100644 javadoc/net/minecraftforge/common/config/package-frame.html create mode 100644 javadoc/net/minecraftforge/common/config/package-summary.html create mode 100644 javadoc/net/minecraftforge/common/config/package-tree.html (limited to 'javadoc/net/minecraftforge/common/config') diff --git a/javadoc/net/minecraftforge/common/config/ConfigCategory.html b/javadoc/net/minecraftforge/common/config/ConfigCategory.html new file mode 100644 index 0000000..f9c0e7d --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/ConfigCategory.html @@ -0,0 +1,929 @@ + + + + + +ConfigCategory (Forge API) + + + + + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- net.minecraftforge.common.config.ConfigCategory
+

All Implemented Interfaces:: java.util.Map<java.lang.String,Property>

+
+

public class ConfigCategory
+extends java.lang.Object
+implements java.util.Map<java.lang.String,Property>

+ +

+ + +
Nested Class Summary
+
- + + +
  Nested classes/interfaces inherited from interface java.util.Map
  +java.util.Map.Entry<K,V>
+

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
ConfigCategory parent
+

Fields
Modifier and Type	Field and Description
`ConfigCategory`	`parent`

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
ConfigCategory(java.lang.String name)
ConfigCategory(java.lang.String name, + ConfigCategory parent)
+

Constructors
Constructor and Description
`ConfigCategory(java.lang.String name)`
`ConfigCategory(java.lang.String name, + ConfigCategory parent)`

+ +

+ + +

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsKey(java.lang.String key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<java.lang.String,Property>>`	`entrySet()`
`boolean`	`equals(java.lang.Object obj)`
`Property`	`get(java.lang.Object key)`
`Property`	`get(java.lang.String key)`
`java.util.Set<ConfigCategory>`	`getChildren()`
`java.lang.String`	`getComment()`
`java.lang.Class<? extends GuiConfigEntries.IConfigEntry>`	`getConfigEntryClass()`
`ConfigCategory`	`getFirstParent()`
`java.lang.String`	`getLanguagekey()`
`java.lang.String`	`getName()`
`java.util.List<Property>`	`getOrderedValues()`
`java.util.List<java.lang.String>`	`getPropertyOrder()`
`java.lang.String`	`getQualifiedName()`
`static java.lang.String`	`getQualifiedName(java.lang.String name, + ConfigCategory parent)`
`java.util.Map<java.lang.String,Property>`	`getValues()`
`boolean`	`hasChanged()`
`boolean`	`isChild()`
`boolean`	`isEmpty()`
`java.util.Set<java.lang.String>`	`keySet()`
`Property`	`put(java.lang.String key, + Property value)`
`void`	`putAll(java.util.Map<? extends java.lang.String,? extends Property> m)`
`Property`	`remove(java.lang.Object key)`
`void`	`removeChild(ConfigCategory child)`
`boolean`	`requiresMcRestart()` + Gets whether or not this ConfigCategory requires Minecraft to be restarted when changed. +
`boolean`	`requiresWorldRestart()` + Returns whether or not this category is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen. +
`void`	`setComment(java.lang.String comment)`
`ConfigCategory`	`setConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)`
`ConfigCategory`	`setLanguageKey(java.lang.String languagekey)`
`ConfigCategory`	`setPropertyOrder(java.util.List<java.lang.String> propertyOrder)`
`ConfigCategory`	`setRequiresMcRestart(boolean requiresMcRestart)` + Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. +
`ConfigCategory`	`setRequiresWorldRestart(boolean requiresWorldRestart)` + Sets the flag for whether or not this category can be edited while a world is running. +
`ConfigCategory`	`setShowInGui(boolean showInGui)` + Sets whether or not this ConfigCategory should be allowed to show on config GUIs. +
`boolean`	`showInGui()` + Gets whether or not this ConfigCategory should be allowed to show on config GUIs. +
`int`	`size()`
`java.util.Collection<Property>`	`values()`
`void`	`write(java.io.BufferedWriter out, + int indent)`

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ + +
Methods inherited from interface java.util.Map
+hashCode

+ +
- + + +
  Field Detail
  + + + +
  - +
    parent
    +
```
public final ConfigCategory parent
```
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ConfigCategory
    +
```
public ConfigCategory(java.lang.String name)
```
    +
  + + + +
  - +
    ConfigCategory
    +
```
public ConfigCategory(java.lang.String name,
+              ConfigCategory parent)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    equals
    +
```
public boolean equals(java.lang.Object obj)
```
    +
    +
    Specified by:
    +
    equals in interface java.util.Map<java.lang.String,Property>
    +
    Overrides:
    +
    equals in class java.lang.Object
    +
    +
  + + + +
  - +
    getName
    +
```
public java.lang.String getName()
```
    +
  + + + +
  - +
    getQualifiedName
    +
```
public java.lang.String getQualifiedName()
```
    +
  + + + +
  - +
    getQualifiedName
    +
```
public static java.lang.String getQualifiedName(java.lang.String name,
+                                ConfigCategory parent)
```
    +
  + + + +
  - +
    getFirstParent
    +
```
public ConfigCategory getFirstParent()
```
    +
  + + + +
  - +
    isChild
    +
```
public boolean isChild()
```
    +
  + + + +
  - +
    getValues
    +
```
public java.util.Map<java.lang.String,Property> getValues()
```
    +
  + + + +
  - +
    getOrderedValues
    +
```
public java.util.List<Property> getOrderedValues()
```
    +
  + + + +
  - +
    setConfigEntryClass
    +
```
public ConfigCategory setConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
```
    +
  + + + +
  - +
    getConfigEntryClass
    +
```
public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
```
    +
  + + + +
  - +
    setLanguageKey
    +
```
public ConfigCategory setLanguageKey(java.lang.String languagekey)
```
    +
  + + + +
  - +
    getLanguagekey
    +
```
public java.lang.String getLanguagekey()
```
    +
  + + + +
  - +
    setComment
    +
```
public void setComment(java.lang.String comment)
```
    +
  + + + +
  - +
    getComment
    +
```
public java.lang.String getComment()
```
    +
  + + + +
  - +
    setRequiresWorldRestart
    +
```
public ConfigCategory setRequiresWorldRestart(boolean requiresWorldRestart)
```
    +
    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.
    +
  + + + +
  - +
    requiresWorldRestart
    +
```
public boolean requiresWorldRestart()
```
    +
    Returns whether or not this category is able to be edited while a world is running using the in-game Mod Options screen + as well as the Mods list screen, or only from the Mods list screen.
    +
  + + + +
  - +
    setShowInGui
    +
```
public ConfigCategory setShowInGui(boolean showInGui)
```
    +
    Sets whether or not this ConfigCategory should be allowed to show on config GUIs. + Defaults to true.
    +
  + + + +
  - +
    showInGui
    +
```
public boolean showInGui()
```
    +
    Gets whether or not this ConfigCategory should be allowed to show on config GUIs. + Defaults to true unless set to false.
    +
  + + + +
  - +
    setRequiresMcRestart
    +
```
public ConfigCategory setRequiresMcRestart(boolean requiresMcRestart)
```
    +
    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.
    +
  + + + +
  - +
    requiresMcRestart
    +
```
public boolean requiresMcRestart()
```
    +
    Gets whether or not this ConfigCategory requires Minecraft to be restarted when changed. + Defaults to false unless set to true.
    +
  + + + +
  - +
    setPropertyOrder
    +
```
public ConfigCategory setPropertyOrder(java.util.List<java.lang.String> propertyOrder)
```
    +
  + + + +
  - +
    getPropertyOrder
    +
```
public java.util.List<java.lang.String> getPropertyOrder()
```
    +
  + + + +
  - +
    containsKey
    +
```
public boolean containsKey(java.lang.String key)
```
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String key)
```
    +
  + + + +
  - +
    write
    +
```
public void write(java.io.BufferedWriter out,
+         int indent)
+           throws java.io.IOException
```
    +
    Throws:
    +
    java.io.IOException
    +
  + + + +
  - +
    hasChanged
    +
```
public boolean hasChanged()
```
    +
  + + + +
  - +
    size
    +
```
public int size()
```
    +
    +
    Specified by:
    +
    size in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    isEmpty
    +
```
public boolean isEmpty()
```
    +
    +
    Specified by:
    +
    isEmpty in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    containsKey
    +
```
public boolean containsKey(java.lang.Object key)
```
    +
    +
    Specified by:
    +
    containsKey in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    containsValue
    +
```
public boolean containsValue(java.lang.Object value)
```
    +
    +
    Specified by:
    +
    containsValue in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.Object key)
```
    +
    +
    Specified by:
    +
    get in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    put
    +
```
public Property put(java.lang.String key,
+           Property value)
```
    +
    +
    Specified by:
    +
    put in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    remove
    +
```
public Property remove(java.lang.Object key)
```
    +
    +
    Specified by:
    +
    remove in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    putAll
    +
```
public void putAll(java.util.Map<? extends java.lang.String,? extends Property> m)
```
    +
    +
    Specified by:
    +
    putAll in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    clear
    +
```
public void clear()
```
    +
    +
    Specified by:
    +
    clear in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    keySet
    +
```
public java.util.Set<java.lang.String> keySet()
```
    +
    +
    Specified by:
    +
    keySet in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    values
    +
```
public java.util.Collection<Property> values()
```
    +
    +
    Specified by:
    +
    values in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    entrySet
    +
```
public java.util.Set<java.util.Map.Entry<java.lang.String,Property>> entrySet()
```
    +
    +
    Specified by:
    +
    entrySet in interface java.util.Map<java.lang.String,Property>
    +
    +
  + + + +
  - +
    getChildren
    +
```
public java.util.Set<ConfigCategory> getChildren()
```
    +
  + + + +
  - +
    removeChild
    +
```
public void removeChild(ConfigCategory child)
```
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + diff --git a/javadoc/net/minecraftforge/common/config/ConfigElement.html b/javadoc/net/minecraftforge/common/config/ConfigElement.html new file mode 100644 index 0000000..886c8a6 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/ConfigElement.html @@ -0,0 +1,919 @@ + + + + + +ConfigElement (Forge API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- net.minecraftforge.common.config.ConfigElement<T>
+

+
+
All Implemented Interfaces:
+
IConfigElement<T>
+
+
+
+
```
public class ConfigElement<T>
+extends java.lang.Object
+implements IConfigElement<T>
```
+
This class bridges the gap between the FML config GUI classes and the Forge Configuration classes.
+

+ +

+ + +
Property Summary
+ + + + + + + + + + +
Properties
Type Property and Description
boolean is +
[Property, Category] Is this object a property object?
+
+

Properties
Type	Property and Description
`boolean`	`is` + [Property, Category] Is this object a property object? +

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
ConfigElement(ConfigCategory ctgy)
ConfigElement(Property prop)
+

Constructors
Constructor and Description
`ConfigElement(ConfigCategory ctgy)`
`ConfigElement(Property prop)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`java.lang.Object`	`get()` + [Property] Gets this property value. +
`java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry>`	`getArrayEntryClass()` + This method returns a class that implements `IArrayEntry`. +
`java.util.List<IConfigElement>`	`getChildElements()` + [Category] Gets this category's child categories/properties. +
`java.lang.String`	`getComment()` + [Property, Category] Gets the comment for this object. +
`java.lang.Class<? extends GuiConfigEntries.IConfigEntry>`	`getConfigEntryClass()` + This method returns a class that implements `IConfigEntry` or null. +
`java.lang.Object`	`getDefault()` + [Property] Gets this property's default value. +
`java.lang.Object[]`	`getDefaults()` + [Property] Gets this property's default values. +
`java.lang.String`	`getLanguageKey()` + [Property, Category] Gets a language key for localization of config GUI entry names. +
`java.lang.Object[]`	`getList()` + [Property] Gets this property value as a list. +
`int`	`getMaxListLength()` + [Property] Gets the max length of this list property, or -1 if the length is unlimited. +
`T`	`getMaxValue()` + [Property] Gets this property's maximum value. +
`T`	`getMinValue()` + [Property] Gets this property's minimum value. +
`java.lang.String`	`getName()` + [Property, Category] Gets the name of this object. +
`java.lang.String`	`getQualifiedName()` + [Category] Gets the qualified name of this object. +
`ConfigGuiType`	`getType()` + [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object. +
`static ConfigGuiType`	`getType(Property prop)`
`static ConfigElement<?>`	`getTypedElement(Property prop)`
`java.util.regex.Pattern`	`getValidationPattern()` + [Property] Gets a Pattern object used in String property input validation. +
`java.lang.String[]`	`getValidValues()` + [Property] Gets a String array of valid values for this property. +
`boolean`	`isDefault()` + [Property] Is this property value equal to the default value? +
`boolean`	`isList()` + [Property] Is this property object a list? +
`boolean`	`isListLengthFixed()` + [Property] Does this list property have to remain a fixed length? +
`boolean`	`isProperty()` + [Property, Category] Is this object a property object? +
`ConfigElement<T>`	`listCategoriesFirst(boolean categoriesFirst)`
`boolean`	`requiresMcRestart()` + [Property, Category] Whether or not this element requires Minecraft to be restarted when changed. +
`boolean`	`requiresWorldRestart()` + [Property, Category] Whether or not this element is safe to modify while a world is running. +
`void`	`set(T value)` + [Property] Sets this property's value. +
`void`	`set(T[] aVal)` + [Property] Sets this property's value to the specified array. +
`void`	`setToDefault()` + [Property] Sets this property's value to the default value. +
`boolean`	`showInGui()` + [Property, Category] Whether or not this element should be allowed to show on config GUIs. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Property Detail
  + + + +
  - +
    is
    +
    +
    Specified by:
    +
    isProperty in interface IConfigElement<T>
    +
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    ConfigElement
    +
```
public ConfigElement(ConfigCategory ctgy)
```
    +
  + + + +
  - +
    ConfigElement
    +
```
public ConfigElement(Property prop)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    listCategoriesFirst
    +
```
public ConfigElement<T> listCategoriesFirst(boolean categoriesFirst)
```
    +
  + + + +
  - +
    getChildElements
    +
```
public java.util.List<IConfigElement> getChildElements()
```
    +
    Description copied from interface: IConfigElement
    +
    [Category] Gets this category's child categories/properties.
    +
    +
    Specified by:
    +
    getChildElements in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getTypedElement
    +
```
public static ConfigElement<?> getTypedElement(Property prop)
```
    +
  + + + +
  - +
    getName
    +
```
public java.lang.String getName()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Gets the name of this object.
    +
    +
    Specified by:
    +
    getName in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    isProperty
    +
```
public boolean isProperty()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Is this object a property object?
    +
    +
    Specified by:
    +
    isProperty in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getConfigEntryClass
    +
```
public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
```
    +
    Description copied from interface: IConfigElement
    +
    This method returns a class that implements IConfigEntry or null. This class MUST + provide a constructor with the following parameter types: GuiConfig, GuiConfigEntries, IConfigElement
    +
    +
    Specified by:
    +
    getConfigEntryClass in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getArrayEntryClass
    +
```
public java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
```
    +
    Description copied from interface: IConfigElement
    +
    This method returns a class that implements IArrayEntry. This class MUST provide a constructor with the + following parameter types: GuiEditArray, GuiEditArrayEntries, IConfigElement, Object
    +
    +
    Specified by:
    +
    getArrayEntryClass in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getQualifiedName
    +
```
public java.lang.String getQualifiedName()
```
    +
    Description copied from interface: IConfigElement
    +
    [Category] Gets the qualified name of this object. This is typically only used for category objects.
    +
    +
    Specified by:
    +
    getQualifiedName in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getType
    +
```
public ConfigGuiType getType()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a + category object.
    +
    +
    Specified by:
    +
    getType in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getType
    +
```
public static ConfigGuiType getType(Property prop)
```
    +
  + + + +
  - +
    isList
    +
```
public boolean isList()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Is this property object a list?
    +
    +
    Specified by:
    +
    isList in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    isListLengthFixed
    +
```
public boolean isListLengthFixed()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Does this list property have to remain a fixed length?
    +
    +
    Specified by:
    +
    isListLengthFixed in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getMaxListLength
    +
```
public int getMaxListLength()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets the max length of this list property, or -1 if the length is unlimited.
    +
    +
    Specified by:
    +
    getMaxListLength in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getComment
    +
```
public java.lang.String getComment()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Gets the comment for this object. Used for the tooltip if getLanguageKey() + ".tooltip" is not defined in the + .lang file.
    +
    +
    Specified by:
    +
    getComment in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    isDefault
    +
```
public boolean isDefault()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Is this property value equal to the default value?
    +
    +
    Specified by:
    +
    isDefault in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    setToDefault
    +
```
public void setToDefault()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Sets this property's value to the default value.
    +
    +
    Specified by:
    +
    setToDefault in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    requiresWorldRestart
    +
```
public boolean requiresWorldRestart()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Whether or not this element is safe to modify while a world is running. For Categories return false if ANY properties + in the category are modifiable while a world is running, true if all are not.
    +
    +
    Specified by:
    +
    requiresWorldRestart in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    showInGui
    +
```
public boolean showInGui()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Whether or not this element should be allowed to show on config GUIs.
    +
    +
    Specified by:
    +
    showInGui in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    requiresMcRestart
    +
```
public boolean requiresMcRestart()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
    +
    +
    Specified by:
    +
    requiresMcRestart in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getValidValues
    +
```
public java.lang.String[] getValidValues()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets a String array of valid values for this property. This is generally used for String properties to allow the user to + select a value from a list of valid values.
    +
    +
    Specified by:
    +
    getValidValues in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getLanguageKey
    +
```
public java.lang.String getLanguageKey()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property, Category] Gets a language key for localization of config GUI entry names. If the same key is specified with .tooltip + appended to the end, that key will return a localized tooltip when the mouse hovers over the property label/category button.
    +
    +
    Specified by:
    +
    getLanguageKey in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getDefault
    +
```
public java.lang.Object getDefault()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets this property's default value. If this element is an array, this method should return a String + representation of that array using Arrays.toString()
    +
    +
    Specified by:
    +
    getDefault in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getDefaults
    +
```
public java.lang.Object[] getDefaults()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets this property's default values.
    +
    +
    Specified by:
    +
    getDefaults in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getValidationPattern
    +
```
public java.util.regex.Pattern getValidationPattern()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets a Pattern object used in String property input validation.
    +
    +
    Specified by:
    +
    getValidationPattern in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    get
    +
```
public java.lang.Object get()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets this property value.
    +
    +
    Specified by:
    +
    get in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getList
    +
```
public java.lang.Object[] getList()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets this property value as a list. Generally you should be sure of whether the property is a list before calling this.
    +
    +
    Specified by:
    +
    getList in interface IConfigElement<T>
    +
    +
  + + + + + +
  - +
    set
    +
```
public void set(T value)
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Sets this property's value.
    +
    +
    Specified by:
    +
    set in interface IConfigElement<T>
    +
    +
  + + + + + +
  - +
    set
    +
```
public void set(T[] aVal)
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Sets this property's value to the specified array.
    +
    +
    Specified by:
    +
    set in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getMinValue
    +
```
public T getMinValue()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets this property's minimum value.
    +
    +
    Specified by:
    +
    getMinValue in interface IConfigElement<T>
    +
    +
  + + + +
  - +
    getMaxValue
    +
```
public T getMaxValue()
```
    +
    Description copied from interface: IConfigElement
    +
    [Property] Gets this property's maximum value.
    +
    +
    Specified by:
    +
    getMaxValue in interface IConfigElement<T>
    +
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + diff --git a/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html new file mode 100644 index 0000000..d1e0522 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html @@ -0,0 +1,340 @@ + + + + + +Configuration.UnicodeInputStreamReader (Forge API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- java.io.Reader
- +
  - net.minecraftforge.common.config.Configuration.UnicodeInputStreamReader
  +
+

+
+
All Implemented Interfaces:
+
java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable
+
+
+
Enclosing class:
+
Configuration
+
+
+
+
```
public static class Configuration.UnicodeInputStreamReader
+extends java.io.Reader
```
+

+ +
- + + +
  Field Summary
  +
  - + + +
    Fields inherited from class java.io.Reader
    +lock
  +
+ +
- + + +
  Constructor Summary
  + + + + + + + + +
  Constructors
  Constructor and Description
  Configuration.UnicodeInputStreamReader(java.io.InputStream source, + java.lang.String encoding)
  +
+ +
- + + +
  Method Summary
  + + + + + + + + + + + + + + + + + + +
  Methods
  Modifier and Type Method and Description
  void close()
  java.lang.String getEncoding()
  int read(char[] cbuf, + int off, + int len)
  +
  - + + +
    Methods inherited from class java.io.Reader
    +mark, markSupported, read, read, read, ready, reset, skip
  +
  - + + +
    Methods inherited from class java.lang.Object
    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  +
+

Constructors
Constructor and Description
`Configuration.UnicodeInputStreamReader(java.io.InputStream source, + java.lang.String encoding)`

Methods
Modifier and Type	Method and Description
`void`	`close()`
`java.lang.String`	`getEncoding()`
`int`	`read(char[] cbuf, + int off, + int len)`

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Configuration.UnicodeInputStreamReader
    +
```
public Configuration.UnicodeInputStreamReader(java.io.InputStream source,
+                                      java.lang.String encoding)
+                                       throws java.io.IOException
```
    +
    Throws:
    +
    java.io.IOException
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getEncoding
    +
```
public java.lang.String getEncoding()
```
    +
  + + + +
  - +
    read
    +
```
public int read(char[] cbuf,
+       int off,
+       int len)
+         throws java.io.IOException
```
    +
    +
    Specified by:
    +
    read in class java.io.Reader
    +
    Throws:
    +
    java.io.IOException
    +
  + + + +
  - +
    close
    +
```
public void close()
+           throws java.io.IOException
```
    +
    +
    Specified by:
    +
    close in interface java.io.Closeable
    +
    Specified by:
    +
    close in interface java.lang.AutoCloseable
    +
    Specified by:
    +
    close in class java.io.Reader
    +
    Throws:
    +
    java.io.IOException
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + 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 @@ + + + + + +Configuration (Forge API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- net.minecraftforge.common.config.Configuration
+

+
+
+
```
public class Configuration
+extends java.lang.Object
```
+
This class offers advanced configurations capabilities, allowing to provide + various categories for configuration variables.
+

+ +

+ + +
Nested Class Summary
+ + + + + + + + + + +
Nested Classes
Modifier and Type Class and Description
static class Configuration.UnicodeInputStreamReader
+

Nested Classes
Modifier and Type	Class and Description
`static class`	`Configuration.UnicodeInputStreamReader`

+ +

+ + +

Field Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ALLOWED_CHARS`
`static com.google.common.base.CharMatcher`	`allowedProperties`
`static java.lang.String`	`CATEGORY_GENERAL`
`static java.lang.String`	`CATEGORY_SPLITTER`
`static java.lang.String`	`COMMENT_SEPARATOR`
`static java.lang.String`	`DEFAULT_ENCODING`
`java.lang.String`	`defaultEncoding`
`boolean`	`isChild`
`static java.lang.String`	`NEW_LINE`

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + + + + + + + +

Constructors
Constructor and Description
`Configuration()`
`Configuration(java.io.File file)` + Create a configuration file for the file given in parameter. +
`Configuration(java.io.File file, + boolean caseSensitiveCustomCategories)`
`Configuration(java.io.File file, + java.lang.String configVersion)` + Create a configuration file for the file given in parameter with the provided config version number. +
`Configuration(java.io.File file, + java.lang.String configVersion, + boolean caseSensitiveCustomCategories)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`void`	`addCustomCategoryComment(java.lang.String category, + java.lang.String comment)`
`void`	`copyCategoryProps(Configuration fromConfig, + java.lang.String[] ctgys)` + Copies property objects from another Configuration object to this one using the list of category names. +
`static void`	`enableGlobalConfig()`
`Property`	`get(java.lang.String category, + java.lang.String key, + boolean defaultValue)` + Gets a boolean Property object without a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + boolean[] defaultValues)` + Gets a boolean array Property without a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment)` + Gets a boolean array Property with a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + boolean[] defaultValues, + java.lang.String comment, + boolean isListLengthFixed, + int maxListLength)` + Gets a boolean array Property with all settings defined. +
`Property`	`get(java.lang.String category, + java.lang.String key, + boolean defaultValue, + java.lang.String comment)` + Gets a boolean Property object with a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double defaultValue)` + Gets a double Property object without a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double[] defaultValues)` + Gets a double array Property object without a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment)` + Gets a double array Property object without a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue)` + Gets a double array Property object with the defined comment, minimum and maximum bounds. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double[] defaultValues, + java.lang.String comment, + double minValue, + double maxValue, + boolean isListLengthFixed, + int maxListLength)` + Gets a double array Property object with all settings defined. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment)` + Gets a double Property object with a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + double defaultValue, + java.lang.String comment, + double minValue, + double maxValue)` + Gets a double Property object with the defined comment, minimum and maximum bounds +
`Property`	`get(java.lang.String category, + java.lang.String key, + int defaultValue)` + Gets an integer Property object without a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + int[] defaultValues)` + Gets an integer array Property object without a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment)` + Gets an integer array Property object with a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue)` + Gets an integer array Property object with the defined comment, minimum and maximum bounds. +
`Property`	`get(java.lang.String category, + java.lang.String key, + int[] defaultValues, + java.lang.String comment, + int minValue, + int maxValue, + boolean isListLengthFixed, + int maxListLength)` + Gets an integer array Property object with all settings defined. +
`Property`	`get(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment)` + Gets an integer Property object with a comment using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + int defaultValue, + java.lang.String comment, + int minValue, + int maxValue)` + Gets an integer Property object with the defined comment, minimum and maximum bounds. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue)` + Gets a string Property without a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues)` + Gets a string array Property without a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment)` + Gets a string array Property with a comment using the default settings. +
`Property`	`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)` + Gets a string array Property with a comment with all settings defined. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + java.util.regex.Pattern validationPattern)` + Gets a string array Property with a comment using the defined validationPattern and otherwise default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String[] defaultValues, + java.lang.String comment, + Property.Type type)` + Gets a list (array) Property object of the specified type using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment)` + Gets a string Property with a comment using the default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.util.regex.Pattern validationPattern)` + Gets a string Property with a comment using the defined validationPattern and otherwise default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + Property.Type type)` + Gets a Property object of the specified type using default settings. +
`Property`	`get(java.lang.String category, + java.lang.String key, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues)` + Gets a string Property with a comment using the defined validValues array and otherwise default settings. +
`boolean`	`getBoolean(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment)` + Creates a boolean property. +
`boolean`	`getBoolean(java.lang.String name, + java.lang.String category, + boolean defaultValue, + java.lang.String comment, + java.lang.String langKey)` + Creates a boolean property. +
`ConfigCategory`	`getCategory(java.lang.String category)`
`java.util.Set<java.lang.String>`	`getCategoryNames()`
`java.io.File`	`getConfigFile()`
`java.lang.String`	`getDefinedConfigVersion()`
`float`	`getFloat(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment)` + Creates a float property. +
`float`	`getFloat(java.lang.String name, + java.lang.String category, + float defaultValue, + float minValue, + float maxValue, + java.lang.String comment, + java.lang.String langKey)` + Creates a float property. +
`int`	`getInt(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment)` + Creates a integer property. +
`int`	`getInt(java.lang.String name, + java.lang.String category, + int defaultValue, + int minValue, + int maxValue, + java.lang.String comment, + java.lang.String langKey)` + Creates a integer property. +
`java.lang.String`	`getLoadedConfigVersion()`
`java.lang.String`	`getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment)` + Creates a string property. +
`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)` + Creates a string property. +
`java.lang.String`	`getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String langKey)` + Creates a string property. +
`java.lang.String`	`getString(java.lang.String name, + java.lang.String category, + java.lang.String defaultValue, + java.lang.String comment, + java.lang.String[] validValues)` + Creates a string property. +
`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)` + Creates a string property. +
`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)` + Creates a string property. +
`java.lang.String[]`	`getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValues, + java.lang.String comment)` + Creates a string list property. +
`java.lang.String[]`	`getStringList(java.lang.String name, + java.lang.String category, + java.lang.String[] defaultValue, + java.lang.String comment, + java.lang.String[] validValues)` + Creates a string list property. +
`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)` + Creates a string list property. +
`boolean`	`hasCategory(java.lang.String category)`
`boolean`	`hasChanged()`
`boolean`	`hasKey(java.lang.String category, + java.lang.String key)`
`void`	`load()`
`boolean`	`moveProperty(java.lang.String oldCategory, + java.lang.String propName, + java.lang.String newCategory)` + Moves a property from one category to another. +
`void`	`removeCategory(ConfigCategory category)`
`boolean`	`renameProperty(java.lang.String category, + java.lang.String oldPropName, + java.lang.String newPropName)` + Renames a property in a given category. +
`void`	`save()`
`Configuration`	`setCategoryComment(java.lang.String category, + java.lang.String comment)` + Adds a comment to the specified ConfigCategory object +
`Configuration`	`setCategoryConfigEntryClass(java.lang.String category, + java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)` + 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). +
`Configuration`	`setCategoryLanguageKey(java.lang.String category, + java.lang.String langKey)` + Adds a language key to the specified ConfigCategory object +
`Configuration`	`setCategoryPropertyOrder(java.lang.String category, + java.util.List<java.lang.String> propOrder)` + 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. +
`Configuration`	`setCategoryRequiresMcRestart(java.lang.String category, + boolean requiresMcRestart)` + Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. +
`Configuration`	`setCategoryRequiresWorldRestart(java.lang.String category, + boolean requiresWorldRestart)` + Sets the flag for whether or not this category can be edited while a world is running. +
`java.lang.String`	`toString()`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    CATEGORY_GENERAL
    +
```
public static final java.lang.String CATEGORY_GENERAL
```
    +
    See Also:
    Constant Field Values
    +
  + + + +
  - +
    ALLOWED_CHARS
    +
```
public static final java.lang.String ALLOWED_CHARS
```
    +
    See Also:
    Constant Field Values
    +
  + + + +
  - +
    DEFAULT_ENCODING
    +
```
public static final java.lang.String DEFAULT_ENCODING
```
    +
    See Also:
    Constant Field Values
    +
  + + + +
  - +
    CATEGORY_SPLITTER
    +
```
public static final java.lang.String CATEGORY_SPLITTER
```
    +
    See Also:
    Constant Field Values
    +
  + + + +
  - +
    NEW_LINE
    +
```
public static final java.lang.String NEW_LINE
```
    +
  + + + +
  - +
    COMMENT_SEPARATOR
    +
```
public static final java.lang.String COMMENT_SEPARATOR
```
    +
    See Also:
    Constant Field Values
    +
  + + + +
  - +
    allowedProperties
    +
```
public static final com.google.common.base.CharMatcher allowedProperties
```
    +
  + + + +
  - +
    defaultEncoding
    +
```
public java.lang.String defaultEncoding
```
    +
  + + + +
  - +
    isChild
    +
```
public boolean isChild
```
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Configuration
    +
```
public Configuration()
```
    +
  + + + +
  - +
    Configuration
    +
```
public Configuration(java.io.File file)
```
    +
    Create a configuration file for the file given in parameter.
    +
  + + + +
  - +
    Configuration
    +
```
public Configuration(java.io.File file,
+             java.lang.String configVersion)
```
    +
    Create a configuration file for the file given in parameter with the provided config version number.
    +
  + + + +
  - +
    Configuration
    +
```
public Configuration(java.io.File file,
+             java.lang.String configVersion,
+             boolean caseSensitiveCustomCategories)
```
    +
  + + + +
  - +
    Configuration
    +
```
public Configuration(java.io.File file,
+             boolean caseSensitiveCustomCategories)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    toString
    +
```
public java.lang.String toString()
```
    +
    +
    Overrides:
    +
    toString in class java.lang.Object
    +
    +
  + + + +
  - +
    getDefinedConfigVersion
    +
```
public java.lang.String getDefinedConfigVersion()
```
    +
  + + + +
  - +
    getLoadedConfigVersion
    +
```
public java.lang.String getLoadedConfigVersion()
```
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean defaultValue)
```
    +
    Gets a boolean Property object without a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    +
    Returns:
    a boolean Property object without a comment
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean defaultValue,
+           java.lang.String comment)
```
    +
    Gets a boolean Property object with a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    +
    Returns:
    a boolean Property object without a comment
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean[] defaultValues)
```
    +
    Gets a boolean array Property without a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    +
    Returns:
    a boolean array Property without a comment using these defaults: isListLengthFixed = false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean[] defaultValues,
+           java.lang.String comment)
```
    +
    Gets a boolean array Property with a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    +
    Returns:
    a boolean array Property with a comment using these defaults: isListLengthFixed = false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           boolean[] defaultValues,
+           java.lang.String comment,
+           boolean isListLengthFixed,
+           int maxListLength)
```
    +
    Gets a boolean array Property with all settings defined.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
    maxListLength - the maximum length of this array, use -1 for no max length
    +
    Returns:
    a boolean array Property with all settings defined
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int defaultValue)
```
    +
    Gets an integer Property object without a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    +
    Returns:
    an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int defaultValue,
+           java.lang.String comment)
```
    +
    Gets an integer Property object with a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    +
    Returns:
    an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int defaultValue,
+           java.lang.String comment,
+           int minValue,
+           int maxValue)
```
    +
    Gets an integer Property object with the defined comment, minimum and maximum bounds.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    minValue - minimum boundary
    maxValue - maximum boundary
    +
    Returns:
    an integer Property object with the defined comment, minimum and maximum bounds
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues)
```
    +
    Gets an integer array Property object without a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    +
    Returns:
    an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues,
+           java.lang.String comment)
```
    +
    Gets an integer array Property object with a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    +
    Returns:
    an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues,
+           java.lang.String comment,
+           int minValue,
+           int maxValue)
```
    +
    Gets an integer array Property object with the defined comment, minimum and maximum bounds.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    minValue - minimum boundary
    maxValue - maximum boundary
    +
    Returns:
    an integer array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed + = false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           int[] defaultValues,
+           java.lang.String comment,
+           int minValue,
+           int maxValue,
+           boolean isListLengthFixed,
+           int maxListLength)
```
    +
    Gets an integer array Property object with all settings defined.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    minValue - minimum boundary
    maxValue - maximum boundary
    isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
    maxListLength - the maximum length of this array, use -1 for no max length
    +
    Returns:
    an integer array Property object with all settings defined
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double defaultValue)
```
    +
    Gets a double Property object without a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    +
    Returns:
    a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double defaultValue,
+           java.lang.String comment)
```
    +
    Gets a double Property object with a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    +
    Returns:
    a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double defaultValue,
+           java.lang.String comment,
+           double minValue,
+           double maxValue)
```
    +
    Gets a double Property object with the defined comment, minimum and maximum bounds
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    minValue - minimum boundary
    maxValue - maximum boundary
    +
    Returns:
    a double Property object with the defined comment, minimum and maximum bounds
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues)
```
    +
    Gets a double array Property object without a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    +
    Returns:
    a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues,
+           java.lang.String comment)
```
    +
    Gets a double array Property object without a comment using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    +
    Returns:
    a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, + maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues,
+           java.lang.String comment,
+           double minValue,
+           double maxValue)
```
    +
    Gets a double array Property object with the defined comment, minimum and maximum bounds.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    minValue - minimum boundary
    maxValue - maximum boundary
    +
    Returns:
    a double array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed = + false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           double[] defaultValues,
+           java.lang.String comment,
+           double minValue,
+           double maxValue,
+           boolean isListLengthFixed,
+           int maxListLength)
```
    +
    Gets a double array Property object with all settings defined.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    minValue - minimum boundary
    maxValue - maximum boundary
    isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
    maxListLength - the maximum length of this array, use -1 for no max length
    +
    Returns:
    a double array Property object with all settings defined
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue)
```
    +
    Gets a string Property without a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    +
    Returns:
    a string Property with validationPattern = null, validValues = null
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment)
```
    +
    Gets a string Property with a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    +
    Returns:
    a string Property with validationPattern = null, validValues = null
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment,
+           java.util.regex.Pattern validationPattern)
```
    +
    Gets a string Property with a comment using the defined validationPattern and otherwise default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    validationPattern - a Pattern object for input validation
    +
    Returns:
    a string Property with the defined validationPattern, validValues = null
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment,
+           java.lang.String[] validValues)
```
    +
    Gets a string Property with a comment using the defined validValues array and otherwise default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    validValues - 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.
    +
    Returns:
    a string Property with the defined validValues array, validationPattern = null
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues)
```
    +
    Gets a string array Property without a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    +
    Returns:
    a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment)
```
    +
    Gets a string array Property with a comment using the default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    +
    Returns:
    a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment,
+           java.util.regex.Pattern validationPattern)
```
    +
    Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    validationPattern - a Pattern object for input validation
    +
    Returns:
    a string array Property with the defined validationPattern, isListLengthFixed = false, maxListLength = -1
    +
  + + + +
  - +
    get
    +
```
public Property 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)
```
    +
    Gets a string array Property with a comment with all settings defined.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array + length or maxListLength)
    maxListLength - the maximum length of this array, use -1 for no max length
    validationPattern - a Pattern object for input validation
    +
    Returns:
    a string array Property with a comment with all settings defined
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String defaultValue,
+           java.lang.String comment,
+           Property.Type type)
```
    +
    Gets a Property object of the specified type using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValue - the default value
    comment - a String comment
    type - a Property.Type enum value
    +
    Returns:
    a Property object of the specified type using default settings
    +
  + + + +
  - +
    get
    +
```
public Property get(java.lang.String category,
+           java.lang.String key,
+           java.lang.String[] defaultValues,
+           java.lang.String comment,
+           Property.Type type)
```
    +
    Gets a list (array) Property object of the specified type using default settings.
    +
    Parameters:
    category - the config category
    key - the Property key value
    defaultValues - an array containing the default values
    comment - a String comment
    type - a Property.Type enum value
    +
    Returns:
    a list (array) Property object of the specified type using default settings
    +
  + + + +
  - +
    hasCategory
    +
```
public boolean hasCategory(java.lang.String category)
```
    +
  + + + +
  - +
    hasKey
    +
```
public boolean hasKey(java.lang.String category,
+             java.lang.String key)
```
    +
  + + + +
  - +
    load
    +
```
public void load()
```
    +
  + + + +
  - +
    save
    +
```
public void save()
```
    +
  + + + +
  - +
    getCategory
    +
```
public ConfigCategory getCategory(java.lang.String category)
```
    +
  + + + +
  - +
    removeCategory
    +
```
public void removeCategory(ConfigCategory category)
```
    +
  + + + +
  - +
    setCategoryComment
    +
```
public Configuration setCategoryComment(java.lang.String category,
+                               java.lang.String comment)
```
    +
    Adds a comment to the specified ConfigCategory object
    +
    Parameters:
    category - the config category
    comment - a String comment
    +
  + + + +
  - +
    addCustomCategoryComment
    +
```
public void addCustomCategoryComment(java.lang.String category,
+                            java.lang.String comment)
```
    +
  + + + +
  - +
    setCategoryLanguageKey
    +
```
public Configuration setCategoryLanguageKey(java.lang.String category,
+                                   java.lang.String langKey)
```
    +
    Adds a language key to the specified ConfigCategory object
    +
    Parameters:
    category - the config category
    langKey - a language key string such as configcategory.general
    +
  + + + +
  - +
    setCategoryConfigEntryClass
    +
```
public Configuration setCategoryConfigEntryClass(java.lang.String category,
+                                        java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
```
    +
    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: GuiConfig (the parent + GuiConfig screen will be provided), GuiPropertyList (the parent GuiPropertyList will be provided), IConfigElement + (the IConfigElement for this Property will be provided).
    +
  + + + +
  - +
    setCategoryRequiresWorldRestart
    +
```
public Configuration setCategoryRequiresWorldRestart(java.lang.String category,
+                                            boolean requiresWorldRestart)
```
    +
    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.
    +
  + + + +
  - +
    setCategoryRequiresMcRestart
    +
```
public Configuration setCategoryRequiresMcRestart(java.lang.String category,
+                                         boolean requiresMcRestart)
```
    +
    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.
    +
  + + + +
  - +
    setCategoryPropertyOrder
    +
```
public Configuration setCategoryPropertyOrder(java.lang.String category,
+                                     java.util.List<java.lang.String> propOrder)
```
    +
    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.
    +
  + + + +
  - +
    enableGlobalConfig
    +
```
public static void enableGlobalConfig()
```
    +
  + + + +
  - +
    hasChanged
    +
```
public boolean hasChanged()
```
    +
  + + + +
  - +
    getCategoryNames
    +
```
public java.util.Set<java.lang.String> getCategoryNames()
```
    +
  + + + +
  - +
    renameProperty
    +
```
public boolean renameProperty(java.lang.String category,
+                     java.lang.String oldPropName,
+                     java.lang.String newPropName)
```
    +
    Renames a property in a given category.
    +
    Parameters:
    category - the category in which the property resides
    oldPropName - the existing property name
    newPropName - the new property name
    +
    Returns:
    true if the category and property exist, false otherwise
    +
  + + + +
  - +
    moveProperty
    +
```
public boolean moveProperty(java.lang.String oldCategory,
+                   java.lang.String propName,
+                   java.lang.String newCategory)
```
    +
    Moves a property from one category to another.
    +
    Parameters:
    oldCategory - the category the property currently resides in
    propName - the name of the property to move
    newCategory - the category the property should be moved to
    +
    Returns:
    true if the old category and property exist, false otherwise
    +
  + + + +
  - +
    copyCategoryProps
    +
```
public void copyCategoryProps(Configuration fromConfig,
+                     java.lang.String[] ctgys)
```
    +
    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.
    +
  + + + +
  - +
    getString
    +
```
public java.lang.String getString(java.lang.String name,
+                         java.lang.String category,
+                         java.lang.String defaultValue,
+                         java.lang.String comment)
```
    +
    Creates a string property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getString
    +
```
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)
```
    +
    Creates a string property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    langKey - A language key used for localization of GUIs
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getString
    +
```
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)
```
    +
    Creates a string property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getString
    +
```
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)
```
    +
    Creates a string property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    langKey - A language key used for localization of GUIs
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getString
    +
```
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)
```
    +
    Creates a string property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    validValues - A list of valid values that this property can be set to.
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getString
    +
```
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)
```
    +
    Creates a string property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    validValues - A list of valid values that this property can be set to.
    langKey - A language key used for localization of GUIs
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getStringList
    +
```
public java.lang.String[] getStringList(java.lang.String name,
+                               java.lang.String category,
+                               java.lang.String[] defaultValues,
+                               java.lang.String comment)
```
    +
    Creates a string list property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getStringList
    +
```
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)
```
    +
    Creates a string list property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getStringList
    +
```
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)
```
    +
    Creates a string list property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new string property.
    +
  + + + +
  - +
    getBoolean
    +
```
public boolean getBoolean(java.lang.String name,
+                 java.lang.String category,
+                 boolean defaultValue,
+                 java.lang.String comment)
```
    +
    Creates a boolean property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new boolean property.
    +
  + + + +
  - +
    getBoolean
    +
```
public boolean getBoolean(java.lang.String name,
+                 java.lang.String category,
+                 boolean defaultValue,
+                 java.lang.String comment,
+                 java.lang.String langKey)
```
    +
    Creates a boolean property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    comment - A brief description what the property does.
    langKey - A language key used for localization of GUIs
    +
    Returns:
    The value of the new boolean property.
    +
  + + + +
  - +
    getInt
    +
```
public int getInt(java.lang.String name,
+         java.lang.String category,
+         int defaultValue,
+         int minValue,
+         int maxValue,
+         java.lang.String comment)
```
    +
    Creates a integer property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    minValue - Minimum value of the property.
    maxValue - Maximum value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new integer property.
    +
  + + + +
  - +
    getInt
    +
```
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)
```
    +
    Creates a integer property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    minValue - Minimum value of the property.
    maxValue - Maximum value of the property.
    comment - A brief description what the property does.
    langKey - A language key used for localization of GUIs
    +
    Returns:
    The value of the new integer property.
    +
  + + + +
  - +
    getFloat
    +
```
public float getFloat(java.lang.String name,
+             java.lang.String category,
+             float defaultValue,
+             float minValue,
+             float maxValue,
+             java.lang.String comment)
```
    +
    Creates a float property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    minValue - Minimum value of the property.
    maxValue - Maximum value of the property.
    comment - A brief description what the property does.
    +
    Returns:
    The value of the new float property.
    +
  + + + +
  - +
    getFloat
    +
```
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)
```
    +
    Creates a float property.
    +
    Parameters:
    name - Name of the property.
    category - Category of the property.
    defaultValue - Default value of the property.
    minValue - Minimum value of the property.
    maxValue - Maximum value of the property.
    comment - A brief description what the property does.
    langKey - A language key used for localization of GUIs
    +
    Returns:
    The value of the new float property.
    +
  + + + +
  - +
    getConfigFile
    +
```
public java.io.File getConfigFile()
```
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + diff --git a/javadoc/net/minecraftforge/common/config/Property.Type.html b/javadoc/net/minecraftforge/common/config/Property.Type.html new file mode 100644 index 0000000..10d5191 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/Property.Type.html @@ -0,0 +1,395 @@ + + + + + +Property.Type (Forge API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Enum Constants |
Field |
Method

Detail:
Enum Constants |
Field |
Method

+ + +

+ + + +

java.lang.Object
+
- java.lang.Enum<Property.Type>
- +
  - net.minecraftforge.common.config.Property.Type
  +
+

+
+
All Implemented Interfaces:
+
java.io.Serializable, java.lang.Comparable<Property.Type>
+
+
+
Enclosing class:
+
Property
+
+
+
+
```
public static enum Property.Type
+extends java.lang.Enum<Property.Type>
```
+

+ +

+ + +
Enum Constant Summary
+ + + + + + + + + + + + + + + + + + + + + + + +
Enum Constants
Enum Constant and Description
BOOLEAN
COLOR
DOUBLE
INTEGER
MOD_ID
STRING
+

Enum Constants
Enum Constant and Description
`BOOLEAN`
`COLOR`
`DOUBLE`
`INTEGER`
`MOD_ID`
`STRING`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`char`	`getID()`
`static Property.Type`	`tryParse(char id)`
`static Property.Type`	`valueOf(java.lang.String name)` + Returns the enum constant of this type with the specified name. +
`static Property.Type[]`	`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

+ + +
Methods inherited from class java.lang.Enum
+clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

+ + +
Methods inherited from class java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Enum Constant Detail
  + + + +
  - +
    STRING
    +
```
public static final Property.Type STRING
```
    +
  + + + +
  - +
    INTEGER
    +
```
public static final Property.Type INTEGER
```
    +
  + + + +
  - +
    BOOLEAN
    +
```
public static final Property.Type BOOLEAN
```
    +
  + + + +
  - +
    DOUBLE
    +
```
public static final Property.Type DOUBLE
```
    +
  + + + +
  - +
    COLOR
    +
```
public static final Property.Type COLOR
```
    +
  + + + +
  - +
    MOD_ID
    +
```
public static final Property.Type MOD_ID
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    values
    +
```
public static Property.Type[] values()
```
    +
    Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
```
+for (Property.Type c : Property.Type.values())
+    System.out.println(c);
+
```
    +
    Returns:
    an array containing the constants of this enum type, in the order they are declared
    +
  + + + +
  - +
    valueOf
    +
```
public static Property.Type valueOf(java.lang.String name)
```
    +
    Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
    +
    Parameters:
    name - the name of the enum constant to be returned.
    +
    Returns:
    the enum constant with the specified name
    +
    Throws:
    +
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    +
    java.lang.NullPointerException - if the argument is null
    +
  + + + +
  - +
    tryParse
    +
```
public static Property.Type tryParse(char id)
```
    +
  + + + +
  - +
    getID
    +
```
public char getID()
```
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Enum Constants |
Field |
Method

Detail:
Enum Constants |
Field |
Method

+ + +

+ + + 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 @@ + + + + + +Property (Forge API) + + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- net.minecraftforge.common.config.Property
+

+
+

public class Property
+extends java.lang.Object

+ +

+ + +
Nested Class Summary
+ + + + + + + + + + +
Nested Classes
Modifier and Type Class and Description
static class Property.Type
+

Nested Classes
Modifier and Type	Class and Description
`static class`	`Property.Type`

+ +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
java.lang.String comment
+

Fields
Modifier and Type	Field and Description
`java.lang.String`	`comment`

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Constructors
Constructor and Description
`Property(java.lang.String name, + java.lang.String[] values, + Property.Type type)`
`Property(java.lang.String name, + java.lang.String[] values, + Property.Type type, + java.lang.String langKey)`
`Property(java.lang.String name, + java.lang.String value, + Property.Type type)`
`Property(java.lang.String name, + java.lang.String value, + Property.Type type, + boolean read)`
`Property(java.lang.String name, + java.lang.String value, + Property.Type type, + boolean read, + java.lang.String langKey)`
`Property(java.lang.String name, + java.lang.String value, + Property.Type type, + java.lang.String langKey)`
`Property(java.lang.String name, + java.lang.String value, + Property.Type type, + java.lang.String[] validValues)`
`Property(java.lang.String name, + java.lang.String value, + Property.Type type, + java.lang.String[] validValues, + java.lang.String langKey)`

+ +

+ + +

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry>`	`getArrayEntryClass()` + 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. +
`boolean`	`getBoolean()` + Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default. +
`boolean`	`getBoolean(boolean _default)` + Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default. +
`boolean[]`	`getBooleanList()` + Returns the boolean value of all values that can + be parsed in the list. +
`java.lang.Class<? extends GuiConfigEntries.IConfigEntry>`	`getConfigEntryClass()` + 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. +
`java.lang.String`	`getDefault()` + Gets the raw String default value of this Property. +
`java.lang.String[]`	`getDefaults()` + Gets the raw String[] default values of this Property. +
`double`	`getDouble()` + Returns the value in this property as a double, if the value is not a valid double, it will return the provided default. +
`double`	`getDouble(double _default)` + Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default. +
`double[]`	`getDoubleList()` + Returns the double value of all values that can + be parsed in the list. +
`int`	`getInt()` + Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default. +
`int`	`getInt(int _default)` + Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default. +
`int[]`	`getIntList()` + Returns the integer value of all values that can + be parsed in the list. +
`java.lang.String`	`getLanguageKey()` + Gets the language key string for this Property. +
`int`	`getMaxListLength()` + Gets the maximum length of this list/array Property. +
`java.lang.String`	`getMaxValue()` + Gets the maximum value. +
`java.lang.String`	`getMinValue()` + Gets the minimum value. +
`java.lang.String`	`getName()` + Gets the name/key for this Property. +
`java.lang.String`	`getString()` + Returns the value in this property as it's raw string. +
`java.lang.String[]`	`getStringList()`
`Property.Type`	`getType()` + Gets the Property.Type enum value for this Property. +
`java.util.regex.Pattern`	`getValidationPattern()` + Gets the Pattern object used to validate user input for this Property. +
`java.lang.String[]`	`getValidValues()` + Gets the array of valid values that this String Property can be set to, or null if not defined. +
`boolean`	`hasChanged()` + Gets the changed status of this Property. +
`boolean`	`isBooleanList()` + Checks if all of current values stored in this property can be converted to a boolean. +
`boolean`	`isBooleanValue()` + Checks if the current value held by this property is a valid boolean value. +
`boolean`	`isDefault()` + Returns whether or not this Property is defaulted. +
`boolean`	`isDoubleList()` + Checks if all of the current values stored in this property can be converted to a double. +
`boolean`	`isDoubleValue()` + Checks if the current value held by this property is a valid double value. +
`boolean`	`isIntList()` + Checks if all of the current values stored in this property can be converted to an integer. +
`boolean`	`isIntValue()` + Checks if the current value stored in this property can be converted to an integer. +
`boolean`	`isList()` + Returns whether or not this Property is a list/array. +
`boolean`	`isListLengthFixed()` + Returns whether or not this list/array has a fixed length. +
`boolean`	`requiresMcRestart()` + Gets whether or not this Property requires Minecraft to be restarted when changed. +
`boolean`	`requiresWorldRestart()` + 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. +
`void`	`set(boolean value)`
`void`	`set(boolean[] values)`
`void`	`set(double value)`
`void`	`set(double[] values)`
`void`	`set(int value)`
`void`	`set(int[] values)`
`void`	`set(java.lang.String value)`
`void`	`set(java.lang.String[] values)`
`Property`	`setArrayEntryClass(java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> clazz)` + Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type. +
`Property`	`setConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)` + Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type. +
`Property`	`setDefaultValue(boolean defaultValue)` + Sets the default boolean value of this Property. +
`Property`	`setDefaultValue(double defaultValue)` + Sets the default double value of this Property. +
`Property`	`setDefaultValue(int defaultValue)` + Sets the default int value of this Property. +
`Property`	`setDefaultValue(java.lang.String defaultValue)` + Sets the default string value of this Property. +
`Property`	`setDefaultValues(boolean[] defaultValues)` + Sets the default boolean[] values of this Property. +
`Property`	`setDefaultValues(double[] defaultValues)` + Sets the default double[] values of this Property +
`Property`	`setDefaultValues(int[] defaultValues)` + Sets the default int[] values of this Property. +
`Property`	`setDefaultValues(java.lang.String[] defaultValues)` + Sets the default String[] values of this Property. +
`Property`	`setIsListLengthFixed(boolean isListLengthFixed)` + Sets the flag for whether this list/array Property has a fixed length. +
`Property`	`setLanguageKey(java.lang.String langKey)` + Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3. +
`Property`	`setMaxListLength(int max)` + Sets the maximum length of this list/array Property. +
`Property`	`setMaxValue(double maxValue)` + Sets the maximum double value of this Property. +
`Property`	`setMaxValue(int maxValue)` + Sets the maximum int value of this Property. +
`Property`	`setMinValue(double minValue)` + Sets the minimum double value of this Property. +
`Property`	`setMinValue(int minValue)` + Sets the minimum int value of this Property. +
`void`	`setName(java.lang.String name)` + Sets the name/key for this Property. +
`Property`	`setRequiresMcRestart(boolean requiresMcRestart)` + Sets whether or not this Property requires Minecraft to be restarted when changed. +
`Property`	`setRequiresWorldRestart(boolean requiresWorldRestart)` + Sets the flag for whether or not this Property can be edited while a world is running. +
`Property`	`setShowInGui(boolean showInGui)` + Sets whether or not this Property should be allowed to show on config GUIs. +
`Property`	`setToDefault()` + Sets the current value(s) of this Property to the default value(s). +
`Property`	`setValidationPattern(java.util.regex.Pattern validationPattern)` + Sets a regex Pattern object used to validate user input for formatted String or String[] properties. +
`Property`	`setValidValues(java.lang.String[] validValues)` + Sets the array of valid values that this String Property can be set to. +
`Property`	`setValue(boolean value)` + Sets the value of this Property to the provided boolean value. +
`Property`	`setValue(double value)` + Sets the value of this Property to the provided double value. +
`Property`	`setValue(int value)` + Sets the value of this Property to the provided int value. +
`Property`	`setValue(java.lang.String value)` + Sets the value of this Property to the provided String value. +
`Property`	`setValues(boolean[] values)` + Sets the values of this Property to the provided boolean[] values. +
`Property`	`setValues(double[] values)` + Sets the values of this Property to the provided double[] values. +
`Property`	`setValues(int[] values)` + Sets the values of this Property to the provided int[] values. +
`Property`	`setValues(java.lang.String[] values)` + Sets the values of this Property to the provided String[] values. +
`boolean`	`showInGui()` + Gets whether or not this Property should be allowed to show on config GUIs. +
`boolean`	`wasRead()` + Determines if this config value was just created, or if it was read from the config file. +

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    comment
    +
```
public java.lang.String comment
```
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        boolean read)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        java.lang.String[] validValues)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        java.lang.String langKey)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        boolean read,
+        java.lang.String langKey)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String value,
+        Property.Type type,
+        java.lang.String[] validValues,
+        java.lang.String langKey)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String[] values,
+        Property.Type type)
```
    +
  + + + +
  - +
    Property
    +
```
public Property(java.lang.String name,
+        java.lang.String[] values,
+        Property.Type type,
+        java.lang.String langKey)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    isDefault
    +
```
public boolean isDefault()
```
    +
    Returns whether or not this Property is defaulted.
    +
    Returns:
    true if the current value(s) is(are) deeply equal to the default value(s)
    +
  + + + +
  - +
    setToDefault
    +
```
public Property setToDefault()
```
    +
    Sets the current value(s) of this Property to the default value(s).
    +
  + + + +
  - +
    getDefault
    +
```
public java.lang.String getDefault()
```
    +
    Gets the raw String default value of this Property. Check for isList() == false first.
    +
    Returns:
    the default value String
    +
  + + + +
  - +
    getDefaults
    +
```
public java.lang.String[] getDefaults()
```
    +
    Gets the raw String[] default values of this Property. Check for isList() == true first.
    +
    Returns:
    the default values String[]
    +
  + + + +
  - +
    setRequiresWorldRestart
    +
```
public Property setRequiresWorldRestart(boolean requiresWorldRestart)
```
    +
    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.
    +
  + + + +
  - +
    requiresWorldRestart
    +
```
public boolean requiresWorldRestart()
```
    +
    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.
    +
  + + + +
  - +
    setShowInGui
    +
```
public Property setShowInGui(boolean showInGui)
```
    +
    Sets whether or not this Property should be allowed to show on config GUIs. + Defaults to true.
    +
  + + + +
  - +
    showInGui
    +
```
public boolean showInGui()
```
    +
    Gets whether or not this Property should be allowed to show on config GUIs. + Defaults to true unless set to false.
    +
  + + + +
  - +
    setRequiresMcRestart
    +
```
public Property setRequiresMcRestart(boolean requiresMcRestart)
```
    +
    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.
    +
  + + + +
  - +
    requiresMcRestart
    +
```
public boolean requiresMcRestart()
```
    +
    Gets whether or not this Property requires Minecraft to be restarted when changed. + Defaults to false unless set to true.
    +
  + + + +
  - +
    setMaxListLength
    +
```
public Property setMaxListLength(int max)
```
    +
    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).
    +
  + + + +
  - +
    getMaxListLength
    +
```
public int getMaxListLength()
```
    +
    Gets the maximum length of this list/array Property. Only important if isList() == true.
    +
  + + + +
  - +
    setIsListLengthFixed
    +
```
public Property setIsListLengthFixed(boolean isListLengthFixed)
```
    +
    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).
    +
  + + + +
  - +
    isListLengthFixed
    +
```
public boolean isListLengthFixed()
```
    +
    Returns whether or not this list/array has a fixed length. Only important if isList() == true.
    +
  + + + +
  - +
    setConfigEntryClass
    +
```
public Property setConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
```
    +
    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: GuiConfig (the owning GuiConfig screen will be provided), + GuiConfigEntries (the owning GuiConfigEntries will be provided), IConfigElement (the IConfigElement for this Property + will be provided).
    +
  + + + +
  - +
    getConfigEntryClass
    +
```
public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
```
    +
    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.
    +
    Returns:
    a class that implements IConfigEntry
    +
  + + + +
  - +
    setArrayEntryClass
    +
```
public Property setArrayEntryClass(java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> clazz)
```
    +
    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: GuiEditList (the owning GuiEditList screen will be provided), + GuiPropertyList (the parent GuiPropertyList will be provided), IConfigProperty (the IConfigProperty for this Property + will be provided).
    +
    Parameters:
    clazz - a class that implements IConfigEntry
    +
  + + + +
  - +
    getArrayEntryClass
    +
```
public java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
```
    +
    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.
    +
    Returns:
    a class that implements IArrayEntry
    +
  + + + +
  - +
    setValidationPattern
    +
```
public Property setValidationPattern(java.util.regex.Pattern validationPattern)
```
    +
    Sets a regex Pattern object used to validate user input for formatted String or String[] properties.
    +
    Parameters:
    validationPattern -
    +
  + + + +
  - +
    getValidationPattern
    +
```
public java.util.regex.Pattern getValidationPattern()
```
    +
    Gets the Pattern object used to validate user input for this Property.
    +
    Returns:
    the user input validation Pattern object, or null if none is set
    +
  + + + +
  - +
    setLanguageKey
    +
```
public Property setLanguageKey(java.lang.String langKey)
```
    +
    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.
    +
    Parameters:
    langKey - a string language key such as myawesomemod.config.myPropName
    +
  + + + +
  - +
    getLanguageKey
    +
```
public java.lang.String getLanguageKey()
```
    +
    Gets the language key string for this Property.
    +
    Returns:
    the language key
    +
  + + + +
  - +
    setDefaultValue
    +
```
public Property setDefaultValue(java.lang.String defaultValue)
```
    +
    Sets the default string value of this Property.
    +
    Parameters:
    defaultValue - a String value
    +
  + + + +
  - +
    setDefaultValues
    +
```
public Property setDefaultValues(java.lang.String[] defaultValues)
```
    +
    Sets the default String[] values of this Property.
    +
    Parameters:
    defaultValues - an array of String values
    +
  + + + +
  - +
    setDefaultValue
    +
```
public Property setDefaultValue(int defaultValue)
```
    +
    Sets the default int value of this Property.
    +
    Parameters:
    defaultValue - an int value
    +
  + + + +
  - +
    setDefaultValues
    +
```
public Property setDefaultValues(int[] defaultValues)
```
    +
    Sets the default int[] values of this Property.
    +
    Parameters:
    defaultValues - an array of int values
    +
  + + + +
  - +
    setDefaultValue
    +
```
public Property setDefaultValue(double defaultValue)
```
    +
    Sets the default double value of this Property.
    +
    Parameters:
    defaultValue - a double value
    +
  + + + +
  - +
    setDefaultValues
    +
```
public Property setDefaultValues(double[] defaultValues)
```
    +
    Sets the default double[] values of this Property
    +
    Parameters:
    defaultValues - an array of double values
    +
  + + + +
  - +
    setDefaultValue
    +
```
public Property setDefaultValue(boolean defaultValue)
```
    +
    Sets the default boolean value of this Property.
    +
    Parameters:
    defaultValue - a boolean value
    +
  + + + +
  - +
    setDefaultValues
    +
```
public Property setDefaultValues(boolean[] defaultValues)
```
    +
    Sets the default boolean[] values of this Property.
    +
    Parameters:
    defaultValues - an array of boolean values
    +
  + + + +
  - +
    setMinValue
    +
```
public Property setMinValue(int minValue)
```
    +
    Sets the minimum int value of this Property.
    +
    Parameters:
    minValue - an int value
    +
  + + + +
  - +
    setMaxValue
    +
```
public Property setMaxValue(int maxValue)
```
    +
    Sets the maximum int value of this Property.
    +
    Parameters:
    maxValue - an int value
    +
  + + + +
  - +
    setMinValue
    +
```
public Property setMinValue(double minValue)
```
    +
    Sets the minimum double value of this Property.
    +
    Parameters:
    minValue - a double value
    +
  + + + +
  - +
    setMaxValue
    +
```
public Property setMaxValue(double maxValue)
```
    +
    Sets the maximum double value of this Property.
    +
    Parameters:
    maxValue - a double value
    +
  + + + +
  - +
    getMinValue
    +
```
public java.lang.String getMinValue()
```
    +
    Gets the minimum value.
    +
    Returns:
    the minimum value bound
    +
  + + + +
  - +
    getMaxValue
    +
```
public java.lang.String getMaxValue()
```
    +
    Gets the maximum value.
    +
    Returns:
    the maximum value bound
    +
  + + + +
  - +
    getString
    +
```
public java.lang.String getString()
```
    +
    Returns the value in this property as it's raw string.
    +
    Returns:
    current value
    +
  + + + +
  - +
    setValidValues
    +
```
public Property setValidValues(java.lang.String[] validValues)
```
    +
    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.
    +
    Parameters:
    validValues - a String array of valid values
    +
  + + + +
  - +
    getValidValues
    +
```
public java.lang.String[] getValidValues()
```
    +
    Gets the array of valid values that this String Property can be set to, or null if not defined.
    +
    Returns:
    a String array of valid values
    +
  + + + +
  - +
    getInt
    +
```
public int getInt()
```
    +
    Returns the value in this property as an integer, + if the value is not a valid integer, it will return the initially provided default.
    +
    Returns:
    The value
    +
  + + + +
  - +
    getInt
    +
```
public int getInt(int _default)
```
    +
    Returns the value in this property as an integer, + if the value is not a valid integer, it will return the + provided default.
    +
    Parameters:
    _default - The default to provide if the current value is not a valid integer
    +
    Returns:
    The value
    +
  + + + +
  - +
    isIntValue
    +
```
public boolean isIntValue()
```
    +
    Checks if the current value stored in this property can be converted to an integer.
    +
    Returns:
    True if the type of the Property is an Integer
    +
  + + + +
  - +
    getBoolean
    +
```
public boolean getBoolean(boolean _default)
```
    +
    Returns the value in this property as a boolean, + if the value is not a valid boolean, it will return the + provided default.
    +
    Parameters:
    _default - The default to provide
    +
    Returns:
    The value as a boolean, or the default
    +
  + + + +
  - +
    getBoolean
    +
```
public boolean getBoolean()
```
    +
    Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.
    +
    Returns:
    The value as a boolean, or the default
    +
  + + + +
  - +
    isBooleanValue
    +
```
public boolean isBooleanValue()
```
    +
    Checks if the current value held by this property is a valid boolean value.
    +
    Returns:
    True if it is a boolean value
    +
  + + + +
  - +
    isDoubleValue
    +
```
public boolean isDoubleValue()
```
    +
    Checks if the current value held by this property is a valid double value.
    +
    Returns:
    True if the value can be converted to an double
    +
  + + + +
  - +
    getDouble
    +
```
public double getDouble(double _default)
```
    +
    Returns the value in this property as a double, + if the value is not a valid double, it will return the + provided default.
    +
    Parameters:
    _default - The default to provide if the current value is not a valid double
    +
    Returns:
    The value
    +
  + + + +
  - +
    getDouble
    +
```
public double getDouble()
```
    +
    Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.
    +
    Parameters:
    _default - The default to provide if the current value is not a valid double
    +
    Returns:
    The value
    +
  + + + +
  - +
    getStringList
    +
```
public java.lang.String[] getStringList()
```
    +
  + + + +
  - +
    getIntList
    +
```
public int[] getIntList()
```
    +
    Returns the integer value of all values that can + be parsed in the list.
    +
    Returns:
    Array of length 0 if none of the values could be parsed.
    +
  + + + +
  - +
    isIntList
    +
```
public boolean isIntList()
```
    +
    Checks if all of the current values stored in this property can be converted to an integer.
    +
    Returns:
    True if the type of the Property is an Integer List
    +
  + + + +
  - +
    getBooleanList
    +
```
public boolean[] getBooleanList()
```
    +
    Returns the boolean value of all values that can + be parsed in the list.
    +
    Returns:
    Array of length 0 if none of the values could be parsed.
    +
  + + + +
  - +
    isBooleanList
    +
```
public boolean isBooleanList()
```
    +
    Checks if all of current values stored in this property can be converted to a boolean.
    +
    Returns:
    True if it is a boolean value
    +
  + + + +
  - +
    getDoubleList
    +
```
public double[] getDoubleList()
```
    +
    Returns the double value of all values that can + be parsed in the list.
    +
    Returns:
    Array of length 0 if none of the values could be parsed.
    +
  + + + +
  - +
    isDoubleList
    +
```
public boolean isDoubleList()
```
    +
    Checks if all of the current values stored in this property can be converted to a double.
    +
    Returns:
    True if the type of the Property is a double List
    +
  + + + +
  - +
    getName
    +
```
public java.lang.String getName()
```
    +
    Gets the name/key for this Property.
    +
    Returns:
    the Property name
    +
  + + + +
  - +
    setName
    +
```
public void setName(java.lang.String name)
```
    +
    Sets the name/key for this Property.
    +
    Parameters:
    name - a name
    +
  + + + +
  - +
    wasRead
    +
```
public boolean wasRead()
```
    +
    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.
    +
    Returns:
    True if this property was loaded from the config file with a value
    +
  + + + +
  - +
    getType
    +
```
public Property.Type getType()
```
    +
    Gets the Property.Type enum value for this Property.
    +
    Returns:
    the Property's type
    +
  + + + +
  - +
    isList
    +
```
public boolean isList()
```
    +
    Returns whether or not this Property is a list/array.
    +
    Returns:
    true if this Property is a list/array, false otherwise
    +
  + + + +
  - +
    hasChanged
    +
```
public boolean hasChanged()
```
    +
    Gets the changed status of this Property.
    +
    Returns:
    true if this Property has changed, false otherwise
    +
  + + + +
  - +
    setValue
    +
```
public Property setValue(java.lang.String value)
```
    +
    Sets the value of this Property to the provided String value.
    +
  + + + +
  - +
    set
    +
```
public void set(java.lang.String value)
```
    +
  + + + +
  - +
    setValues
    +
```
public Property setValues(java.lang.String[] values)
```
    +
    Sets the values of this Property to the provided String[] values.
    +
  + + + +
  - +
    set
    +
```
public void set(java.lang.String[] values)
```
    +
  + + + +
  - +
    setValue
    +
```
public Property setValue(int value)
```
    +
    Sets the value of this Property to the provided int value.
    +
  + + + +
  - +
    setValue
    +
```
public Property setValue(boolean value)
```
    +
    Sets the value of this Property to the provided boolean value.
    +
  + + + +
  - +
    setValue
    +
```
public Property setValue(double value)
```
    +
    Sets the value of this Property to the provided double value.
    +
  + + + +
  - +
    setValues
    +
```
public Property setValues(boolean[] values)
```
    +
    Sets the values of this Property to the provided boolean[] values.
    +
  + + + +
  - +
    set
    +
```
public void set(boolean[] values)
```
    +
  + + + +
  - +
    setValues
    +
```
public Property setValues(int[] values)
```
    +
    Sets the values of this Property to the provided int[] values.
    +
  + + + +
  - +
    set
    +
```
public void set(int[] values)
```
    +
  + + + +
  - +
    setValues
    +
```
public Property setValues(double[] values)
```
    +
    Sets the values of this Property to the provided double[] values.
    +
  + + + +
  - +
    set
    +
```
public void set(double[] values)
```
    +
  + + + +
  - +
    set
    +
```
public void set(int value)
```
    +
  + + + +
  - +
    set
    +
```
public void set(boolean value)
```
    +
  + + + +
  - +
    set
    +
```
public void set(double value)
```
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + diff --git a/javadoc/net/minecraftforge/common/config/package-frame.html b/javadoc/net/minecraftforge/common/config/package-frame.html new file mode 100644 index 0000000..cda5878 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-frame.html @@ -0,0 +1,27 @@ + + + + + +net.minecraftforge.common.config (Forge API) + + + + +

net.minecraftforge.common.config

Classes

Enums

Property.Type

+ + diff --git a/javadoc/net/minecraftforge/common/config/package-summary.html b/javadoc/net/minecraftforge/common/config/package-summary.html new file mode 100644 index 0000000..4ff72e5 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-summary.html @@ -0,0 +1,167 @@ + + + + + +net.minecraftforge.common.config (Forge API) + + + + + + + +

+ + + + +

Prev Package
Next Package

Frames
No Frames

All Classes

+ +

+ + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Class Summary
Class	Description
ConfigCategory
ConfigElement<T>	+ This class bridges the gap between the FML config GUI classes and the Forge Configuration classes. +
Configuration	+ This class offers advanced configurations capabilities, allowing to provide + various categories for configuration variables. +
Configuration.UnicodeInputStreamReader
Property

+ + + + + + + + + + + + +
Enum Summary
Enum Description
Property.Type
+

Enum Summary
Enum	Description
Property.Type

+ +

+ + + + +

Prev Package
Next Package

Frames
No Frames

All Classes

+ +

+ + +

+ + + diff --git a/javadoc/net/minecraftforge/common/config/package-tree.html b/javadoc/net/minecraftforge/common/config/package-tree.html new file mode 100644 index 0000000..894fc23 --- /dev/null +++ b/javadoc/net/minecraftforge/common/config/package-tree.html @@ -0,0 +1,146 @@ + + + + + +net.minecraftforge.common.config Class Hierarchy (Forge API) + + + + + + + +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

Class Hierarchy

java.lang.Object +
- net.minecraftforge.common.config.ConfigCategory (implements java.util.Map<K,V>)
- net.minecraftforge.common.config.ConfigElement<T> (implements cpw.mods.fml.client.config.IConfigElement<T>)
- net.minecraftforge.common.config.Configuration
- net.minecraftforge.common.config.Property
- java.io.Reader (implements java.io.Closeable, java.lang.Readable) +
  - net.minecraftforge.common.config.Configuration.UnicodeInputStreamReader
  +
+

Enum Hierarchy

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
  - net.minecraftforge.common.config.Property.Type
  +
+

+ +

+ + + + +

Frames
No Frames

All Classes

+ +

+ + +

+ + + -- cgit v1.2.3

Class ConfigCategory

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

parent

Constructor Detail

ConfigCategory

ConfigCategory

Method Detail

equals

getName

getQualifiedName

getQualifiedName

getFirstParent

isChild

getValues

getOrderedValues

setConfigEntryClass

getConfigEntryClass

setLanguageKey

getLanguagekey

setComment

getComment

setRequiresWorldRestart

requiresWorldRestart

setShowInGui

showInGui

setRequiresMcRestart

requiresMcRestart

setPropertyOrder

getPropertyOrder

containsKey

get

write

hasChanged

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

getChildren

removeChild

Class ConfigElement<T>

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

is

Constructor Detail

ConfigElement

ConfigElement

Method Detail

listCategoriesFirst

getChildElements

getTypedElement

getName

isProperty

getConfigEntryClass

getArrayEntryClass

getQualifiedName

getType

getType

isList

isListLengthFixed

getMaxListLength

getComment

isDefault