From 0427ab89f1753a44b30cbc35ce021cbbdc845109 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:52:45 +0300 Subject: fix missing source folder --- .../cpw/mods/fml/client/FMLConfigGuiFactory.html | 391 +++++++++++++++++++++ 1 file changed, 391 insertions(+) create mode 100644 javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html (limited to 'javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html') diff --git a/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html b/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html new file mode 100644 index 0000000..5f3605c --- /dev/null +++ b/javadoc/cpw/mods/fml/client/FMLConfigGuiFactory.html @@ -0,0 +1,391 @@ + + + + + +FMLConfigGuiFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.client
+

Class FMLConfigGuiFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IModGuiFactory
    +
    +
    +
    +
    public class FMLConfigGuiFactory
+extends java.lang.Object
+implements IModGuiFactory
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLConfigGuiFactory

        +
        public FMLConfigGuiFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initialize

        +
        public void initialize(Minecraft minecraftInstance)
        +
        Description copied from interface: IModGuiFactory
        +
        Called when instantiated to initialize with the active minecraft instance.
        +
        +
        Specified by:
        +
        initialize in interface IModGuiFactory
        +
        Parameters:
        minecraftInstance - the instance
        +
        • +
      + + + +
        +
      • +

        mainConfigGuiClass

        +
        public java.lang.Class<? extends GuiScreen> mainConfigGuiClass()
        +
        Description copied from interface: IModGuiFactory
        +
        Return the name of a class extending GuiScreen. This class will + be instantiated when the "config" button is pressed in the mod list. It will + have a single argument constructor - the "parent" screen, the same as all + Minecraft GUIs. The expected behaviour is that this screen will replace the + "mod list" screen completely, and will return to the mod list screen through + the parent link, once the appropriate action is taken from the config screen. + + A null from this method indicates that the mod does not provide a "config" + button GUI screen, and the config button will be hidden/disabled. + + This config GUI is anticipated to provide configuration to the mod in a friendly + visual way. It should not be abused to set internals such as IDs (they're gonna + keep disappearing anyway), but rather, interesting behaviours. This config GUI + is never run when a server game is running, and should be used to configure + desired behaviours that affect server state. Costs, mod game modes, stuff like that + can be changed here.
        +
        +
        Specified by:
        +
        mainConfigGuiClass in interface IModGuiFactory
        +
        Returns:
        A class that will be instantiated on clicks on the config button + or null if no GUI is desired.
        +
        • +
      + + + +
        +
      • +

        runtimeGuiCategories

        +
        public java.util.Set<IModGuiFactory.RuntimeOptionCategoryElement> runtimeGuiCategories()
        +
        Description copied from interface: IModGuiFactory
        +
        Return a list of the "runtime" categories this mod wishes to populate with + GUI elements. + + Runtime categories are created on demand and organized in a 'lite' tree format. + The parent represents the parent node in the tree. There is one special parent + 'Help' that will always list first, and is generally meant to provide Help type + content for mods. The remaining parents will sort alphabetically, though + this may change if there is a lot of alphabetic abuse. "AAA" is probably never a valid + category parent. + + Runtime configuration itself falls into two flavours: in-game help, which is + generally non interactive except for the text it wishes to show, and client-only + affecting behaviours. This would include things like toggling minimaps, or cheat modes + or anything NOT affecting the behaviour of the server. Please don't abuse this to + change the state of the server in any way, this is intended to behave identically + when the server is local or remote.
        +
        +
        Specified by:
        +
        runtimeGuiCategories in interface IModGuiFactory
        +
        Returns:
        the set of options this mod wishes to have available, or empty if none
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + -- cgit v1.2.3