From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- .../cpw/mods/fml/client/config/ConfigGuiType.html | 377 ++++++ .../DummyConfigElement.DummyCategoryElement.html | 331 +++++ .../DummyConfigElement.DummyListElement.html | 600 +++++++++ .../mods/fml/client/config/DummyConfigElement.html | 1353 ++++++++++++++++++++ .../cpw/mods/fml/client/config/GuiButtonExt.html | 349 +++++ .../cpw/mods/fml/client/config/GuiCheckBox.html | 364 ++++++ javadoc/cpw/mods/fml/client/config/GuiConfig.html | 768 +++++++++++ .../client/config/GuiConfigEntries.ArrayEntry.html | 563 ++++++++ .../config/GuiConfigEntries.BooleanEntry.html | 511 ++++++++ .../config/GuiConfigEntries.ButtonEntry.html | 540 ++++++++ .../config/GuiConfigEntries.CategoryEntry.html | 772 +++++++++++ .../config/GuiConfigEntries.ChatColorEntry.html | 339 +++++ .../config/GuiConfigEntries.CycleValueEntry.html | 529 ++++++++ .../config/GuiConfigEntries.DoubleEntry.html | 426 ++++++ .../config/GuiConfigEntries.IConfigEntry.html | 501 ++++++++ .../config/GuiConfigEntries.IntegerEntry.html | 426 ++++++ .../config/GuiConfigEntries.ListEntryBase.html | 936 ++++++++++++++ .../config/GuiConfigEntries.NumberSliderEntry.html | 536 ++++++++ .../config/GuiConfigEntries.SelectValueEntry.html | 583 +++++++++ .../config/GuiConfigEntries.StringEntry.html | 603 +++++++++ .../mods/fml/client/config/GuiConfigEntries.html | 856 +++++++++++++ .../cpw/mods/fml/client/config/GuiEditArray.html | 540 ++++++++ .../config/GuiEditArrayEntries.BaseEntry.html | 569 ++++++++ .../config/GuiEditArrayEntries.BooleanEntry.html | 422 ++++++ .../config/GuiEditArrayEntries.DoubleEntry.html | 342 +++++ .../config/GuiEditArrayEntries.IArrayEntry.html | 297 +++++ .../config/GuiEditArrayEntries.IntegerEntry.html | 341 +++++ .../config/GuiEditArrayEntries.StringEntry.html | 431 +++++++ .../fml/client/config/GuiEditArrayEntries.html | 694 ++++++++++ .../mods/fml/client/config/GuiMessageDialog.html | 322 +++++ .../mods/fml/client/config/GuiSelectString.html | 510 ++++++++ .../GuiSelectStringEntries.EntryComparator.html | 276 ++++ ...ectStringEntries.IGuiSelectStringListEntry.html | 224 ++++ .../config/GuiSelectStringEntries.ListEntry.html | 405 ++++++ .../fml/client/config/GuiSelectStringEntries.html | 583 +++++++++ .../mods/fml/client/config/GuiSlider.ISlider.html | 208 +++ javadoc/cpw/mods/fml/client/config/GuiSlider.html | 699 ++++++++++ .../fml/client/config/GuiUnicodeGlyphButton.html | 373 ++++++ javadoc/cpw/mods/fml/client/config/GuiUtils.html | 529 ++++++++ .../cpw/mods/fml/client/config/HoverChecker.html | 344 +++++ .../cpw/mods/fml/client/config/IConfigElement.html | 679 ++++++++++ .../cpw/mods/fml/client/config/package-frame.html | 65 + .../mods/fml/client/config/package-summary.html | 400 ++++++ .../cpw/mods/fml/client/config/package-tree.html | 232 ++++ 44 files changed, 21748 insertions(+) create mode 100644 javadoc/cpw/mods/fml/client/config/ConfigGuiType.html create mode 100644 javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/DummyConfigElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiButtonExt.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiCheckBox.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfig.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArray.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectString.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiSlider.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html create mode 100644 javadoc/cpw/mods/fml/client/config/GuiUtils.html create mode 100644 javadoc/cpw/mods/fml/client/config/HoverChecker.html create mode 100644 javadoc/cpw/mods/fml/client/config/IConfigElement.html create mode 100644 javadoc/cpw/mods/fml/client/config/package-frame.html create mode 100644 javadoc/cpw/mods/fml/client/config/package-summary.html create mode 100644 javadoc/cpw/mods/fml/client/config/package-tree.html (limited to 'javadoc/cpw/mods/fml/client/config') diff --git a/javadoc/cpw/mods/fml/client/config/ConfigGuiType.html b/javadoc/cpw/mods/fml/client/config/ConfigGuiType.html new file mode 100644 index 0000000..b7858b2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/ConfigGuiType.html @@ -0,0 +1,377 @@ + + + + + +ConfigGuiType (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Enum ConfigGuiType

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable, java.lang.Comparable<ConfigGuiType>
    +
    +
    +
    +
    public enum ConfigGuiType
    +extends java.lang.Enum<ConfigGuiType>
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static ConfigGuiTypevalueOf(java.lang.String name) +
      Returns the enum constant of this type with the specified name.
      +
      static ConfigGuiType[]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
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ConfigGuiType[] 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 (ConfigGuiType c : ConfigGuiType.values())
        +    System.out.println(c);
        +
        +
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        +
      • +
      + + + +
        +
      • +

        valueOf

        +
        public static ConfigGuiType 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
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html new file mode 100644 index 0000000..15ac098 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyCategoryElement.html @@ -0,0 +1,331 @@ + + + + + +DummyConfigElement.DummyCategoryElement (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class DummyConfigElement.DummyCategoryElement<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IConfigElement<T>
    +
    +
    +
    Enclosing class:
    +
    DummyConfigElement<T>
    +
    +
    +
    +
    public static class DummyConfigElement.DummyCategoryElement<T>
    +extends DummyConfigElement<T>
    +
    This class provides a Dummy Category IConfigElement. It can be used to define a custom list of GUI entries that will + appear on the child screen or to specify a custom IGuiConfigListEntryfor a special category.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DummyConfigElement.DummyCategoryElement

        +
        public DummyConfigElement.DummyCategoryElement(java.lang.String name,
        +                                       java.lang.String langKey,
        +                                       java.util.List<IConfigElement> childElements)
        +
      • +
      + + + +
        +
      • +

        DummyConfigElement.DummyCategoryElement

        +
        public DummyConfigElement.DummyCategoryElement(java.lang.String name,
        +                                       java.lang.String langKey,
        +                                       java.lang.Class<? extends GuiConfigEntries.IConfigEntry> customListEntryClass)
        +
      • +
      + + + +
        +
      • +

        DummyConfigElement.DummyCategoryElement

        +
        public DummyConfigElement.DummyCategoryElement(java.lang.String name,
        +                                       java.lang.String langKey,
        +                                       java.util.List<IConfigElement> childElements,
        +                                       java.lang.Class<? extends GuiConfigEntries.IConfigEntry> customListEntryClass)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html new file mode 100644 index 0000000..fc4f576 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.DummyListElement.html @@ -0,0 +1,600 @@ + + + + + +DummyConfigElement.DummyListElement (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class DummyConfigElement.DummyListElement<T>

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   boolean isListFixedLength,
        +                                   int maxListLength,
        +                                   java.util.regex.Pattern validStringPattern,
        +                                   T minValue,
        +                                   T maxValue)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   boolean isListFixedLength)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   int maxListLength)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   T minValue,
        +                                   T maxValue)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   boolean isListFixedLength,
        +                                   T minValue,
        +                                   T maxValue)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   int maxListLength,
        +                                   T minValue,
        +                                   T maxValue)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   boolean isListFixedLength,
        +                                   int maxListLength,
        +                                   T minValue,
        +                                   T maxValue)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   java.util.regex.Pattern validStringPattern)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   boolean isListFixedLength,
        +                                   java.util.regex.Pattern validStringPattern)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement.DummyListElement

        +
        public DummyConfigElement.DummyListElement(java.lang.String name,
        +                                   T[] defaultValues,
        +                                   ConfigGuiType type,
        +                                   java.lang.String langKey,
        +                                   int maxListLength,
        +                                   java.util.regex.Pattern validStringPattern)
        +
      • +
      +
    • +
    + + +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/DummyConfigElement.html b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.html new file mode 100644 index 0000000..c6266ea --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/DummyConfigElement.html @@ -0,0 +1,1353 @@ + + + + + +DummyConfigElement (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class DummyConfigElement<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IConfigElement<T>
    +
    +
    +
    Direct Known Subclasses:
    +
    DummyConfigElement.DummyCategoryElement, DummyConfigElement.DummyListElement
    +
    +
    +
    +
    public class DummyConfigElement<T>
    +extends java.lang.Object
    +implements IConfigElement<T>
    +
    This class's main purpose is to provide the necessary objects for a sample Config GUI for FML, although + there may be practical uses for the objects defined here such as using the DummyCategoryElement object as a + wrapper for a custom IGuiConfigListEntry object that opens a special screen.
    +
  • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        isProperty

        +
        protected boolean isProperty
        +
      • +
      + + + +
        +
      • +

        isList

        +
        protected boolean isList
        +
      • +
      + + + + + + + +
        +
      • +

        name

        +
        protected java.lang.String name
        +
      • +
      + + + +
        +
      • +

        langKey

        +
        protected java.lang.String langKey
        +
      • +
      + + + +
        +
      • +

        value

        +
        protected java.lang.Object value
        +
      • +
      + + + +
        +
      • +

        defaultValue

        +
        protected java.lang.Object defaultValue
        +
      • +
      + + + +
        +
      • +

        values

        +
        protected T[] values
        +
      • +
      + + + +
        +
      • +

        defaultValues

        +
        protected T[] defaultValues
        +
      • +
      + + + +
        +
      • +

        validValues

        +
        protected java.lang.String[] validValues
        +
      • +
      + + + +
        +
      • +

        validStringPattern

        +
        protected java.util.regex.Pattern validStringPattern
        +
      • +
      + + + +
        +
      • +

        minValue

        +
        protected T minValue
        +
      • +
      + + + +
        +
      • +

        maxValue

        +
        protected T maxValue
        +
      • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        protected boolean requiresWorldRestart
        +
      • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        protected boolean requiresMcRestart
        +
      • +
      + + + +
        +
      • +

        isListFixedLength

        +
        protected boolean isListFixedLength
        +
      • +
      + + + +
        +
      • +

        maxListLength

        +
        protected int maxListLength
        +
      • +
      + + + +
        +
      • +

        childElements

        +
        protected java.util.List<IConfigElement> childElements
        +
      • +
      + + + + + + + + +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
        +                  T defaultValue,
        +                  ConfigGuiType type,
        +                  java.lang.String langKey,
        +                  java.lang.String[] validValues,
        +                  java.util.regex.Pattern validStringPattern,
        +                  T minValue,
        +                  T maxValue)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
        +                  T defaultValue,
        +                  ConfigGuiType type,
        +                  java.lang.String langKey,
        +                  java.util.regex.Pattern validStringPattern)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
        +                  T defaultValue,
        +                  ConfigGuiType type,
        +                  java.lang.String langKey,
        +                  java.lang.String[] validValues)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
        +                  T defaultValue,
        +                  ConfigGuiType type,
        +                  java.lang.String langKey)
        +
      • +
      + + + + + +
        +
      • +

        DummyConfigElement

        +
        public DummyConfigElement(java.lang.String name,
        +                  T defaultValue,
        +                  ConfigGuiType type,
        +                  java.lang.String langKey,
        +                  T minValue,
        +                  T maxValue)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

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

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

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

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

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

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

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

        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 T[] getDefaults()
        +
        Description copied from interface: IConfigElement
        +
        [Property] Gets this property's default values.
        +
        +
        Specified by:
        +
        getDefaults 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>
        +
        +
      • +
      + + + +
        +
      • +

        setRequiresWorldRestart

        +
        public IConfigElement<T> setRequiresWorldRestart(boolean requiresWorldRestart)
        +
      • +
      + + + +
        +
      • +

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

        setRequiresMcRestart

        +
        public IConfigElement<T> setRequiresMcRestart(boolean requiresMcRestart)
        +
      • +
      + + + +
        +
      • +

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

        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 T[] 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>
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiButtonExt.html b/javadoc/cpw/mods/fml/client/config/GuiButtonExt.html new file mode 100644 index 0000000..efb681c --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiButtonExt.html @@ -0,0 +1,349 @@ + + + + + +GuiButtonExt (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiButtonExt

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    GuiSlider, GuiUnicodeGlyphButton
    +
    +
    +
    +
    public class GuiButtonExt
    +extends GuiButton
    +
    This class provides a button that fixes several bugs present in the vanilla GuiButton drawing code. + The gist of it is that it allows buttons of any size without gaps in the graphics and with the + borders drawn properly. It also prevents button text from extending out of the sides of the button by + trimming the end of the string and adding an ellipsis.

    + + The code that handles drawing the button is in GuiUtils.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiButtonExt

        +
        public GuiButtonExt(int id,
        +            int xPos,
        +            int yPos,
        +            java.lang.String displayString)
        +
      • +
      + + + +
        +
      • +

        GuiButtonExt

        +
        public GuiButtonExt(int id,
        +            int xPos,
        +            int yPos,
        +            int width,
        +            int height,
        +            java.lang.String displayString)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        drawButton

        +
        public void drawButton(Minecraft mc,
        +              int mouseX,
        +              int mouseY)
        +
        Draws this button to the screen.
        +
        +
        Overrides:
        +
        drawButton in class GuiButton
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiCheckBox.html b/javadoc/cpw/mods/fml/client/config/GuiCheckBox.html new file mode 100644 index 0000000..4ca2fc9 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiCheckBox.html @@ -0,0 +1,364 @@ + + + + + +GuiCheckBox (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiCheckBox

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiCheckBox
    +extends GuiButton
    +
    This class provides a checkbox style control.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiCheckBox

        +
        public GuiCheckBox(int id,
        +           int xPos,
        +           int yPos,
        +           java.lang.String displayString,
        +           boolean isChecked)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        mousePressed

        +
        public boolean mousePressed(Minecraft p_146116_1_,
        +                   int p_146116_2_,
        +                   int p_146116_3_)
        +
        +
        Overrides:
        +
        mousePressed in class GuiButton
        +
        +
      • +
      + + + +
        +
      • +

        isChecked

        +
        public boolean isChecked()
        +
      • +
      + + + +
        +
      • +

        setIsChecked

        +
        public void setIsChecked(boolean isChecked)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfig.html b/javadoc/cpw/mods/fml/client/config/GuiConfig.html new file mode 100644 index 0000000..01bb38f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfig.html @@ -0,0 +1,768 @@ + + + + + +GuiConfig (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfig

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parentScreen

        +
        public final GuiScreen parentScreen
        +
        A reference to the screen object that created this. Used for navigating between screens.
        +
      • +
      + + + +
        +
      • +

        title

        +
        public java.lang.String title
        +
      • +
      + + + +
        +
      • +

        titleLine2

        +
        public java.lang.String titleLine2
        +
      • +
      + + + +
        +
      • +

        configElements

        +
        public final java.util.List<IConfigElement> configElements
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        modID

        +
        public final java.lang.String modID
        +
      • +
      + + + +
        +
      • +

        configID

        +
        public final java.lang.String configID
        +
        When set to a non-null value the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed + if any configElements were changed (includes child screens). If not defined, the events will be posted if the parent gui is null + or if the parent gui is not an instance of GuiConfig.
        +
      • +
      + + + +
        +
      • +

        isWorldRunning

        +
        public final boolean isWorldRunning
        +
      • +
      + + + +
        +
      • +

        allRequireWorldRestart

        +
        public final boolean allRequireWorldRestart
        +
      • +
      + + + +
        +
      • +

        allRequireMcRestart

        +
        public final boolean allRequireMcRestart
        +
      • +
      + + + +
        +
      • +

        needsRefresh

        +
        public boolean needsRefresh
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
        +         java.util.List<IConfigElement> configElements,
        +         java.lang.String modID,
        +         java.lang.String configID,
        +         boolean allRequireWorldRestart,
        +         boolean allRequireMcRestart,
        +         java.lang.String title)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. If a non-null value is passed for configID, + the OnConfigChanged and PostConfigChanged events will be posted when the Done button is pressed if any configElements were changed + (includes child screens). If configID is not defined, the events will be posted if the parent gui is null or if the parent gui + is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        configID - an identifier that will be passed to the OnConfigChanged and PostConfigChanged events. Setting this value will force + the save action to be called when the Done button is pressed on this screen if any configElements were changed.
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        +
      • +
      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
        +         java.util.List<IConfigElement> configElements,
        +         java.lang.String modID,
        +         boolean allRequireWorldRestart,
        +         boolean allRequireMcRestart,
        +         java.lang.String title)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. This constructor passes null for configID. + If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        +
      • +
      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
        +         java.util.List<IConfigElement> configElements,
        +         java.lang.String modID,
        +         boolean allRequireWorldRestart,
        +         boolean allRequireMcRestart,
        +         java.lang.String title,
        +         java.lang.String titleLine2)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. This constructor passes null for configID. + If configID is not defined, the events will be posted if the parent gui is null or if the parent gui is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        titleLine2 - the desired title second line for this screen. Typically this is used to send the category name of the category + currently being edited.
        +
      • +
      + + + +
        +
      • +

        GuiConfig

        +
        public GuiConfig(GuiScreen parentScreen,
        +         java.util.List<IConfigElement> configElements,
        +         java.lang.String modID,
        +         java.lang.String configID,
        +         boolean allRequireWorldRestart,
        +         boolean allRequireMcRestart,
        +         java.lang.String title,
        +         java.lang.String titleLine2)
        +
        GuiConfig constructor that will use ConfigChangedEvent when editing is concluded. titleLine2 is specified in this constructor. + If a non-null value is passed for configID, the OnConfigChanged and PostConfigChanged events will be posted when the Done button is + pressed if any configElements were changed (includes child screens). If configID is not defined, the events will be posted if the parent + gui is null or if the parent gui is not an instance of GuiConfig.
        +
        Parameters:
        parentScreen - the parent GuiScreen object
        configElements - a List of IConfigProperty objects
        modID - the mod ID for the mod whose config settings will be edited
        configID - an identifier that will be passed to the OnConfigChanged and PostConfigChanged events
        allRequireWorldRestart - send true if all configElements on this screen require a world restart
        allRequireMcRestart - send true if all configElements on this screen require MC to be restarted
        title - the desired title for this screen. For consistency it is recommended that you pass the path of the config file being + edited.
        titleLine2 - the desired title second line for this screen. Typically this is used to send the category name of the category + currently being edited.
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getAbridgedConfigPath

        +
        public static java.lang.String getAbridgedConfigPath(java.lang.String path)
        +
      • +
      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        mouseClicked

        +
        protected void mouseClicked(int x,
        +                int y,
        +                int mouseEvent)
        +
        +
        Overrides:
        +
        mouseClicked in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        mouseMovedOrUp

        +
        protected void mouseMovedOrUp(int x,
        +                  int y,
        +                  int mouseEvent)
        +
        +
        Overrides:
        +
        mouseMovedOrUp in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        keyTyped

        +
        protected void keyTyped(char eventChar,
        +            int eventKey)
        +
        +
        Overrides:
        +
        keyTyped in class GuiScreen
        +
        +
      • +
      + + + + + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int mouseX,
        +              int mouseY,
        +              float partialTicks)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        drawToolTip

        +
        public void drawToolTip(java.util.List stringList,
        +               int x,
        +               int y)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html new file mode 100644 index 0000000..3946ec7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ArrayEntry.html @@ -0,0 +1,563 @@ + + + + + +GuiConfigEntries.ArrayEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ArrayEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html new file mode 100644 index 0000000..ca90f34 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.BooleanEntry.html @@ -0,0 +1,511 @@ + + + + + +GuiConfigEntries.BooleanEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.BooleanEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html new file mode 100644 index 0000000..8c8f0f6 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ButtonEntry.html @@ -0,0 +1,540 @@ + + + + + +GuiConfigEntries.ButtonEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ButtonEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html new file mode 100644 index 0000000..8c8473a --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CategoryEntry.html @@ -0,0 +1,772 @@ + + + + + +GuiConfigEntries.CategoryEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.CategoryEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html new file mode 100644 index 0000000..ceefad4 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ChatColorEntry.html @@ -0,0 +1,339 @@ + + + + + +GuiConfigEntries.ChatColorEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ChatColorEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html new file mode 100644 index 0000000..725b778 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.CycleValueEntry.html @@ -0,0 +1,529 @@ + + + + + +GuiConfigEntries.CycleValueEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.CycleValueEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html new file mode 100644 index 0000000..fb7a265 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.DoubleEntry.html @@ -0,0 +1,426 @@ + + + + + +GuiConfigEntries.DoubleEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.DoubleEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html new file mode 100644 index 0000000..5903589 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IConfigEntry.html @@ -0,0 +1,501 @@ + + + + + +GuiConfigEntries.IConfigEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Interface GuiConfigEntries.IConfigEntry<T>

