From 877312184c472d9845e5ef1008bc538f4634059f Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:50:56 +0300 Subject: fix missing source folder --- .../common/config/ConfigElement.html | 919 --------------------- 1 file changed, 919 deletions(-) delete mode 100644 javadoc/net/minecraftforge/common/config/ConfigElement.html (limited to 'javadoc/net/minecraftforge/common/config/ConfigElement.html') diff --git a/javadoc/net/minecraftforge/common/config/ConfigElement.html b/javadoc/net/minecraftforge/common/config/ConfigElement.html deleted file mode 100644 index 886c8a6..0000000 --- a/javadoc/net/minecraftforge/common/config/ConfigElement.html +++ /dev/null @@ -1,919 +0,0 @@ - - - - - -ConfigElement (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.config
-

Class 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 
      TypeProperty and Description
      booleanis -
      [Property, Category] Is this object a property object?
      -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectget() -
      [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.StringgetComment() -
      [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.ObjectgetDefault() -
      [Property] Gets this property's default value.
      -
      java.lang.Object[]getDefaults() -
      [Property] Gets this property's default values.
      -
      java.lang.StringgetLanguageKey() -
      [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.
      -
      intgetMaxListLength() -
      [Property] Gets the max length of this list property, or -1 if the length is unlimited.
      -
      TgetMaxValue() -
      [Property] Gets this property's maximum value.
      -
      TgetMinValue() -
      [Property] Gets this property's minimum value.
      -
      java.lang.StringgetName() -
      [Property, Category] Gets the name of this object.
      -
      java.lang.StringgetQualifiedName() -
      [Category] Gets the qualified name of this object.
      -
      ConfigGuiTypegetType() -
      [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a - category object.
      -
      static ConfigGuiTypegetType(Property prop) 
      static ConfigElement<?>getTypedElement(Property prop) 
      java.util.regex.PatterngetValidationPattern() -
      [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.
      -
      booleanisDefault() -
      [Property] Is this property value equal to the default value?
      -
      booleanisList() -
      [Property] Is this property object a list?
      -
      booleanisListLengthFixed() -
      [Property] Does this list property have to remain a fixed length?
      -
      booleanisProperty() -
      [Property, Category] Is this object a property object?
      -
      ConfigElement<T>listCategoriesFirst(boolean categoriesFirst) 
      booleanrequiresMcRestart() -
      [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
      -
      booleanrequiresWorldRestart() -
      [Property, Category] Whether or not this element is safe to modify while a world is running.
      -
      voidset(T value) -
      [Property] Sets this property's value.
      -
      voidset(T[] aVal) -
      [Property] Sets this property's value to the specified array.
      -
      voidsetToDefault() -
      [Property] Sets this property's value to the default value.
      -
      booleanshowInGui() -
      [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
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - - - - - -
        -
      • -

        ConfigElement

        -
        public ConfigElement(Property prop)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        listCategoriesFirst

        -
        public ConfigElement<T> listCategoriesFirst(boolean categoriesFirst)
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        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>
        -
        -
        • -
      - - - - - - - -
        -
      • -

        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>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - -- cgit v1.2.3