From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- ...Factory.ForgeConfigGui.AddModOverrideEntry.html | 344 +++++++++++++++++ ...GuiFactory.ForgeConfigGui.ChunkLoaderEntry.html | 322 ++++++++++++++++ ...orgeGuiFactory.ForgeConfigGui.GeneralEntry.html | 322 ++++++++++++++++ .../ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html | 344 +++++++++++++++++ ...uiFactory.ForgeConfigGui.ModOverridesEntry.html | 392 +++++++++++++++++++ .../client/gui/ForgeGuiFactory.ForgeConfigGui.html | 340 ++++++++++++++++ .../minecraftforge/client/gui/ForgeGuiFactory.html | 429 +++++++++++++++++++++ .../minecraftforge/client/gui/package-frame.html | 25 ++ .../minecraftforge/client/gui/package-summary.html | 167 ++++++++ .../minecraftforge/client/gui/package-tree.html | 160 ++++++++ 10 files changed, 2845 insertions(+) create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html create mode 100644 javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html create mode 100644 javadoc/net/minecraftforge/client/gui/package-frame.html create mode 100644 javadoc/net/minecraftforge/client/gui/package-summary.html create mode 100644 javadoc/net/minecraftforge/client/gui/package-tree.html (limited to 'javadoc/net/minecraftforge/client/gui') diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html new file mode 100644 index 0000000..586f8ad --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry.html @@ -0,0 +1,344 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.AddModOverrideEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html new file mode 100644 index 0000000..c0dda24 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry.html @@ -0,0 +1,322 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.ChunkLoaderEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html new file mode 100644 index 0000000..d5ffe5c --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.GeneralEntry.html @@ -0,0 +1,322 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.GeneralEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.GeneralEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html new file mode 100644 index 0000000..d5f99b0 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModIDEntry.html @@ -0,0 +1,344 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.ModIDEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.ModIDEntry

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html new file mode 100644 index 0000000..702aa2e --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry.html @@ -0,0 +1,392 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    GuiConfigEntries.IConfigEntry, GuiListExtended.IGuiListEntry
    +
    +
    +
    Enclosing class:
    +
    ForgeGuiFactory.ForgeConfigGui
    +
    +
    +
    +
    public static class ForgeGuiFactory.ForgeConfigGui.ModOverridesEntry
+extends GuiConfigEntries.CategoryEntry
    +
    This custom list entry provides the Mod Overrides entry on the Forge Chunk Loading config screen. + It extends the base Category entry class and defines the IConfigElement objects that will be used to build the child screen. + In this case it adds the custom entry for adding a new mod override and lists the existing mod overrides.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html new file mode 100644 index 0000000..fa8ce26 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.ForgeConfigGui.html @@ -0,0 +1,340 @@ + + + + + +ForgeGuiFactory.ForgeConfigGui (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory.ForgeConfigGui

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ForgeGuiFactory
    +
    +
    +
    +
    public static class ForgeGuiFactory.ForgeConfigGui
+extends GuiConfig
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeGuiFactory.ForgeConfigGui

        +
        public ForgeGuiFactory.ForgeConfigGui(GuiScreen parentScreen)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html new file mode 100644 index 0000000..81054bf --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/ForgeGuiFactory.html @@ -0,0 +1,429 @@ + + + + + +ForgeGuiFactory (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.client.gui
+

Class ForgeGuiFactory

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IModGuiFactory
    +
    +
    +
    +
    public class ForgeGuiFactory
+extends java.lang.Object
+implements IModGuiFactory
    +
    This is the base GuiConfig screen class that all the other Forge-specific config screens will be called from. + Since Forge has multiple config files I thought I would use that opportunity to show some of the ways + that the config GUI system can be extended to create custom config GUIs that have additional features + over the base functionality of just displaying Properties and ConfigCategories. + + The concepts implemented here are: + - using custom IConfigEntry objects to define child-screens that have specific Properties listed + - using custom IConfigEntry objects to define a dummy property that can be used to generate new ConfigCategory objects + - defining the configID string for a GuiConfig object so that the config changed events will be posted when that GuiConfig screen is closed + (the configID string is optional; if it is not defined the config changed events will be posted when the top-most GuiConfig screen + is closed, eg when the parent is null or is not an instance of GuiConfig) + - overriding the IConfigEntry.enabled() method to control the enabled state of one list entry based on the value of another entry + - overriding the IConfigEntry.onGuiClosed() method to perform custom actions when the screen that owns the entry is closed (in this + case a new ConfigCategory is added to the Configuration object) + + The config file structure looks like this: + forge.cfg (general settings all in one category) + forgeChunkLoading.cfg + - Forge (category) + - defaults (category) + - [optional mod override categories]... + + The GUI structure is this: + Base Screen + - General Settings (from forge.cfg) + - Chunk Loader Settings (from forgeChunkLoading.cfg) + - Defaults (these elements are listed directly on this screen) + - Mod Overrides + - Add New Mod Override + - Mod1 + - Mod2 + - etc. + + Other things to check out: + ForgeModContainer.syncConfig() + ForgeModContainer.onConfigChanged() + ForgeChunkManager.syncConfigDefaults() + ForgeChunkManager.loadConfiguration()
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForgeGuiFactory

        +
        public ForgeGuiFactory()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      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
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/package-frame.html b/javadoc/net/minecraftforge/client/gui/package-frame.html new file mode 100644 index 0000000..46ad226 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/package-frame.html @@ -0,0 +1,25 @@ + + + + + +net.minecraftforge.client.gui (Forge API) + + + + +

net.minecraftforge.client.gui

+
+

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/client/gui/package-summary.html b/javadoc/net/minecraftforge/client/gui/package-summary.html new file mode 100644 index 0000000..049b62f --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/package-summary.html @@ -0,0 +1,167 @@ + + + + + +net.minecraftforge.client.gui (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.client.gui

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/client/gui/package-tree.html b/javadoc/net/minecraftforge/client/gui/package-tree.html new file mode 100644 index 0000000..a5e7078 --- /dev/null +++ b/javadoc/net/minecraftforge/client/gui/package-tree.html @@ -0,0 +1,160 @@ + + + + + +net.minecraftforge.client.gui Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.client.gui

+Package Hierarchies: + +
+
+

Class Hierarchy

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