+
+
+ +
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddrawToolTip(int mouseX, + int mouseY) +
      Handles drawing any tooltips that apply to this entry.
      +
      booleanenabled() +
      Is this list entry enabled?
      +
      IConfigElementgetConfigElement() +
      Gets the IConfigElement object owned by this entry.
      +
      TgetCurrentValue() +
      Gets the current value of this entry as a String.
      +
      T[]getCurrentValues() +
      Gets the current values of this list entry as a String[].
      +
      intgetEntryRightBound() +
      Gets this entry's right-hand x boundary.
      +
      intgetLabelWidth() +
      Gets this entry's label width.
      +
      java.lang.StringgetName() +
      Gets the name of the ConfigElement owned by this entry.
      +
      booleanisChanged() +
      Has the value of this entry changed?
      +
      booleanisDefault() +
      Is this entry's value equal to the default value? Generally true should be returned if this entry is not a property or category + entry.
      +
      voidkeyTyped(char eventChar, + int eventKey) +
      Handles user keystrokes for any GuiTextField objects in this entry.
      +
      voidmouseClicked(int x, + int y, + int mouseEvent) +
      Call GuiTextField.mouseClicked() for and GuiTextField objects in this entry.
      +
      voidonGuiClosed() +
      This method is called when the parent GUI is closed.
      +
      booleansaveConfigElement() +
      Handles saving any changes that have been made to this entry back to the underlying object.
      +
      voidsetToDefault() +
      Sets this entry's value to the default value.
      +
      voidundoChanges() +
      Handles reverting any changes that have occurred to this entry.
      +
      voidupdateCursorCounter() +
      Call GuiTextField.updateCursorCounter() for any GuiTextField objects in this entry.
      +
      + +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConfigElement

        +
        IConfigElement getConfigElement()
        +
        Gets the IConfigElement object owned by this entry.
        +
        Returns:
        +
      • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Gets the name of the ConfigElement owned by this entry.
        +
      • +
      + + + +
        +
      • +

        getCurrentValue

        +
        T getCurrentValue()
        +
        Gets the current value of this entry as a String.
        +
      • +
      + + + +
        +
      • +

        getCurrentValues

        +
        T[] getCurrentValues()
        +
        Gets the current values of this list entry as a String[].
        +
      • +
      + + + +
        +
      • +

        enabled

        +
        boolean enabled()
        +
        Is this list entry enabled?
        +
        Returns:
        true if this entry's controls should be enabled, false otherwise.
        +
      • +
      + + + +
        +
      • +

        keyTyped

        +
        void keyTyped(char eventChar,
        +            int eventKey)
        +
        Handles user keystrokes for any GuiTextField objects in this entry. Call GuiTextField.keyTyped() for any GuiTextField + objects that should receive the input provided.
        +
      • +
      + + + +
        +
      • +

        updateCursorCounter

        +
        void updateCursorCounter()
        +
        Call GuiTextField.updateCursorCounter() for any GuiTextField objects in this entry.
        +
      • +
      + + + +
        +
      • +

        mouseClicked

        +
        void mouseClicked(int x,
        +                int y,
        +                int mouseEvent)
        +
        Call GuiTextField.mouseClicked() for and GuiTextField objects in this entry.
        +
      • +
      + + + +
        +
      • +

        isDefault

        +
        boolean isDefault()
        +
        Is this entry's value equal to the default value? Generally true should be returned if this entry is not a property or category + entry.
        +
        Returns:
        true if this entry's value is equal to this entry's default value.
        +
      • +
      + + + +
        +
      • +

        setToDefault

        +
        void setToDefault()
        +
        Sets this entry's value to the default value.
        +
      • +
      + + + +
        +
      • +

        undoChanges

        +
        void undoChanges()
        +
        Handles reverting any changes that have occurred to this entry.
        +
      • +
      + + + +
        +
      • +

        isChanged

        +
        boolean isChanged()
        +
        Has the value of this entry changed?
        +
        Returns:
        true if changes have been made to this entry's value, false otherwise.
        +
      • +
      + + + +
        +
      • +

        saveConfigElement

        +
        boolean saveConfigElement()
        +
        Handles saving any changes that have been made to this entry back to the underlying object. It is a good practice to check + isChanged() before performing the save action. This method should return true if the element has changed AND REQUIRES A RESTART.
        +
      • +
      + + + +
        +
      • +

        drawToolTip

        +
        void drawToolTip(int mouseX,
        +               int mouseY)
        +
        Handles drawing any tooltips that apply to this entry. This method is called after all other GUI elements have been drawn to the + screen, so it could also be used to draw any GUI element that needs to be drawn after all entries have had drawEntry() called.
        +
      • +
      + + + +
        +
      • +

        getLabelWidth

        +
        int getLabelWidth()
        +
        Gets this entry's label width.
        +
      • +
      + + + +
        +
      • +

        getEntryRightBound

        +
        int getEntryRightBound()
        +
        Gets this entry's right-hand x boundary. This value is used to control where the scroll bar is placed.
        +
      • +
      + + + +
        +
      • +

        onGuiClosed

        +
        void onGuiClosed()
        +
        This method is called when the parent GUI is closed. Most handlers won't need this; it is provided for special cases.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html new file mode 100644 index 0000000..10bec07 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.IntegerEntry.html @@ -0,0 +1,426 @@ + + + + + +GuiConfigEntries.IntegerEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.IntegerEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html new file mode 100644 index 0000000..727ef75 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.ListEntryBase.html @@ -0,0 +1,936 @@ + + + + + +GuiConfigEntries.ListEntryBase (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.ListEntryBase

+
+
+ +
+ +
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddrawEntry(int slotIndex, + int x, + int y, + int listWidth, + int slotHeight, + Tessellator tessellator, + int mouseX, + int mouseY, + boolean isSelected) 
      voiddrawToolTip(int mouseX, + int mouseY) +
      Handles drawing any tooltips that apply to this entry.
      +
      booleanenabled() +
      Is this list entry enabled?
      +
      IConfigElementgetConfigElement() +
      Gets the IConfigElement object owned by this entry.
      +
      abstract java.lang.ObjectgetCurrentValue() +
      Gets the current value of this entry as a String.
      +
      abstract java.lang.Object[]getCurrentValues() +
      Gets the current values of this list entry as a String[].
      +
      intgetEntryRightBound() +
      Gets this entry's right-hand x boundary.
      +
      intgetLabelWidth() +
      Gets this entry's label width.
      +
      java.lang.StringgetName() +
      Gets the name of the ConfigElement owned by this entry.
      +
      abstract booleanisChanged() +
      Has the value of this entry changed?
      +
      abstract booleanisDefault() +
      Is this entry's value equal to the default value? Generally true should be returned if this entry is not a property or category + entry.
      +
      abstract voidkeyTyped(char eventChar, + int eventKey) +
      Handles user keystrokes for any GuiTextField objects in this entry.
      +
      abstract voidmouseClicked(int x, + int y, + int mouseEvent) +
      Call GuiTextField.mouseClicked() for and GuiTextField objects in this entry.
      +
      booleanmousePressed(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      voidmouseReleased(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      voidonGuiClosed() +
      This method is called when the parent GUI is closed.
      +
      abstract booleansaveConfigElement() +
      Handles saving any changes that have been made to this entry back to the underlying object.
      +
      abstract voidsetToDefault() +
      Sets this entry's value to the default value.
      +
      abstract voidundoChanges() +
      Handles reverting any changes that have occurred to this entry.
      +
      abstract voidupdateCursorCounter() +
      Call GuiTextField.updateCursorCounter() for any GuiTextField objects in this entry.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html new file mode 100644 index 0000000..43f6bb7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.NumberSliderEntry.html @@ -0,0 +1,536 @@ + + + + + +GuiConfigEntries.NumberSliderEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.NumberSliderEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html new file mode 100644 index 0000000..4c6af89 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.SelectValueEntry.html @@ -0,0 +1,583 @@ + + + + + +GuiConfigEntries.SelectValueEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.SelectValueEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html new file mode 100644 index 0000000..2f13a06 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.StringEntry.html @@ -0,0 +1,603 @@ + + + + + +GuiConfigEntries.StringEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries.StringEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html new file mode 100644 index 0000000..958ffde --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiConfigEntries.html @@ -0,0 +1,856 @@ + + + + + +GuiConfigEntries (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiConfigEntries

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiConfigEntries
    +extends GuiListExtended
    +
    This class implements the scrolling list functionality of the config GUI screens. It also provides all the default control handlers + for the various property types.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        owningScreen

        +
        public final GuiConfig owningScreen
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        maxLabelTextWidth

        +
        public int maxLabelTextWidth
        +
        The max width of the label of all IConfigEntry objects.
        +
      • +
      + + + +
        +
      • +

        maxEntryRightBound

        +
        public int maxEntryRightBound
        +
        The max x boundary of all IConfigEntry objects.
        +
      • +
      + + + +
        +
      • +

        labelX

        +
        public int labelX
        +
        The x position where the label should be drawn.
        +
      • +
      + + + +
        +
      • +

        controlX

        +
        public int controlX
        +
        The x position where the control should be drawn.
        +
      • +
      + + + +
        +
      • +

        controlWidth

        +
        public int controlWidth
        +
        The width of the control.
        +
      • +
      + + + +
        +
      • +

        resetX

        +
        public int resetX
        +
        The minimum x position where the Undo/Default buttons will start
        +
      • +
      + + + +
        +
      • +

        scrollBarX

        +
        public int scrollBarX
        +
        The x position of the scroll bar.
        +
      • +
      +
    • +
    + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        protected void initGui()
        +
      • +
      + + + +
        +
      • +

        getSize

        +
        public int getSize()
        +
        +
        Specified by:
        +
        getSize in class GuiSlot
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getScrollBarX

        +
        public int getScrollBarX()
        +
        +
        Overrides:
        +
        getScrollBarX in class GuiSlot
        +
        +
      • +
      + + + +
        +
      • +

        getListWidth

        +
        public int getListWidth()
        +
        Gets the width of the list
        +
        +
        Overrides:
        +
        getListWidth in class GuiSlot
        +
        +
      • +
      + + + +
        +
      • +

        keyTyped

        +
        public void keyTyped(char eventChar,
        +            int eventKey)
        +
        This method is a pass-through for IConfigEntry objects that require keystrokes. Called from the parent GuiConfig screen.
        +
      • +
      + + + +
        +
      • +

        updateScreen

        +
        public void updateScreen()
        +
        This method is a pass-through for IConfigEntry objects that contain GuiTextField elements. Called from the parent GuiConfig + screen.
        +
      • +
      + + + +
        +
      • +

        mouseClicked

        +
        public void mouseClicked(int mouseX,
        +                int mouseY,
        +                int mouseEvent)
        +
        This method is a pass-through for IConfigEntry objects that contain GuiTextField elements. Called from the parent GuiConfig + screen.
        +
      • +
      + + + +
        +
      • +

        onGuiClosed

        +
        public void onGuiClosed()
        +
        This method is a pass-through for IConfigListEntry objects that need to perform actions when the containing GUI is closed.
        +
      • +
      + + + +
        +
      • +

        saveConfigElements

        +
        public boolean saveConfigElements()
        +
        Saves all properties on this screen / child screens. This method returns true if any elements were changed that require + a restart for proper handling.
        +
      • +
      + + + +
        +
      • +

        areAllEntriesDefault

        +
        public boolean areAllEntriesDefault(boolean includeChildren)
        +
        Returns true if all IConfigEntry objects on this screen are set to default. If includeChildren is true sub-category + objects are checked as well.
        +
      • +
      + + + +
        +
      • +

        setAllToDefault

        +
        public void setAllToDefault(boolean includeChildren)
        +
        Sets all IConfigEntry objects on this screen to default. If includeChildren is true sub-category objects are set as + well.
        +
      • +
      + + + +
        +
      • +

        hasChangedEntry

        +
        public boolean hasChangedEntry(boolean includeChildren)
        +
        Returns true if any IConfigEntry objects on this screen are changed. If includeChildren is true sub-category objects + are checked as well.
        +
      • +
      + + + +
        +
      • +

        areAnyEntriesEnabled

        +
        public boolean areAnyEntriesEnabled(boolean includeChildren)
        +
        Returns true if any IConfigEntry objects on this screen are enabled. If includeChildren is true sub-category objects + are checked as well.
        +
      • +
      + + + +
        +
      • +

        undoAllChanges

        +
        public void undoAllChanges(boolean includeChildren)
        +
        Reverts changes to all IConfigEntry objects on this screen. If includeChildren is true sub-category objects are + reverted as well.
        +
      • +
      + + + +
        +
      • +

        drawScreenPost

        +
        public void drawScreenPost(int mouseX,
        +                  int mouseY,
        +                  float partialTicks)
        +
        Calls the drawToolTip() method for all IConfigEntry objects on this screen. This is called from the parent GuiConfig screen + after drawing all other elements.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArray.html b/javadoc/cpw/mods/fml/client/config/GuiEditArray.html new file mode 100644 index 0000000..3803491 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArray.html @@ -0,0 +1,540 @@ + + + + + +GuiEditArray (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArray

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiEditArray
    +extends GuiScreen
    +
    This class is the base screen used for editing an array-type property. It provides a list of array entries for the user to edit. + This screen is invoked from a GuiConfig screen by controls that use the EditListPropEntry IGuiConfigListEntry object.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parentScreen

        +
        protected GuiScreen parentScreen
        +
      • +
      + + + + + + + +
        +
      • +

        titleLine2

        +
        protected java.lang.String titleLine2
        +
      • +
      + + + +
        +
      • +

        titleLine3

        +
        protected java.lang.String titleLine3
        +
      • +
      + + + +
        +
      • +

        slotIndex

        +
        protected int slotIndex
        +
      • +
      + + + +
        +
      • +

        enabled

        +
        protected boolean enabled
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiEditArray

        +
        public GuiEditArray(GuiScreen parentScreen,
        +            IConfigElement configElement,
        +            int slotIndex,
        +            java.lang.Object[] currentValues,
        +            boolean enabled)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
      • +
      + + + + + + + +
        +
      • +

        mouseClicked

        +
        protected void mouseClicked(int x,
        +                int y,
        +                int mouseEvent)
        +
        +
        Overrides:
        +
        mouseClicked in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        mouseMovedOrUp

        +
        protected void mouseMovedOrUp(int x,
        +                  int y,
        +                  int mouseEvent)
        +
        +
        Overrides:
        +
        mouseMovedOrUp in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        keyTyped

        +
        protected void keyTyped(char eventChar,
        +            int eventKey)
        +
        +
        Overrides:
        +
        keyTyped in class GuiScreen
        +
        +
      • +
      + + + + + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int par1,
        +              int par2,
        +              float par3)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        drawToolTip

        +
        public void drawToolTip(java.util.List stringList,
        +               int x,
        +               int y)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html new file mode 100644 index 0000000..520d874 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BaseEntry.html @@ -0,0 +1,569 @@ + + + + + +GuiEditArrayEntries.BaseEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.BaseEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html new file mode 100644 index 0000000..9709de7 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.BooleanEntry.html @@ -0,0 +1,422 @@ + + + + + +GuiEditArrayEntries.BooleanEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.BooleanEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html new file mode 100644 index 0000000..33aa899 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.DoubleEntry.html @@ -0,0 +1,342 @@ + + + + + +GuiEditArrayEntries.DoubleEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.DoubleEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html new file mode 100644 index 0000000..872c560 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IArrayEntry.html @@ -0,0 +1,297 @@ + + + + + +GuiEditArrayEntries.IArrayEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Interface GuiEditArrayEntries.IArrayEntry

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        keyTyped

        +
        void keyTyped(char eventChar,
        +            int eventKey)
        +
      • +
      + + + +
        +
      • +

        updateCursorCounter

        +
        void updateCursorCounter()
        +
      • +
      + + + +
        +
      • +

        mouseClicked

        +
        void mouseClicked(int x,
        +                int y,
        +                int mouseEvent)
        +
      • +
      + + + +
        +
      • +

        drawToolTip

        +
        void drawToolTip(int mouseX,
        +               int mouseY)
        +
      • +
      + + + +
        +
      • +

        isValueSavable

        +
        boolean isValueSavable()
        +
      • +
      + + + +
        +
      • +

        getValue

        +
        java.lang.Object getValue()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html new file mode 100644 index 0000000..9fac5ee --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.IntegerEntry.html @@ -0,0 +1,341 @@ + + + + + +GuiEditArrayEntries.IntegerEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.IntegerEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html new file mode 100644 index 0000000..f08b640 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.StringEntry.html @@ -0,0 +1,431 @@ + + + + + +GuiEditArrayEntries.StringEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries.StringEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html new file mode 100644 index 0000000..2cc304c --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiEditArrayEntries.html @@ -0,0 +1,694 @@ + + + + + +GuiEditArrayEntries (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiEditArrayEntries

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiEditArrayEntries
    +extends GuiListExtended
    +
    This class implements the scrolling list functionality of the GuiEditList screen. It also provides all the default controls + for editing array-type properties.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault
        +
      • +
      + + + +
        +
      • +

        isChanged

        +
        public boolean isChanged
        +
      • +
      + + + +
        +
      • +

        canAddMoreEntries

        +
        public boolean canAddMoreEntries
        +
      • +
      + + + +
        +
      • +

        controlWidth

        +
        public final int controlWidth
        +
      • +
      + + + +
        +
      • +

        beforeValues

        +
        public final java.lang.Object[] beforeValues
        +
      • +
      + + + +
        +
      • +

        currentValues

        +
        public java.lang.Object[] currentValues
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiEditArrayEntries

        +
        public GuiEditArrayEntries(GuiEditArray parent,
        +                   Minecraft mc,
        +                   IConfigElement configElement,
        +                   java.lang.Object[] beforeValues,
        +                   java.lang.Object[] currentValues)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getScrollBarX

        +
        protected int getScrollBarX()
        +
        +
        Overrides:
        +
        getScrollBarX in class GuiSlot
        +
        +
      • +
      + + + +
        +
      • +

        getListWidth

        +
        public int getListWidth()
        +
        Gets the width of the list
        +
        +
        Overrides:
        +
        getListWidth in class GuiSlot
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getSize

        +
        protected int getSize()
        +
        +
        Specified by:
        +
        getSize in class GuiSlot
        +
        +
      • +
      + + + +
        +
      • +

        addNewEntry

        +
        public void addNewEntry(int index)
        +
      • +
      + + + +
        +
      • +

        removeEntry

        +
        public void removeEntry(int index)
        +
      • +
      + + + +
        +
      • +

        isChanged

        +
        public boolean isChanged()
        +
      • +
      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
      • +
      + + + +
        +
      • +

        recalculateState

        +
        public void recalculateState()
        +
      • +
      + + + +
        +
      • +

        keyTyped

        +
        protected void keyTyped(char eventChar,
        +            int eventKey)
        +
      • +
      + + + +
        +
      • +

        updateScreen

        +
        protected void updateScreen()
        +
      • +
      + + + +
        +
      • +

        mouseClicked

        +
        protected void mouseClicked(int x,
        +                int y,
        +                int mouseEvent)
        +
      • +
      + + + +
        +
      • +

        isListSavable

        +
        protected boolean isListSavable()
        +
      • +
      + + + +
        +
      • +

        saveListChanges

        +
        protected void saveListChanges()
        +
      • +
      + + + +
        +
      • +

        drawScreenPost

        +
        protected void drawScreenPost(int mouseX,
        +                  int mouseY,
        +                  float f)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html b/javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html new file mode 100644 index 0000000..7824835 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiMessageDialog.html @@ -0,0 +1,322 @@ + + + + + +GuiMessageDialog (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiMessageDialog

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiMessageDialog

        +
        public GuiMessageDialog(GuiScreen nextScreen,
        +                java.lang.String title,
        +                IChatComponent message,
        +                java.lang.String buttonText)
        +
      • +
      +
    • +
    + + +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectString.html b/javadoc/cpw/mods/fml/client/config/GuiSelectString.html new file mode 100644 index 0000000..40123e6 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectString.html @@ -0,0 +1,510 @@ + + + + + +GuiSelectString (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiSelectString

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSelectString
    +extends GuiScreen
    +
    This class provides a screen that allows the user to select a value from a list.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        parentScreen

        +
        protected GuiScreen parentScreen
        +
      • +
      + + + + + + + +
        +
      • +

        titleLine2

        +
        protected java.lang.String titleLine2
        +
      • +
      + + + +
        +
      • +

        titleLine3

        +
        protected java.lang.String titleLine3
        +
      • +
      + + + +
        +
      • +

        slotIndex

        +
        protected int slotIndex
        +
      • +
      + + + +
        +
      • +

        beforeValue

        +
        public final java.lang.Object beforeValue
        +
      • +
      + + + +
        +
      • +

        currentValue

        +
        public java.lang.Object currentValue
        +
      • +
      + + + +
        +
      • +

        enabled

        +
        protected boolean enabled
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSelectString

        +
        public GuiSelectString(GuiScreen parentScreen,
        +               IConfigElement configElement,
        +               int slotIndex,
        +               java.util.Map<java.lang.Object,java.lang.String> selectableValues,
        +               java.lang.Object currentValue,
        +               boolean enabled)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initGui

        +
        public void initGui()
        +
        +
        Overrides:
        +
        initGui in class GuiScreen
        +
        +
      • +
      + + + + + + + +
        +
      • +

        mouseMovedOrUp

        +
        protected void mouseMovedOrUp(int x,
        +                  int y,
        +                  int mouseEvent)
        +
        +
        Overrides:
        +
        mouseMovedOrUp in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        drawScreen

        +
        public void drawScreen(int par1,
        +              int par2,
        +              float par3)
        +
        +
        Overrides:
        +
        drawScreen in class GuiScreen
        +
        +
      • +
      + + + +
        +
      • +

        drawToolTip

        +
        public void drawToolTip(java.util.List stringList,
        +               int x,
        +               int y)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html new file mode 100644 index 0000000..3f88cbe --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.EntryComparator.html @@ -0,0 +1,276 @@ + + + + + +GuiSelectStringEntries.EntryComparator (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiSelectStringEntries.EntryComparator

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.Comparator<java.util.Map.Entry<java.lang.Object,java.lang.String>>
    +
    +
    +
    Enclosing class:
    +
    GuiSelectStringEntries
    +
    +
    +
    +
    public static class GuiSelectStringEntries.EntryComparator
    +extends java.lang.Object
    +implements java.util.Comparator<java.util.Map.Entry<java.lang.Object,java.lang.String>>
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      intcompare(java.util.Map.Entry<java.lang.Object,java.lang.String> o1, + java.util.Map.Entry<java.lang.Object,java.lang.String> o2) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
        +
      • + + +

        Methods inherited from interface java.util.Comparator

        +equals
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSelectStringEntries.EntryComparator

        +
        public GuiSelectStringEntries.EntryComparator()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compare

        +
        public int compare(java.util.Map.Entry<java.lang.Object,java.lang.String> o1,
        +          java.util.Map.Entry<java.lang.Object,java.lang.String> o2)
        +
        +
        Specified by:
        +
        compare in interface java.util.Comparator<java.util.Map.Entry<java.lang.Object,java.lang.String>>
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html new file mode 100644 index 0000000..d96393b --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.IGuiSelectStringListEntry.html @@ -0,0 +1,224 @@ + + + + + +GuiSelectStringEntries.IGuiSelectStringListEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Interface GuiSelectStringEntries.IGuiSelectStringListEntry

+
+
+
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getValue

        +
        java.lang.Object getValue()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html new file mode 100644 index 0000000..8a99981 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.ListEntry.html @@ -0,0 +1,405 @@ + + + + + +GuiSelectStringEntries.ListEntry (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiSelectStringEntries.ListEntry

+
+
+ +
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      protected GuiSelectStringEntriesowningList 
      protected java.util.Map.Entry<java.lang.Object,java.lang.String>value 
      +
    • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voiddrawEntry(int slotIndex, + int x, + int y, + int listWidth, + int slotHeight, + Tessellator tessellator, + int mouseX, + int mouseY, + boolean isSelected) 
      java.lang.ObjectgetValue() 
      booleanmousePressed(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      voidmouseReleased(int index, + int x, + int y, + int mouseEvent, + int relativeX, + int relativeY) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+ +
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html new file mode 100644 index 0000000..90a0296 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSelectStringEntries.html @@ -0,0 +1,583 @@ + + + + + +GuiSelectStringEntries (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiSelectStringEntries

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSelectStringEntries
    +extends GuiListExtended
    +
    This class implements the scrolling list functionality of the GuiSelectString screen.
    +
  • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSelectStringEntries

        +
        public GuiSelectStringEntries(GuiSelectString owningScreen,
        +                      Minecraft mc,
        +                      IConfigElement configElement,
        +                      java.util.Map<java.lang.Object,java.lang.String> selectableValues)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        elementClicked

        +
        protected void elementClicked(int index,
        +                  boolean doubleClick,
        +                  int mouseX,
        +                  int mouseY)
        +
        The element in the slot that was clicked, boolean for whether it was double clicked or not
        +
        +
        Overrides:
        +
        elementClicked in class GuiListExtended
        +
        +
      • +
      + + + +
        +
      • +

        isSelected

        +
        protected boolean isSelected(int index)
        +
        Returns true if the element passed in is currently selected
        +
        +
        Overrides:
        +
        isSelected in class GuiListExtended
        +
        +
      • +
      + + + +
        +
      • +

        getScrollBarX

        +
        protected int getScrollBarX()
        +
        +
        Overrides:
        +
        getScrollBarX in class GuiSlot
        +
        +
      • +
      + + + +
        +
      • +

        getListWidth

        +
        public int getListWidth()
        +
        Gets the width of the list
        +
        +
        Overrides:
        +
        getListWidth in class GuiSlot
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getSize

        +
        protected int getSize()
        +
        +
        Specified by:
        +
        getSize in class GuiSlot
        +
        +
      • +
      + + + +
        +
      • +

        isChanged

        +
        public boolean isChanged()
        +
      • +
      + + + +
        +
      • +

        isDefault

        +
        public boolean isDefault()
        +
      • +
      + + + +
        +
      • +

        saveChanges

        +
        public void saveChanges()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html b/javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html new file mode 100644 index 0000000..c0ef078 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSlider.ISlider.html @@ -0,0 +1,208 @@ + + + + + +GuiSlider.ISlider (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Interface GuiSlider.ISlider

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    GuiSlider
    +
    +
    +
    +
    public static interface GuiSlider.ISlider
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        onChangeSliderValue

        +
        void onChangeSliderValue(GuiSlider slider)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiSlider.html b/javadoc/cpw/mods/fml/client/config/GuiSlider.html new file mode 100644 index 0000000..e5ce3af --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiSlider.html @@ -0,0 +1,699 @@ + + + + + +GuiSlider (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiSlider

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiSlider
    +extends GuiButtonExt
    +
    This class is blatantly stolen from iChunUtils with permission.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        sliderValue

        +
        public double sliderValue
        +
        The value of this slider control.
        +
      • +
      + + + +
        +
      • +

        dispString

        +
        public java.lang.String dispString
        +
      • +
      + + + +
        +
      • +

        dragging

        +
        public boolean dragging
        +
        Is this slider control being dragged.
        +
      • +
      + + + +
        +
      • +

        showDecimal

        +
        public boolean showDecimal
        +
      • +
      + + + +
        +
      • +

        minValue

        +
        public double minValue
        +
      • +
      + + + +
        +
      • +

        maxValue

        +
        public double maxValue
        +
      • +
      + + + +
        +
      • +

        precision

        +
        public int precision
        +
      • +
      + + + + + + + +
        +
      • +

        suffix

        +
        public java.lang.String suffix
        +
      • +
      + + + +
        +
      • +

        drawString

        +
        public boolean drawString
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiSlider

        +
        public GuiSlider(int id,
        +         int xPos,
        +         int yPos,
        +         int width,
        +         int height,
        +         java.lang.String prefix,
        +         java.lang.String suf,
        +         double minVal,
        +         double maxVal,
        +         double currentVal,
        +         boolean showDec,
        +         boolean drawStr)
        +
      • +
      + + + +
        +
      • +

        GuiSlider

        +
        public GuiSlider(int id,
        +         int xPos,
        +         int yPos,
        +         int width,
        +         int height,
        +         java.lang.String prefix,
        +         java.lang.String suf,
        +         double minVal,
        +         double maxVal,
        +         double currentVal,
        +         boolean showDec,
        +         boolean drawStr,
        +         GuiSlider.ISlider par)
        +
      • +
      + + + +
        +
      • +

        GuiSlider

        +
        public GuiSlider(int id,
        +         int xPos,
        +         int yPos,
        +         java.lang.String displayStr,
        +         double minVal,
        +         double maxVal,
        +         double currentVal,
        +         GuiSlider.ISlider par)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getHoverState

        +
        public int getHoverState(boolean par1)
        +
        Returns 0 if the button is disabled, 1 if the mouse is NOT hovering over this button and 2 if it IS hovering over + this button.
        +
        +
        Overrides:
        +
        getHoverState in class GuiButton
        +
        +
      • +
      + + + +
        +
      • +

        mouseDragged

        +
        protected void mouseDragged(Minecraft par1Minecraft,
        +                int par2,
        +                int par3)
        +
        Fired when the mouse button is dragged. Equivalent of MouseListener.mouseDragged(MouseEvent e).
        +
        +
        Overrides:
        +
        mouseDragged in class GuiButton
        +
        +
      • +
      + + + +
        +
      • +

        mousePressed

        +
        public boolean mousePressed(Minecraft par1Minecraft,
        +                   int par2,
        +                   int par3)
        +
        Returns true if the mouse has been pressed on this control. Equivalent of MouseListener.mousePressed(MouseEvent + e).
        +
        +
        Overrides:
        +
        mousePressed in class GuiButton
        +
        +
      • +
      + + + +
        +
      • +

        updateSlider

        +
        public void updateSlider()
        +
      • +
      + + + +
        +
      • +

        mouseReleased

        +
        public void mouseReleased(int par1,
        +                 int par2)
        +
        Fired when the mouse button is released. Equivalent of MouseListener.mouseReleased(MouseEvent e).
        +
        +
        Overrides:
        +
        mouseReleased in class GuiButton
        +
        +
      • +
      + + + +
        +
      • +

        getValueInt

        +
        public int getValueInt()
        +
      • +
      + + + +
        +
      • +

        getValue

        +
        public double getValue()
        +
      • +
      + + + +
        +
      • +

        setValue

        +
        public void setValue(double d)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html b/javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html new file mode 100644 index 0000000..70fec5f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiUnicodeGlyphButton.html @@ -0,0 +1,373 @@ + + + + + +GuiUnicodeGlyphButton (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiUnicodeGlyphButton

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiUnicodeGlyphButton
    +extends GuiButtonExt
    +
    This class provides a button that shows a string glyph at the beginning. The glyph can be scaled using the glyphScale parameter.
    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        glyph

        +
        public java.lang.String glyph
        +
      • +
      + + + +
        +
      • +

        glyphScale

        +
        public float glyphScale
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiUnicodeGlyphButton

        +
        public GuiUnicodeGlyphButton(int id,
        +                     int xPos,
        +                     int yPos,
        +                     int width,
        +                     int height,
        +                     java.lang.String displayString,
        +                     java.lang.String glyph,
        +                     float glyphScale)
        +
      • +
      +
    • +
    + + +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/GuiUtils.html b/javadoc/cpw/mods/fml/client/config/GuiUtils.html new file mode 100644 index 0000000..829c221 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/GuiUtils.html @@ -0,0 +1,529 @@ + + + + + +GuiUtils (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class GuiUtils

+
+
+ +
+
    +
  • +
    +
    +
    public class GuiUtils
    +extends java.lang.Object
    +
    This class provides several methods and constants used by the Config GUI classes.
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringINVALID 
      static java.lang.StringRESET_CHAR 
      static java.lang.StringUNDO_CHAR 
      static java.lang.StringVALID 
      +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GuiUtils() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voiddrawContinuousTexturedBox(int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int borderSize, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawContinuousTexturedBox(int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int topBorder, + int bottomBorder, + int leftBorder, + int rightBorder, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawContinuousTexturedBox(ResourceLocation res, + int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int borderSize, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawContinuousTexturedBox(ResourceLocation res, + int x, + int y, + int u, + int v, + int width, + int height, + int textureWidth, + int textureHeight, + int topBorder, + int bottomBorder, + int leftBorder, + int rightBorder, + float zLevel) +
      Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler.
      +
      static voiddrawTexturedModalRect(int x, + int y, + int u, + int v, + int width, + int height, + float zLevel) 
      static intgetColorCode(char c, + boolean isLighter) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GuiUtils

        +
        public GuiUtils()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getColorCode

        +
        public static int getColorCode(char c,
        +               boolean isLighter)
        +
      • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(int x,
        +                             int y,
        +                             int u,
        +                             int v,
        +                             int width,
        +                             int height,
        +                             int textureWidth,
        +                             int textureHeight,
        +                             int borderSize,
        +                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. It is assumed that the desired texture ResourceLocation object has been bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        borderSize - the size of the box's borders
        zLevel - the zLevel to draw at
        +
      • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(ResourceLocation res,
        +                             int x,
        +                             int y,
        +                             int u,
        +                             int v,
        +                             int width,
        +                             int height,
        +                             int textureWidth,
        +                             int textureHeight,
        +                             int borderSize,
        +                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. The provided ResourceLocation object will be bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        res - the ResourceLocation object that contains the desired image
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        borderSize - the size of the box's borders
        zLevel - the zLevel to draw at
        +
      • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(ResourceLocation res,
        +                             int x,
        +                             int y,
        +                             int u,
        +                             int v,
        +                             int width,
        +                             int height,
        +                             int textureWidth,
        +                             int textureHeight,
        +                             int topBorder,
        +                             int bottomBorder,
        +                             int leftBorder,
        +                             int rightBorder,
        +                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. The provided ResourceLocation object will be bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        res - the ResourceLocation object that contains the desired image
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        topBorder - the size of the box's top border
        bottomBorder - the size of the box's bottom border
        leftBorder - the size of the box's left border
        rightBorder - the size of the box's right border
        zLevel - the zLevel to draw at
        +
      • +
      + + + +
        +
      • +

        drawContinuousTexturedBox

        +
        public static void drawContinuousTexturedBox(int x,
        +                             int y,
        +                             int u,
        +                             int v,
        +                             int width,
        +                             int height,
        +                             int textureWidth,
        +                             int textureHeight,
        +                             int topBorder,
        +                             int bottomBorder,
        +                             int leftBorder,
        +                             int rightBorder,
        +                             float zLevel)
        +
        Draws a textured box of any size (smallest size is borderSize * 2 square) based on a fixed size textured box with continuous borders + and filler. It is assumed that the desired texture ResourceLocation object has been bound using + Minecraft.getMinecraft().getTextureManager().bindTexture(resourceLocation).
        +
        Parameters:
        x - x axis offset
        y - y axis offset
        u - bound resource location image x offset
        v - bound resource location image y offset
        width - the desired box width
        height - the desired box height
        textureWidth - the width of the box texture in the resource location image
        textureHeight - the height of the box texture in the resource location image
        topBorder - the size of the box's top border
        bottomBorder - the size of the box's bottom border
        leftBorder - the size of the box's left border
        rightBorder - the size of the box's right border
        zLevel - the zLevel to draw at
        +
      • +
      + + + +
        +
      • +

        drawTexturedModalRect

        +
        public static void drawTexturedModalRect(int x,
        +                         int y,
        +                         int u,
        +                         int v,
        +                         int width,
        +                         int height,
        +                         float zLevel)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/HoverChecker.html b/javadoc/cpw/mods/fml/client/config/HoverChecker.html new file mode 100644 index 0000000..a36ced1 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/HoverChecker.html @@ -0,0 +1,344 @@ + + + + + +HoverChecker (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Class HoverChecker

+
+
+ +
+
    +
  • +
    +
    +
    public class HoverChecker
    +extends java.lang.Object
    +
    This class implements an easy way to check if the mouse has hovered within a certain region of the screen for a given + period of time. The region can be defined manually or by supplying a GuiButton object.
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      HoverChecker(GuiButton button, + int threshold) 
      HoverChecker(int top, + int bottom, + int left, + int right, + int threshold) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancheckHover(int mouseX, + int mouseY) +
      Checks if the mouse is in the hover region.
      +
      booleancheckHover(int mouseX, + int mouseY, + boolean canHover) +
      Checks if the mouse is in the hover region.
      +
      voidresetHoverTimer() +
      Manually resets the hover timer.
      +
      voidupdateBounds(int top, + int bottom, + int left, + int right) +
      Call this method if the intended region has changed such as if the region must follow a scrolling list.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HoverChecker

        +
        public HoverChecker(int top,
        +            int bottom,
        +            int left,
        +            int right,
        +            int threshold)
        +
      • +
      + + + +
        +
      • +

        HoverChecker

        +
        public HoverChecker(GuiButton button,
        +            int threshold)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        updateBounds

        +
        public void updateBounds(int top,
        +                int bottom,
        +                int left,
        +                int right)
        +
        Call this method if the intended region has changed such as if the region must follow a scrolling list. + It is not necessary to call this method if a GuiButton defines the hover region.
        +
      • +
      + + + +
        +
      • +

        checkHover

        +
        public boolean checkHover(int mouseX,
        +                 int mouseY)
        +
        Checks if the mouse is in the hover region. If the specified time period has elapsed the method returns true. + The hover timer is reset if the mouse is not within the region.
        +
      • +
      + + + +
        +
      • +

        checkHover

        +
        public boolean checkHover(int mouseX,
        +                 int mouseY,
        +                 boolean canHover)
        +
        Checks if the mouse is in the hover region. If the specified time period has elapsed the method returns true. + The hover timer is reset if the mouse is not within the region.
        +
      • +
      + + + +
        +
      • +

        resetHoverTimer

        +
        public void resetHoverTimer()
        +
        Manually resets the hover timer.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/IConfigElement.html b/javadoc/cpw/mods/fml/client/config/IConfigElement.html new file mode 100644 index 0000000..ede0fd2 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/IConfigElement.html @@ -0,0 +1,679 @@ + + + + + +IConfigElement (Forge API) + + + + + + + +
+ + + + + +
+ + + +
+
cpw.mods.fml.client.config
+

Interface IConfigElement<T>

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      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.
      +
      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?
      +
      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.
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Property Detail

      + + + +
        +
      • +

        is

        +
        [Property, Category] Is this object a property object?
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isProperty

        +
        boolean isProperty()
        +
        [Property, Category] Is this object a property object?
        +
      • +
      + + + +
        +
      • +

        getConfigEntryClass

        +
        java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
        +
        This method returns a class that implements IConfigEntry or null. This class MUST + provide a constructor with the following parameter types: GuiConfig, GuiConfigEntries, IConfigElement
        +
      • +
      + + + +
        +
      • +

        getArrayEntryClass

        +
        java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
        +
        This method returns a class that implements IArrayEntry. This class MUST provide a constructor with the + following parameter types: GuiEditArray, GuiEditArrayEntries, IConfigElement, Object
        +
      • +
      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        [Property, Category] Gets the name of this object.
        +
      • +
      + + + +
        +
      • +

        getQualifiedName

        +
        java.lang.String getQualifiedName()
        +
        [Category] Gets the qualified name of this object. This is typically only used for category objects.
        +
      • +
      + + + +
        +
      • +

        getLanguageKey

        +
        java.lang.String getLanguageKey()
        +
        [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.
        +
      • +
      + + + +
        +
      • +

        getComment

        +
        java.lang.String getComment()
        +
        [Property, Category] Gets the comment for this object. Used for the tooltip if getLanguageKey() + ".tooltip" is not defined in the + .lang file.
        +
      • +
      + + + +
        +
      • +

        getChildElements

        +
        java.util.List<IConfigElement> getChildElements()
        +
        [Category] Gets this category's child categories/properties.
        +
      • +
      + + + +
        +
      • +

        getType

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

        isList

        +
        boolean isList()
        +
        [Property] Is this property object a list?
        +
      • +
      + + + +
        +
      • +

        isListLengthFixed

        +
        boolean isListLengthFixed()
        +
        [Property] Does this list property have to remain a fixed length?
        +
      • +
      + + + +
        +
      • +

        getMaxListLength

        +
        int getMaxListLength()
        +
        [Property] Gets the max length of this list property, or -1 if the length is unlimited.
        +
      • +
      + + + +
        +
      • +

        isDefault

        +
        boolean isDefault()
        +
        [Property] Is this property value equal to the default value?
        +
      • +
      + + + +
        +
      • +

        getDefault

        +
        java.lang.Object getDefault()
        +
        [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()
        +
      • +
      + + + +
        +
      • +

        getDefaults

        +
        java.lang.Object[] getDefaults()
        +
        [Property] Gets this property's default values.
        +
      • +
      + + + +
        +
      • +

        setToDefault

        +
        void setToDefault()
        +
        [Property] Sets this property's value to the default value.
        +
      • +
      + + + +
        +
      • +

        requiresWorldRestart

        +
        boolean requiresWorldRestart()
        +
        [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.
        +
      • +
      + + + +
        +
      • +

        showInGui

        +
        boolean showInGui()
        +
        [Property, Category] Whether or not this element should be allowed to show on config GUIs.
        +
      • +
      + + + +
        +
      • +

        requiresMcRestart

        +
        boolean requiresMcRestart()
        +
        [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
        +
      • +
      + + + +
        +
      • +

        get

        +
        java.lang.Object get()
        +
        [Property] Gets this property value.
        +
      • +
      + + + +
        +
      • +

        getList

        +
        java.lang.Object[] getList()
        +
        [Property] Gets this property value as a list. Generally you should be sure of whether the property is a list before calling this.
        +
      • +
      + + + + + +
        +
      • +

        set

        +
        void set(T value)
        +
        [Property] Sets this property's value.
        +
      • +
      + + + + + +
        +
      • +

        set

        +
        void set(T[] aVal)
        +
        [Property] Sets this property's value to the specified array.
        +
      • +
      + + + +
        +
      • +

        getValidValues

        +
        java.lang.String[] getValidValues()
        +
        [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.
        +
      • +
      + + + +
        +
      • +

        getMinValue

        +
        T getMinValue()
        +
        [Property] Gets this property's minimum value.
        +
      • +
      + + + +
        +
      • +

        getMaxValue

        +
        T getMaxValue()
        +
        [Property] Gets this property's maximum value.
        +
      • +
      + + + +
        +
      • +

        getValidationPattern

        +
        java.util.regex.Pattern getValidationPattern()
        +
        [Property] Gets a Pattern object used in String property input validation.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/package-frame.html b/javadoc/cpw/mods/fml/client/config/package-frame.html new file mode 100644 index 0000000..003cbb9 --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/package-frame.html @@ -0,0 +1,65 @@ + + + + + +cpw.mods.fml.client.config (Forge API) + + + + +

cpw.mods.fml.client.config

+
+

Interfaces

+ +

Classes

+ +

Enums

+ +
+ + diff --git a/javadoc/cpw/mods/fml/client/config/package-summary.html b/javadoc/cpw/mods/fml/client/config/package-summary.html new file mode 100644 index 0000000..d27d8eb --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/package-summary.html @@ -0,0 +1,400 @@ + + + + + +cpw.mods.fml.client.config (Forge API) + + + + + + + +
+ + + + + +
+ + +
+

Package cpw.mods.fml.client.config

+
+
+ +
+ +
+ + + + + +
+ + + + diff --git a/javadoc/cpw/mods/fml/client/config/package-tree.html b/javadoc/cpw/mods/fml/client/config/package-tree.html new file mode 100644 index 0000000..5874d2f --- /dev/null +++ b/javadoc/cpw/mods/fml/client/config/package-tree.html @@ -0,0 +1,232 @@ + + + + + +cpw.mods.fml.client.config Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+ + +
+

Hierarchy For Package cpw.mods.fml.client.config

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +

Enum Hierarchy

+ +
+ +
+ + + + + +
+ + + + -- cgit v1.2.3