From 877312184c472d9845e5ef1008bc538f4634059f Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:50:56 +0300 Subject: fix missing source folder --- .../net/minecraftforge/common/AchievementPage.html | 369 ---- .../common/BiomeDictionary.Type.html | 712 ------- .../net/minecraftforge/common/BiomeDictionary.html | 442 ----- .../common/BiomeManager.BiomeEntry.html | 280 --- .../common/BiomeManager.BiomeType.html | 358 ---- .../net/minecraftforge/common/BiomeManager.html | 530 ------ .../net/minecraftforge/common/ChestGenHooks.html | 683 ------- .../minecraftforge/common/DimensionManager.html | 575 ------ .../common/DungeonHooks.DungeonMob.html | 312 --- .../net/minecraftforge/common/DungeonHooks.html | 323 ---- .../net/minecraftforge/common/EnumPlantType.html | 377 ---- .../common/FishingHooks.FishableCategory.html | 369 ---- .../net/minecraftforge/common/FishingHooks.html | 389 ---- .../common/ForgeChunkManager.ForceChunkEvent.html | 308 --- .../common/ForgeChunkManager.LoadingCallback.html | 225 --- .../ForgeChunkManager.OrderedLoadingCallback.html | 244 --- ...eChunkManager.PlayerOrderedLoadingCallback.html | 235 --- .../common/ForgeChunkManager.Ticket.html | 435 ----- .../common/ForgeChunkManager.Type.html | 327 ---- .../ForgeChunkManager.UnforceChunkEvent.html | 308 --- .../minecraftforge/common/ForgeChunkManager.html | 694 ------- javadoc/net/minecraftforge/common/ForgeHooks.html | 704 ------- .../common/ForgeInternalHandler.html | 293 --- .../minecraftforge/common/ForgeModContainer.html | 733 -------- .../minecraftforge/common/ForgeVersion.Status.html | 381 ---- .../net/minecraftforge/common/ForgeVersion.html | 443 ----- .../common/IExtendedEntityProperties.html | 253 --- .../common/IMinecartCollisionHandler.html | 274 --- javadoc/net/minecraftforge/common/IPlantable.html | 252 --- javadoc/net/minecraftforge/common/IShearable.html | 264 --- .../common/ISpecialArmor.ArmorProperties.html | 400 ---- .../net/minecraftforge/common/ISpecialArmor.html | 296 --- .../net/minecraftforge/common/MinecraftForge.html | 375 ---- .../net/minecraftforge/common/UsernameCache.html | 339 ---- .../common/WorldSpecificSaveHandler.html | 422 ----- .../common/chunkio/ChunkIOExecutor.html | 330 ---- .../common/chunkio/package-frame.html | 19 - .../common/chunkio/package-summary.html | 131 -- .../common/chunkio/package-tree.html | 126 -- .../common/config/ConfigCategory.html | 929 --------- .../common/config/ConfigElement.html | 919 --------- .../Configuration.UnicodeInputStreamReader.html | 340 ---- .../common/config/Configuration.html | 1988 -------------------- .../common/config/Property.Type.html | 395 ---- .../net/minecraftforge/common/config/Property.html | 1733 ----------------- .../common/config/package-frame.html | 27 - .../common/config/package-summary.html | 167 -- .../minecraftforge/common/config/package-tree.html | 146 -- .../common/network/DimensionMessageHandler.html | 349 ---- .../network/FluidIdRegistryMessageHandler.html | 349 ---- .../ForgeMessage.DimensionRegisterMessage.html | 264 --- .../network/ForgeMessage.FluidIdMapMessage.html | 250 --- .../common/network/ForgeMessage.html | 253 --- .../common/network/ForgeNetworkHandler.html | 256 --- .../common/network/ForgeRuntimeCodec.html | 386 ---- ...ServerToClientConnectionEstablishedHandler.html | 314 ---- .../common/network/package-frame.html | 26 - .../common/network/package-summary.html | 159 -- .../common/network/package-tree.html | 160 -- .../net/minecraftforge/common/package-frame.html | 59 - .../net/minecraftforge/common/package-summary.html | 308 --- .../net/minecraftforge/common/package-tree.html | 189 -- .../AsynchronousExecutor.CallBackProvider.html | 280 --- .../common/util/AsynchronousExecutor.html | 474 ----- .../minecraftforge/common/util/BlockSnapshot.html | 697 ------- .../common/util/ChunkCoordComparator.html | 272 --- .../minecraftforge/common/util/Constants.NBT.html | 439 ----- .../net/minecraftforge/common/util/Constants.html | 252 --- .../net/minecraftforge/common/util/EnumHelper.html | 544 ------ .../net/minecraftforge/common/util/FakePlayer.html | 558 ------ .../common/util/FakePlayerFactory.html | 289 --- .../minecraftforge/common/util/ForgeDirection.html | 551 ------ .../minecraftforge/common/util/RotationHelper.html | 279 --- .../minecraftforge/common/util/package-frame.html | 35 - .../common/util/package-summary.html | 207 -- .../minecraftforge/common/util/package-tree.html | 170 -- 76 files changed, 29543 deletions(-) delete mode 100644 javadoc/net/minecraftforge/common/AchievementPage.html delete mode 100644 javadoc/net/minecraftforge/common/BiomeDictionary.Type.html delete mode 100644 javadoc/net/minecraftforge/common/BiomeDictionary.html delete mode 100644 javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html delete mode 100644 javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html delete mode 100644 javadoc/net/minecraftforge/common/BiomeManager.html delete mode 100644 javadoc/net/minecraftforge/common/ChestGenHooks.html delete mode 100644 javadoc/net/minecraftforge/common/DimensionManager.html delete mode 100644 javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html delete mode 100644 javadoc/net/minecraftforge/common/DungeonHooks.html delete mode 100644 javadoc/net/minecraftforge/common/EnumPlantType.html delete mode 100644 javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html delete mode 100644 javadoc/net/minecraftforge/common/FishingHooks.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeChunkManager.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeHooks.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeInternalHandler.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeModContainer.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeVersion.Status.html delete mode 100644 javadoc/net/minecraftforge/common/ForgeVersion.html delete mode 100644 javadoc/net/minecraftforge/common/IExtendedEntityProperties.html delete mode 100644 javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html delete mode 100644 javadoc/net/minecraftforge/common/IPlantable.html delete mode 100644 javadoc/net/minecraftforge/common/IShearable.html delete mode 100644 javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html delete mode 100644 javadoc/net/minecraftforge/common/ISpecialArmor.html delete mode 100644 javadoc/net/minecraftforge/common/MinecraftForge.html delete mode 100644 javadoc/net/minecraftforge/common/UsernameCache.html delete mode 100644 javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html delete mode 100644 javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html delete mode 100644 javadoc/net/minecraftforge/common/chunkio/package-frame.html delete mode 100644 javadoc/net/minecraftforge/common/chunkio/package-summary.html delete mode 100644 javadoc/net/minecraftforge/common/chunkio/package-tree.html delete mode 100644 javadoc/net/minecraftforge/common/config/ConfigCategory.html delete mode 100644 javadoc/net/minecraftforge/common/config/ConfigElement.html delete mode 100644 javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html delete mode 100644 javadoc/net/minecraftforge/common/config/Configuration.html delete mode 100644 javadoc/net/minecraftforge/common/config/Property.Type.html delete mode 100644 javadoc/net/minecraftforge/common/config/Property.html delete mode 100644 javadoc/net/minecraftforge/common/config/package-frame.html delete mode 100644 javadoc/net/minecraftforge/common/config/package-summary.html delete mode 100644 javadoc/net/minecraftforge/common/config/package-tree.html delete mode 100644 javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html delete mode 100644 javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html delete mode 100644 javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html delete mode 100644 javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html delete mode 100644 javadoc/net/minecraftforge/common/network/ForgeMessage.html delete mode 100644 javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html delete mode 100644 javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html delete mode 100644 javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html delete mode 100644 javadoc/net/minecraftforge/common/network/package-frame.html delete mode 100644 javadoc/net/minecraftforge/common/network/package-summary.html delete mode 100644 javadoc/net/minecraftforge/common/network/package-tree.html delete mode 100644 javadoc/net/minecraftforge/common/package-frame.html delete mode 100644 javadoc/net/minecraftforge/common/package-summary.html delete mode 100644 javadoc/net/minecraftforge/common/package-tree.html delete mode 100644 javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html delete mode 100644 javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html delete mode 100644 javadoc/net/minecraftforge/common/util/BlockSnapshot.html delete mode 100644 javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html delete mode 100644 javadoc/net/minecraftforge/common/util/Constants.NBT.html delete mode 100644 javadoc/net/minecraftforge/common/util/Constants.html delete mode 100644 javadoc/net/minecraftforge/common/util/EnumHelper.html delete mode 100644 javadoc/net/minecraftforge/common/util/FakePlayer.html delete mode 100644 javadoc/net/minecraftforge/common/util/FakePlayerFactory.html delete mode 100644 javadoc/net/minecraftforge/common/util/ForgeDirection.html delete mode 100644 javadoc/net/minecraftforge/common/util/RotationHelper.html delete mode 100644 javadoc/net/minecraftforge/common/util/package-frame.html delete mode 100644 javadoc/net/minecraftforge/common/util/package-summary.html delete mode 100644 javadoc/net/minecraftforge/common/util/package-tree.html (limited to 'javadoc/net/minecraftforge/common') diff --git a/javadoc/net/minecraftforge/common/AchievementPage.html b/javadoc/net/minecraftforge/common/AchievementPage.html deleted file mode 100644 index 18ab6dc..0000000 --- a/javadoc/net/minecraftforge/common/AchievementPage.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - -AchievementPage (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common
-

Class AchievementPage

-
-
- -
-
    -
  • -
    -
    -
    public class AchievementPage
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        AchievementPage

        -
        public AchievementPage(java.lang.String name,
-               Achievement... achievements)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getName

        -
        public java.lang.String getName()
        -
        • -
      - - - -
        -
      • -

        getAchievements

        -
        public java.util.List<Achievement> getAchievements()
        -
        • -
      - - - -
        -
      • -

        registerAchievementPage

        -
        public static void registerAchievementPage(AchievementPage page)
        -
        Registers an achievement page.
        -
        Parameters:
        page - The page.
        -
        • -
      - - - -
        -
      • -

        getAchievementPage

        -
        public static AchievementPage getAchievementPage(int index)
        -
        Will return an achievement page by its index on the list.
        -
        Parameters:
        index - The page's index.
        -
        Returns:
        the achievement page corresponding to the index or null if invalid index
        -
        • -
      - - - -
        -
      • -

        getAchievementPage

        -
        public static AchievementPage getAchievementPage(java.lang.String name)
        -
        Will return an achievement page by its name.
        -
        Parameters:
        name - The page's name.
        -
        Returns:
        the achievement page with the given name or null if no such page
        -
        • -
      - - - -
        -
      • -

        getAchievementPages

        -
        public static java.util.Set<AchievementPage> getAchievementPages()
        -
        Will return the list of achievement pages.
        -
        Returns:
        the list's size
        -
        • -
      - - - -
        -
      • -

        isAchievementInPages

        -
        public static boolean isAchievementInPages(Achievement achievement)
        -
        Will return whether an achievement is in any page or not.
        -
        Parameters:
        achievement - The achievement.
        -
        • -
      - - - -
        -
      • -

        getTitle

        -
        public static java.lang.String getTitle(int index)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html b/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html deleted file mode 100644 index a0ab768..0000000 --- a/javadoc/net/minecraftforge/common/BiomeDictionary.Type.html +++ /dev/null @@ -1,712 +0,0 @@ - - - - - -BiomeDictionary.Type (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Enum BiomeDictionary.Type

-
-
- -
- -
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/BiomeDictionary.html b/javadoc/net/minecraftforge/common/BiomeDictionary.html deleted file mode 100644 index 9fdfc67..0000000 --- a/javadoc/net/minecraftforge/common/BiomeDictionary.html +++ /dev/null @@ -1,442 +0,0 @@ - - - - - -BiomeDictionary (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class BiomeDictionary

-
-
- -
-
    -
  • -
    -
    -
    public class BiomeDictionary
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BiomeDictionary

        -
        public BiomeDictionary()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        registerBiomeType

        -
        public static boolean registerBiomeType(BiomeGenBase biome,
-                        BiomeDictionary.Type... types)
        -
        Registers a biome with a specific biome type
        -
        Parameters:
        biome - the biome to be registered
        type - the type to register the biome as
        -
        Returns:
        returns true if the biome was registered successfully
        -
        • -
      - - - -
        -
      • -

        getBiomesForType

        -
        public static BiomeGenBase[] getBiomesForType(BiomeDictionary.Type type)
        -
        Returns a list of biomes registered with a specific type
        -
        Parameters:
        type - the Type to look for
        -
        Returns:
        a list of biomes of the specified type, null if there are none
        -
        • -
      - - - -
        -
      • -

        getTypesForBiome

        -
        public static BiomeDictionary.Type[] getTypesForBiome(BiomeGenBase biome)
        -
        Gets a list of Types that a specific biome is registered with
        -
        Parameters:
        biome - the biome to check
        -
        Returns:
        the list of types, null if there are none
        -
        • -
      - - - -
        -
      • -

        areBiomesEquivalent

        -
        public static boolean areBiomesEquivalent(BiomeGenBase biomeA,
-                          BiomeGenBase biomeB)
        -
        Checks to see if two biomes are registered as having the same type
        -
        Parameters:
        biomeA -
        biomeB -
        -
        Returns:
        returns true if a common type is found, false otherwise
        -
        • -
      - - - -
        -
      • -

        isBiomeOfType

        -
        public static boolean isBiomeOfType(BiomeGenBase biome,
-                    BiomeDictionary.Type type)
        -
        Checks to see if the given biome is registered as being a specific type
        -
        Parameters:
        biome - the biome to be considered
        type - the type to check for
        -
        Returns:
        returns true if the biome is registered as being of type type, false otherwise
        -
        • -
      - - - -
        -
      • -

        isBiomeRegistered

        -
        public static boolean isBiomeRegistered(BiomeGenBase biome)
        -
        Checks to see if the given biome has been registered as being of any type
        -
        Parameters:
        biome - the biome to consider
        -
        Returns:
        returns true if the biome has been registered, false otherwise
        -
        • -
      - - - -
        -
      • -

        isBiomeRegistered

        -
        public static boolean isBiomeRegistered(int biomeID)
        -
        • -
      - - - -
        -
      • -

        registerAllBiomes

        -
        public static void registerAllBiomes()
        -
        • -
      - - - -
        -
      • -

        registerAllBiomesAndGenerateEvents

        -
        public static void registerAllBiomesAndGenerateEvents()
        -
        Loops through the biome list and automatically adds tags to any biome that does not have any - This is called by Forge at postinit time. It will additionally dispatch any deferred decorator - creation events. - - DO NOT call this during world generation
        -
        • -
      - - - -
        -
      • -

        makeBestGuess

        -
        public static void makeBestGuess(BiomeGenBase biome)
        -
        Automatically looks for and registers a given biome with appropriate tags - This method is called automatically if a biome has not been registered with any tags, - And another method requests information about it
        -
        Parameters:
        biome - the biome to be considered
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html b/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html deleted file mode 100644 index e07bed1..0000000 --- a/javadoc/net/minecraftforge/common/BiomeManager.BiomeEntry.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - -BiomeManager.BiomeEntry (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class BiomeManager.BiomeEntry

-
-
- -
- -
-
-
    -
  • - - - - - -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        BiomeManager.BiomeEntry

        -
        public BiomeManager.BiomeEntry(BiomeGenBase biome,
-                       int weight)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html b/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html deleted file mode 100644 index 5345773..0000000 --- a/javadoc/net/minecraftforge/common/BiomeManager.BiomeType.html +++ /dev/null @@ -1,358 +0,0 @@ - - - - - -BiomeManager.BiomeType (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Enum BiomeManager.BiomeType

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      COOL 
      DESERT 
      ICY 
      WARM 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static BiomeManager.BiomeTypegetType(java.lang.String name) 
      static BiomeManager.BiomeTypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static BiomeManager.BiomeType[]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 BiomeManager.BiomeType[] 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 (BiomeManager.BiomeType c : BiomeManager.BiomeType.values())
-    System.out.println(c);
-
        -
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static BiomeManager.BiomeType 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/net/minecraftforge/common/BiomeManager.html b/javadoc/net/minecraftforge/common/BiomeManager.html deleted file mode 100644 index cdb41ab..0000000 --- a/javadoc/net/minecraftforge/common/BiomeManager.html +++ /dev/null @@ -1,530 +0,0 @@ - - - - - -BiomeManager (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class BiomeManager

-
-
- -
-
    -
  • -
    -
    -
    public class BiomeManager
-extends java.lang.Object
    -
    • -
-
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ChestGenHooks.html b/javadoc/net/minecraftforge/common/ChestGenHooks.html deleted file mode 100644 index 366a209..0000000 --- a/javadoc/net/minecraftforge/common/ChestGenHooks.html +++ /dev/null @@ -1,683 +0,0 @@ - - - - - -ChestGenHooks (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ChestGenHooks

-
-
- -
-
    -
  • -
    -
    -
    public class ChestGenHooks
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ChestGenHooks

        -
        public ChestGenHooks(java.lang.String category)
        -
        • -
      - - - -
        -
      • -

        ChestGenHooks

        -
        public ChestGenHooks(java.lang.String category,
-             WeightedRandomChestContent[] items,
-             int min,
-             int max)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getInfo

        -
        public static ChestGenHooks getInfo(java.lang.String category)
        -
        Retrieves, or creates the info class for the specified category.
        -
        Parameters:
        category - The category name
        -
        Returns:
        A instance of ChestGenHooks for the specified category.
        -
        • -
      - - - -
        -
      • -

        generateStacks

        -
        public static ItemStack[] generateStacks(java.util.Random rand,
-                         ItemStack source,
-                         int min,
-                         int max)
        -
        Generates an array of items based on the input min/max count. - If the stack can not hold the total amount, it will be split into - stacks of size 1.
        -
        Parameters:
        rand - A random number generator
        source - Source item stack
        min - Minimum number of items
        max - Maximum number of items
        -
        Returns:
        An array containing the generated item stacks
        -
        • -
      - - - - - - - -
        -
      • -

        getCount

        -
        public static int getCount(java.lang.String category,
-           java.util.Random rand)
        -
        • -
      - - - - - - - -
        -
      • -

        removeItem

        -
        public static void removeItem(java.lang.String category,
-              ItemStack item)
        -
        • -
      - - - -
        -
      • -

        getOneItem

        -
        public static ItemStack getOneItem(java.lang.String category,
-                   java.util.Random rand)
        -
        • -
      - - - -
        -
      • -

        addItem

        -
        public void addItem(WeightedRandomChestContent item)
        -
        Adds a new entry into the possible items to generate.
        -
        Parameters:
        item - The item to add.
        -
        • -
      - - - -
        -
      • -

        removeItem

        -
        public void removeItem(ItemStack item)
        -
        Removes all items that match the input item stack, Only metadata and item ID are checked. - If the input item has a metadata of -1, all metadatas will match.
        -
        Parameters:
        item - The item to check
        -
        • -
      - - - -
        -
      • -

        getItems

        -
        public WeightedRandomChestContent[] getItems(java.util.Random rnd)
        -
        Gets an array of all random objects that are associated with this category.
        -
        Returns:
        The random objects
        -
        • -
      - - - -
        -
      • -

        getCount

        -
        public int getCount(java.util.Random rand)
        -
        Gets a random number between countMin and countMax.
        -
        Parameters:
        rand - A RNG
        -
        Returns:
        A random number where countMin <= num <= countMax
        -
        • -
      - - - -
        -
      • -

        getOneItem

        -
        public ItemStack getOneItem(java.util.Random rand)
        -
        Returns a single ItemStack from the possible items in this registry, - Useful if you just want a quick and dirty random Item.
        -
        Parameters:
        rand - A Random Number gen
        -
        Returns:
        A single ItemStack, or null if it could not get one.
        -
        • -
      - - - -
        -
      • -

        getMin

        -
        public int getMin()
        -
        • -
      - - - -
        -
      • -

        getMax

        -
        public int getMax()
        -
        • -
      - - - -
        -
      • -

        setMin

        -
        public void setMin(int value)
        -
        • -
      - - - -
        -
      • -

        setMax

        -
        public void setMax(int value)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/DimensionManager.html b/javadoc/net/minecraftforge/common/DimensionManager.html deleted file mode 100644 index 9e54cb5..0000000 --- a/javadoc/net/minecraftforge/common/DimensionManager.html +++ /dev/null @@ -1,575 +0,0 @@ - - - - - -DimensionManager (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common
-

Class DimensionManager

-
-
- -
-
    -
  • -
    -
    -
    public class DimensionManager
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DimensionManager

        -
        public DimensionManager()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        registerProviderType

        -
        public static boolean registerProviderType(int id,
-                           java.lang.Class<? extends WorldProvider> provider,
-                           boolean keepLoaded)
        -
        • -
      - - - -
        -
      • -

        unregisterProviderType

        -
        public static int[] unregisterProviderType(int id)
        -
        Unregisters a Provider type, and returns a array of all dimensions that are - registered to this provider type. - If the return size is greater then 0, it is required that the caller either - change those dimensions's registered type, or replace this type before the - world is attempted to load, else the loader will throw an exception.
        -
        Parameters:
        id - The provider type ID to unreigster
        -
        Returns:
        An array containing all dimension IDs still registered to this provider type.
        -
        • -
      - - - -
        -
      • -

        init

        -
        public static void init()
        -
        • -
      - - - -
        -
      • -

        registerDimension

        -
        public static void registerDimension(int id,
-                     int providerType)
        -
        • -
      - - - -
        -
      • -

        unregisterDimension

        -
        public static void unregisterDimension(int id)
        -
        For unregistering a dimension when the save is changed (disconnected from a server or loaded a new save
        -
        • -
      - - - -
        -
      • -

        isDimensionRegistered

        -
        public static boolean isDimensionRegistered(int dim)
        -
        • -
      - - - -
        -
      • -

        getProviderType

        -
        public static int getProviderType(int dim)
        -
        • -
      - - - -
        -
      • -

        getProvider

        -
        public static WorldProvider getProvider(int dim)
        -
        • -
      - - - -
        -
      • -

        getIDs

        -
        public static java.lang.Integer[] getIDs(boolean check)
        -
        • -
      - - - -
        -
      • -

        getIDs

        -
        public static java.lang.Integer[] getIDs()
        -
        • -
      - - - -
        -
      • -

        setWorld

        -
        public static void setWorld(int id,
-            WorldServer world)
        -
        • -
      - - - -
        -
      • -

        initDimension

        -
        public static void initDimension(int dim)
        -
        • -
      - - - -
        -
      • -

        getWorld

        -
        public static WorldServer getWorld(int id)
        -
        • -
      - - - -
        -
      • -

        getWorlds

        -
        public static WorldServer[] getWorlds()
        -
        • -
      - - - -
        -
      • -

        shouldLoadSpawn

        -
        public static boolean shouldLoadSpawn(int dim)
        -
        • -
      - - - -
        -
      • -

        getStaticDimensionIDs

        -
        public static java.lang.Integer[] getStaticDimensionIDs()
        -
        Not public API: used internally to get dimensions that should load at - server startup
        -
        • -
      - - - -
        -
      • -

        createProviderFor

        -
        public static WorldProvider createProviderFor(int dim)
        -
        • -
      - - - -
        -
      • -

        unloadWorld

        -
        public static void unloadWorld(int id)
        -
        • -
      - - - -
        -
      • -

        unloadWorlds

        -
        public static void unloadWorlds(java.util.Hashtable<java.lang.Integer,long[]> worldTickTimes)
        -
        • -
      - - - -
        -
      • -

        getNextFreeDimId

        -
        public static int getNextFreeDimId()
        -
        Return the next free dimension ID. Note: you are not guaranteed a contiguous - block of free ids. Always call for each individual ID you wish to get.
        -
        Returns:
        the next free dimension ID
        -
        • -
      - - - -
        -
      • -

        saveDimensionDataMap

        -
        public static NBTTagCompound saveDimensionDataMap()
        -
        • -
      - - - -
        -
      • -

        loadDimensionDataMap

        -
        public static void loadDimensionDataMap(NBTTagCompound compoundTag)
        -
        • -
      - - - -
        -
      • -

        getCurrentSaveRootDirectory

        -
        public static java.io.File getCurrentSaveRootDirectory()
        -
        Return the current root directory for the world save. Accesses getSaveHandler from the overworld
        -
        Returns:
        the root directory of the save
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html b/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html deleted file mode 100644 index 34b645e..0000000 --- a/javadoc/net/minecraftforge/common/DungeonHooks.DungeonMob.html +++ /dev/null @@ -1,312 +0,0 @@ - - - - - -DungeonHooks.DungeonMob (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class DungeonHooks.DungeonMob

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      java.lang.Stringtype 
      - -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DungeonHooks.DungeonMob(int weight, - java.lang.String type) 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object target) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        type

        -
        public java.lang.String type
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DungeonHooks.DungeonMob

        -
        public DungeonHooks.DungeonMob(int weight,
-                       java.lang.String type)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object target)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/DungeonHooks.html b/javadoc/net/minecraftforge/common/DungeonHooks.html deleted file mode 100644 index 7786fe8..0000000 --- a/javadoc/net/minecraftforge/common/DungeonHooks.html +++ /dev/null @@ -1,323 +0,0 @@ - - - - - -DungeonHooks (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class DungeonHooks

-
-
- -
-
    -
  • -
    -
    -
    public class DungeonHooks
-extends java.lang.Object
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass and Description
      static class DungeonHooks.DungeonMob 
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DungeonHooks() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static floataddDungeonMob(java.lang.String name, - int rarity) -
      Adds a mob to the possible list of creatures the spawner will create.
      -
      static java.lang.StringgetRandomDungeonMob(java.util.Random rand) -
      Gets a random mob name from the list.
      -
      static intremoveDungeonMob(java.lang.String name) -
      Will completely remove a Mob from the dungeon spawn list.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        DungeonHooks

        -
        public DungeonHooks()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addDungeonMob

        -
        public static float addDungeonMob(java.lang.String name,
-                  int rarity)
        -
        Adds a mob to the possible list of creatures the spawner will create. - If the mob is already in the spawn list, the rarity will be added to the existing one, - causing the mob to be more common.
        -
        Parameters:
        name - The name of the monster, use the same name used when registering the entity.
        rarity - The rarity of selecting this mob over others. Must be greater then 0. - Vanilla Minecraft has the following mobs: - Spider 100 - Skeleton 100 - Zombie 200 - Meaning, Zombies are twice as common as spiders or skeletons.
        -
        Returns:
        The new rarity of the monster,
        -
        • -
      - - - -
        -
      • -

        removeDungeonMob

        -
        public static int removeDungeonMob(java.lang.String name)
        -
        Will completely remove a Mob from the dungeon spawn list.
        -
        Parameters:
        name - The name of the mob to remove
        -
        Returns:
        The rarity of the removed mob, prior to being removed.
        -
        • -
      - - - -
        -
      • -

        getRandomDungeonMob

        -
        public static java.lang.String getRandomDungeonMob(java.util.Random rand)
        -
        Gets a random mob name from the list.
        -
        Parameters:
        rand - World generation random number generator
        -
        Returns:
        The mob name
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/EnumPlantType.html b/javadoc/net/minecraftforge/common/EnumPlantType.html deleted file mode 100644 index 5ea8691..0000000 --- a/javadoc/net/minecraftforge/common/EnumPlantType.html +++ /dev/null @@ -1,377 +0,0 @@ - - - - - -EnumPlantType (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Enum EnumPlantType

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

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static EnumPlantTypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static EnumPlantType[]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 EnumPlantType[] 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 (EnumPlantType c : EnumPlantType.values())
-    System.out.println(c);
-
        -
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static EnumPlantType 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/net/minecraftforge/common/FishingHooks.FishableCategory.html b/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html deleted file mode 100644 index a11e3c9..0000000 --- a/javadoc/net/minecraftforge/common/FishingHooks.FishableCategory.html +++ /dev/null @@ -1,369 +0,0 @@ - - - - - -FishingHooks.FishableCategory (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Enum FishingHooks.FishableCategory

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      FISH 
      JUNK 
      TREASURE 
      -
      • -
    - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      StatBasestat 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static FishingHooks.FishableCategoryvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static FishingHooks.FishableCategory[]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 FishingHooks.FishableCategory[] 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 (FishingHooks.FishableCategory c : FishingHooks.FishableCategory.values())
-    System.out.println(c);
-
        -
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static FishingHooks.FishableCategory 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/net/minecraftforge/common/FishingHooks.html b/javadoc/net/minecraftforge/common/FishingHooks.html deleted file mode 100644 index 1ba6df5..0000000 --- a/javadoc/net/minecraftforge/common/FishingHooks.html +++ /dev/null @@ -1,389 +0,0 @@ - - - - - -FishingHooks (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class FishingHooks

-
-
- -
-
    -
  • -
    -
    -
    public class FishingHooks
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FishingHooks

        -
        public FishingHooks()
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html deleted file mode 100644 index 1995c7f..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.ForceChunkEvent.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -ForgeChunkManager.ForceChunkEvent (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeChunkManager.ForceChunkEvent

-
-
- -
-
    -
  • -
    -
    Enclosing class:
    -
    ForgeChunkManager
    -
    -
    -
    -
    public static class ForgeChunkManager.ForceChunkEvent
-extends Event
    -
    • -
-
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html deleted file mode 100644 index 8c8a6a1..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.LoadingCallback.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - -ForgeChunkManager.LoadingCallback (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface ForgeChunkManager.LoadingCallback

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voidticketsLoaded(java.util.List<ForgeChunkManager.Ticket> tickets, - World world) -
      Called back when tickets are loaded from the world to allow the - mod to re-register the chunks associated with those tickets.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        ticketsLoaded

        -
        void ticketsLoaded(java.util.List<ForgeChunkManager.Ticket> tickets,
-                 World world)
        -
        Called back when tickets are loaded from the world to allow the - mod to re-register the chunks associated with those tickets. The list supplied - here is truncated to length prior to use. Tickets unwanted by the - mod must be disposed of manually unless the mod is an OrderedLoadingCallback instance - in which case, they will have been disposed of by the earlier callback.
        -
        Parameters:
        tickets - The tickets to re-register. The list is immutable and cannot be manipulated directly. Copy it first.
        world - the world
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html deleted file mode 100644 index 9a4eff4..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.OrderedLoadingCallback.html +++ /dev/null @@ -1,244 +0,0 @@ - - - - - -ForgeChunkManager.OrderedLoadingCallback (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface ForgeChunkManager.OrderedLoadingCallback

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    ForgeChunkManager.LoadingCallback
    -
    -
    -
    Enclosing class:
    -
    ForgeChunkManager
    -
    -
    -
    -
    public static interface ForgeChunkManager.OrderedLoadingCallback
-extends ForgeChunkManager.LoadingCallback
    -
    This is a special LoadingCallback that can be implemented as well as the - LoadingCallback to provide access to additional behaviour. - Specifically, this callback will fire prior to Forge dropping excess - tickets. Tickets in the returned list are presumed ordered and excess will - be truncated from the returned list. - This allows the mod to control not only if they actually want a ticket but - also their preferred ticket ordering.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        ticketsLoaded

        -
        java.util.List<ForgeChunkManager.Ticket> ticketsLoaded(java.util.List<ForgeChunkManager.Ticket> tickets,
-                                                     World world,
-                                                     int maxTicketCount)
        -
        Called back when tickets are loaded from the world to allow the - mod to decide if it wants the ticket still, and prioritise overflow - based on the ticket count. - WARNING: You cannot force chunks in this callback, it is strictly for allowing the mod - to be more selective in which tickets it wishes to preserve in an overflow situation
        -
        Parameters:
        tickets - The tickets that you will want to select from. The list is immutable and cannot be manipulated directly. Copy it first.
        world - The world
        maxTicketCount - The maximum number of tickets that will be allowed.
        -
        Returns:
        A list of the tickets this mod wishes to continue using. This list will be truncated - to "maxTicketCount" size after the call returns and then offered to the other callback - method
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html deleted file mode 100644 index 492868e..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.PlayerOrderedLoadingCallback.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - - -ForgeChunkManager.PlayerOrderedLoadingCallback (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface ForgeChunkManager.PlayerOrderedLoadingCallback

-
-
-
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        playerTicketsLoaded

        -
        com.google.common.collect.ListMultimap<java.lang.String,ForgeChunkManager.Ticket> playerTicketsLoaded(com.google.common.collect.ListMultimap<java.lang.String,ForgeChunkManager.Ticket> tickets,
-                                                                                                    World world)
        -
        Called back when tickets are loaded from the world to allow the - mod to decide if it wants the ticket still. - This is for player bound tickets rather than mod bound tickets. It is here so mods can - decide they want to dump all player tickets - - WARNING: You cannot force chunks in this callback, it is strictly for allowing the mod - to be more selective in which tickets it wishes to preserve
        -
        Parameters:
        tickets - The tickets that you will want to select from. The list is immutable and cannot be manipulated directly. Copy it first.
        world - The world
        -
        Returns:
        A list of the tickets this mod wishes to use. This list will subsequently be offered - to the main callback for action
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html deleted file mode 100644 index 181e4eb..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.Ticket.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - -ForgeChunkManager.Ticket (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeChunkManager.Ticket

-
-
- -
-
    -
  • -
    -
    Enclosing class:
    -
    ForgeChunkManager
    -
    -
    -
    -
    public static class ForgeChunkManager.Ticket
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        world

        -
        public final World world
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        setChunkListDepth

        -
        public void setChunkListDepth(int depth)
        -
        The chunk list depth can be manipulated up to the maximal grant allowed for the mod. This value is configurable. Once the maximum is reached, - the least recently forced chunk, by original registration time, is removed from the forced chunk list.
        -
        Parameters:
        depth - The new depth to set
        -
        • -
      - - - -
        -
      • -

        getChunkListDepth

        -
        public int getChunkListDepth()
        -
        Gets the current max depth for this ticket. - Should be the same as getMaxChunkListDepth() - unless setChunkListDepth has been called.
        -
        Returns:
        Current max depth
        -
        • -
      - - - -
        -
      • -

        getMaxChunkListDepth

        -
        public int getMaxChunkListDepth()
        -
        Get the maximum chunk depth size
        -
        Returns:
        The maximum chunk depth size
        -
        • -
      - - - -
        -
      • -

        bindEntity

        -
        public void bindEntity(Entity entity)
        -
        Bind the entity to the ticket for ForgeChunkManager.Type.ENTITY type tickets. Other types will throw a runtime exception.
        -
        Parameters:
        entity - The entity to bind
        -
        • -
      - - - -
        -
      • -

        getModData

        -
        public NBTTagCompound getModData()
        -
        Retrieve the NBTTagCompound that stores mod specific data for the chunk ticket. - Example data to store would be a TileEntity or Block location. This is persisted with the ticket and - provided to the ForgeChunkManager.LoadingCallback for the mod. It is recommended to use this to recover - useful state information for the forced chunks.
        -
        Returns:
        The custom compound tag for mods to store additional chunkloading data
        -
        • -
      - - - - - - - -
        -
      • -

        isPlayerTicket

        -
        public boolean isPlayerTicket()
        -
        Is this a player associated ticket rather than a mod associated ticket?
        -
        • -
      - - - -
        -
      • -

        getPlayerName

        -
        public java.lang.String getPlayerName()
        -
        Get the player associated with this ticket
        -
        • -
      - - - -
        -
      • -

        getModId

        -
        public java.lang.String getModId()
        -
        Get the associated mod id
        -
        • -
      - - - - - - - -
        -
      • -

        getChunkList

        -
        public com.google.common.collect.ImmutableSet<ChunkCoordIntPair> getChunkList()
        -
        Gets a list of requested chunks for this ticket.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html deleted file mode 100644 index a92ba7b..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.Type.html +++ /dev/null @@ -1,327 +0,0 @@ - - - - - -ForgeChunkManager.Type (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Enum ForgeChunkManager.Type

-
-
- -
- -
-
-
    -
  • - -
      -
    • - - -

      Enum Constant Summary

      - - - - - - - - - - - -
      Enum Constants 
      Enum Constant and Description
      ENTITY -
      For entity registrations
      -
      NORMAL -
      For non-entity registrations
      -
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static ForgeChunkManager.TypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static ForgeChunkManager.Type[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static ForgeChunkManager.Type[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (ForgeChunkManager.Type c : ForgeChunkManager.Type.values())
-    System.out.println(c);
-
        -
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static ForgeChunkManager.Type valueOf(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        Parameters:
        name - the name of the enum constant to be returned.
        -
        Returns:
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html deleted file mode 100644 index 3adfe41..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.UnforceChunkEvent.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -ForgeChunkManager.UnforceChunkEvent (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeChunkManager.UnforceChunkEvent

-
-
- -
-
    -
  • -
    -
    Enclosing class:
    -
    ForgeChunkManager
    -
    -
    -
    -
    public static class ForgeChunkManager.UnforceChunkEvent
-extends Event
    -
    • -
-
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeChunkManager.html b/javadoc/net/minecraftforge/common/ForgeChunkManager.html deleted file mode 100644 index 0550c95..0000000 --- a/javadoc/net/minecraftforge/common/ForgeChunkManager.html +++ /dev/null @@ -1,694 +0,0 @@ - - - - - -ForgeChunkManager (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeChunkManager

-
-
- -
-
    -
  • -
    -
    -
    public class ForgeChunkManager
-extends java.lang.Object
    -
    Manages chunkloading for mods. - - The basic principle is a ticket based system. - 1. Mods register a callback setForcedChunkLoadingCallback(Object, LoadingCallback) - 2. Mods ask for a ticket requestTicket(Object, World, Type) and then hold on to that ticket. - 3. Mods request chunks to stay loaded forceChunk(Ticket, ChunkCoordIntPair) or remove chunks from force loading unforceChunk(Ticket, ChunkCoordIntPair). - 4. When a world unloads, the tickets associated with that world are saved by the chunk manager. - 5. When a world loads, saved tickets are offered to the mods associated with the tickets. The ForgeChunkManager.Ticket.getModData() that is set by the mod should be used to re-register - chunks to stay loaded (and maybe take other actions). - - The chunkloading is configurable at runtime. The file "config/forgeChunkLoading.cfg" contains both default configuration for chunkloading, and a sample individual mod - specific override section.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        MOD_PROP_ORDER

        -
        public static final java.util.List<java.lang.String> MOD_PROP_ORDER
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ForgeChunkManager

        -
        public ForgeChunkManager()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        savedWorldHasForcedChunkTickets

        -
        public static boolean savedWorldHasForcedChunkTickets(java.io.File chunkDir)
        -
        Allows dynamically loading world mods to test if there are chunk tickets in the world - Mods that add dynamically generated worlds (like Mystcraft) should call this method - to determine if the world should be loaded during server starting.
        -
        Parameters:
        chunkDir - The chunk directory to test: should be equivalent to WorldServer.getChunkSaveLocation()
        -
        Returns:
        if there are tickets outstanding for this world or not
        -
        • -
      - - - -
        -
      • -

        setForcedChunkLoadingCallback

        -
        public static void setForcedChunkLoadingCallback(java.lang.Object mod,
-                                 ForgeChunkManager.LoadingCallback callback)
        -
        Set a chunkloading callback for the supplied mod object
        -
        Parameters:
        mod - The mod instance registering the callback
        callback - The code to call back when forced chunks are loaded
        -
        • -
      - - - -
        -
      • -

        ticketCountAvailableFor

        -
        public static int ticketCountAvailableFor(java.lang.Object mod,
-                          World world)
        -
        Discover the available tickets for the mod in the world
        -
        Parameters:
        mod - The mod that will own the tickets
        world - The world
        -
        Returns:
        The count of tickets left for the mod in the supplied world
        -
        • -
      - - - -
        -
      • -

        getMaxTicketLengthFor

        -
        public static int getMaxTicketLengthFor(java.lang.String modId)
        -
        • -
      - - - -
        -
      • -

        getMaxChunkDepthFor

        -
        public static int getMaxChunkDepthFor(java.lang.String modId)
        -
        • -
      - - - -
        -
      • -

        ticketCountAvailableFor

        -
        public static int ticketCountAvailableFor(java.lang.String username)
        -
        • -
      - - - - - - - -
        -
      • -

        requestTicket

        -
        public static ForgeChunkManager.Ticket requestTicket(java.lang.Object mod,
-                                     World world,
-                                     ForgeChunkManager.Type type)
        -
        Request a chunkloading ticket of the appropriate type for the supplied mod
        -
        Parameters:
        mod - The mod requesting a ticket
        world - The world in which it is requesting the ticket
        type - The type of ticket
        -
        Returns:
        A ticket with which to register chunks for loading, or null if no further tickets are available
        -
        • -
      - - - -
        -
      • -

        releaseTicket

        -
        public static void releaseTicket(ForgeChunkManager.Ticket ticket)
        -
        Release the ticket back to the system. This will also unforce any chunks held by the ticket so that they can be unloaded and/or stop ticking.
        -
        Parameters:
        ticket - The ticket to release
        -
        • -
      - - - -
        -
      • -

        forceChunk

        -
        public static void forceChunk(ForgeChunkManager.Ticket ticket,
-              ChunkCoordIntPair chunk)
        -
        Force the supplied chunk coordinate to be loaded by the supplied ticket. If the ticket's ForgeChunkManager.Ticket.maxDepth is exceeded, the least - recently registered chunk is unforced and may be unloaded. - It is safe to force the chunk several times for a ticket, it will not generate duplication or change the ordering.
        -
        Parameters:
        ticket - The ticket registering the chunk
        chunk - The chunk to force
        -
        • -
      - - - -
        -
      • -

        reorderChunk

        -
        public static void reorderChunk(ForgeChunkManager.Ticket ticket,
-                ChunkCoordIntPair chunk)
        -
        Reorganize the internal chunk list so that the chunk supplied is at the *end* of the list - This helps if you wish to guarantee a certain "automatic unload ordering" for the chunks - in the ticket list
        -
        Parameters:
        ticket - The ticket holding the chunk list
        chunk - The chunk you wish to push to the end (so that it would be unloaded last)
        -
        • -
      - - - -
        -
      • -

        unforceChunk

        -
        public static void unforceChunk(ForgeChunkManager.Ticket ticket,
-                ChunkCoordIntPair chunk)
        -
        Unforce the supplied chunk, allowing it to be unloaded and stop ticking.
        -
        Parameters:
        ticket - The ticket holding the chunk
        chunk - The chunk to unforce
        -
        • -
      - - - -
        -
      • -

        getPersistentChunksFor

        -
        public static com.google.common.collect.ImmutableSetMultimap<ChunkCoordIntPair,ForgeChunkManager.Ticket> getPersistentChunksFor(World world)
        -
        The list of persistent chunks in the world. This set is immutable.
        -
        Parameters:
        world -
        -
        Returns:
        the list of persistent chunks in the world
        -
        • -
      - - - -
        -
      • -

        putDormantChunk

        -
        public static void putDormantChunk(long coords,
-                   Chunk chunk)
        -
        • -
      - - - -
        -
      • -

        fetchDormantChunk

        -
        public static Chunk fetchDormantChunk(long coords,
-                      World world)
        -
        • -
      - - - -
        -
      • -

        syncConfigDefaults

        -
        public static void syncConfigDefaults()
        -
        Synchronizes the local fields with the values in the Configuration object.
        -
        • -
      - - - - - - - -
        -
      • -

        getDefaultsCategory

        -
        public static ConfigCategory getDefaultsCategory()
        -
        • -
      - - - -
        -
      • -

        getModCategories

        -
        public static java.util.List<ConfigCategory> getModCategories()
        -
        • -
      - - - -
        -
      • -

        getConfigFor

        -
        public static ConfigCategory getConfigFor(java.lang.Object mod)
        -
        • -
      - - - -
        -
      • -

        addConfigProperty

        -
        public static void addConfigProperty(java.lang.Object mod,
-                     java.lang.String propertyName,
-                     java.lang.String value,
-                     Property.Type type)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeHooks.html b/javadoc/net/minecraftforge/common/ForgeHooks.html deleted file mode 100644 index c94810b..0000000 --- a/javadoc/net/minecraftforge/common/ForgeHooks.html +++ /dev/null @@ -1,704 +0,0 @@ - - - - - -ForgeHooks (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeHooks

-
-
- -
-
    -
  • -
    -
    -
    public class ForgeHooks
-extends java.lang.Object
    -
    • -
-
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeInternalHandler.html b/javadoc/net/minecraftforge/common/ForgeInternalHandler.html deleted file mode 100644 index 8f38de5..0000000 --- a/javadoc/net/minecraftforge/common/ForgeInternalHandler.html +++ /dev/null @@ -1,293 +0,0 @@ - - - - - -ForgeInternalHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeInternalHandler

-
-
- -
-
    -
  • -
    -
    -
    public class ForgeInternalHandler
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ForgeInternalHandler

        -
        public ForgeInternalHandler()
        -
        • -
      -
      • -
    - - -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeModContainer.html b/javadoc/net/minecraftforge/common/ForgeModContainer.html deleted file mode 100644 index eafdcdd..0000000 --- a/javadoc/net/minecraftforge/common/ForgeModContainer.html +++ /dev/null @@ -1,733 +0,0 @@ - - - - - -ForgeModContainer (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeModContainer

-
-
- -
- -
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ForgeVersion.Status.html b/javadoc/net/minecraftforge/common/ForgeVersion.Status.html deleted file mode 100644 index b7f1714..0000000 --- a/javadoc/net/minecraftforge/common/ForgeVersion.Status.html +++ /dev/null @@ -1,381 +0,0 @@ - - - - - -ForgeVersion.Status (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Enum ForgeVersion.Status

-
-
- -
- -
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static ForgeVersion.StatusvalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static ForgeVersion.Status[]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 ForgeVersion.Status[] 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 (ForgeVersion.Status c : ForgeVersion.Status.values())
-    System.out.println(c);
-
        -
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static ForgeVersion.Status 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/net/minecraftforge/common/ForgeVersion.html b/javadoc/net/minecraftforge/common/ForgeVersion.html deleted file mode 100644 index be1e4f8..0000000 --- a/javadoc/net/minecraftforge/common/ForgeVersion.html +++ /dev/null @@ -1,443 +0,0 @@ - - - - - -ForgeVersion (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ForgeVersion

-
-
- -
-
    -
  • -
    -
    -
    public class ForgeVersion
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ForgeVersion

        -
        public ForgeVersion()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getMajorVersion

        -
        public static int getMajorVersion()
        -
        • -
      - - - -
        -
      • -

        getMinorVersion

        -
        public static int getMinorVersion()
        -
        • -
      - - - -
        -
      • -

        getRevisionVersion

        -
        public static int getRevisionVersion()
        -
        • -
      - - - -
        -
      • -

        getBuildVersion

        -
        public static int getBuildVersion()
        -
        • -
      - - - - - - - -
        -
      • -

        getTarget

        -
        public static java.lang.String getTarget()
        -
        • -
      - - - -
        -
      • -

        getVersion

        -
        public static java.lang.String getVersion()
        -
        • -
      - - - -
        -
      • -

        startVersionCheck

        -
        public static void startVersionCheck()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html b/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html deleted file mode 100644 index efb8871..0000000 --- a/javadoc/net/minecraftforge/common/IExtendedEntityProperties.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - -IExtendedEntityProperties (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface IExtendedEntityProperties

-
-
-
-
    -
  • -
    -
    -
    public interface IExtendedEntityProperties
    -
    Allows for custom entity data and logic to be hooked to existing entity classes.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voidinit(Entity entity, - World world) -
      Used to initialize the extended properties with the entity that this is attached to, as well - as the world object.
      -
      voidloadNBTData(NBTTagCompound compound) -
      Called when the entity that this class is attached to is loaded.
      -
      voidsaveNBTData(NBTTagCompound compound) -
      Called when the entity that this class is attached to is saved.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        saveNBTData

        -
        void saveNBTData(NBTTagCompound compound)
        -
        Called when the entity that this class is attached to is saved. - Any custom entity data that needs saving should be saved here.
        -
        Parameters:
        compound - The compound to save to.
        -
        • -
      - - - -
        -
      • -

        loadNBTData

        -
        void loadNBTData(NBTTagCompound compound)
        -
        Called when the entity that this class is attached to is loaded. - In order to hook into this, you will need to subscribe to the EntityConstructing event. - Otherwise, you will need to initialize manually.
        -
        Parameters:
        compound - The compound to load from.
        -
        • -
      - - - -
        -
      • -

        init

        -
        void init(Entity entity,
-        World world)
        -
        Used to initialize the extended properties with the entity that this is attached to, as well - as the world object. - Called automatically if you register with the EntityConstructing event. - May be called multiple times if the extended properties is moved over to a new entity. - Such as when a player switches dimension {Minecraft re-creates the player entity}
        -
        Parameters:
        entity - The entity that this extended properties is attached to
        world - The world in which the entity exists
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html b/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html deleted file mode 100644 index cdc7fd7..0000000 --- a/javadoc/net/minecraftforge/common/IMinecartCollisionHandler.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - -IMinecartCollisionHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface IMinecartCollisionHandler

-
-
-
-
    -
  • -
    -
    -
    public interface IMinecartCollisionHandler
    -
    This class defines a replacement for the default minecart collision code. - Only one handler can be registered at a time. It it registered with EntityMinecart.registerCollisionHandler(). - If you use this, make it a configuration option.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        onEntityCollision

        -
        void onEntityCollision(EntityMinecart cart,
-                     Entity other)
        -
        This basically replaces the function of the same name in EnityMinecart. - Code in IMinecartHooks.applyEntityCollisionHook is still run.
        -
        Parameters:
        cart - The cart that called the collision.
        other - The object it collided with.
        -
        • -
      - - - -
        -
      • -

        getCollisionBox

        -
        AxisAlignedBB getCollisionBox(EntityMinecart cart,
-                            Entity other)
        -
        This function replaced the function of the same name in EntityMinecart. - It is used to define whether minecarts collide with specific entities, - for example items.
        -
        Parameters:
        cart - The cart for which the collision box was requested.
        other - The entity requesting the collision box.
        -
        Returns:
        The collision box or null.
        -
        • -
      - - - -
        -
      • -

        getMinecartCollisionBox

        -
        AxisAlignedBB getMinecartCollisionBox(EntityMinecart cart)
        -
        This function is used to define the box used for detecting minecart collisions. - It is generally bigger that the normal collision box.
        -
        Parameters:
        cart - The cart for which the collision box was requested.
        -
        Returns:
        The collision box, cannot be null.
        -
        • -
      - - - -
        -
      • -

        getBoundingBox

        -
        AxisAlignedBB getBoundingBox(EntityMinecart cart)
        -
        This function replaces the function of the same name in EntityMinecart. - It defines whether minecarts are solid to the player.
        -
        Parameters:
        cart - The cart for which the bounding box was requested.
        -
        Returns:
        The bounding box or null.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/IPlantable.html b/javadoc/net/minecraftforge/common/IPlantable.html deleted file mode 100644 index 879c444..0000000 --- a/javadoc/net/minecraftforge/common/IPlantable.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - -IPlantable (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface IPlantable

-
-
-
- -
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/IShearable.html b/javadoc/net/minecraftforge/common/IShearable.html deleted file mode 100644 index 4c316d5..0000000 --- a/javadoc/net/minecraftforge/common/IShearable.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - -IShearable (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface IShearable

-
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      booleanisShearable(ItemStack item, - IBlockAccess world, - int x, - int y, - int z) -
      Checks if the object is currently shearable - Example: Sheep return false when they have no wool
      -
      java.util.ArrayList<ItemStack>onSheared(ItemStack item, - IBlockAccess world, - int x, - int y, - int z, - int fortune) -
      Performs the shear function on this object.
      -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isShearable

        -
        boolean isShearable(ItemStack item,
-                  IBlockAccess world,
-                  int x,
-                  int y,
-                  int z)
        -
        Checks if the object is currently shearable - Example: Sheep return false when they have no wool
        -
        Parameters:
        item - The itemstack that is being used, Possible to be null
        world - The current world
        x - The X Position
        y - The Y Position
        z - The Z Position
        -
        Returns:
        If this is shearable, and onSheared should be called.
        -
        • -
      - - - -
        -
      • -

        onSheared

        -
        java.util.ArrayList<ItemStack> onSheared(ItemStack item,
-                                       IBlockAccess world,
-                                       int x,
-                                       int y,
-                                       int z,
-                                       int fortune)
        -
        Performs the shear function on this object. - This is called for both client, and server. - The object should perform all actions related to being sheared, - except for dropping of the items, and removal of the block. - As those are handled by ItemShears itself. - - Returns a list of items that resulted from the shearing process. - - For entities, they should trust there internal location information - over the values passed into this function.
        -
        Parameters:
        item - The itemstack that is being used, Possible to be null
        world - The current world
        x - The X Position
        y - The Y Position
        z - The Z Position
        fortune - The fortune level of the shears being used
        -
        Returns:
        A ArrayList containing all items from this shearing. Possible to be null.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html b/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html deleted file mode 100644 index 57b3f9a..0000000 --- a/javadoc/net/minecraftforge/common/ISpecialArmor.ArmorProperties.html +++ /dev/null @@ -1,400 +0,0 @@ - - - - - -ISpecialArmor.ArmorProperties (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class ISpecialArmor.ArmorProperties

-
-
- -
- -
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        Priority

        -
        public int Priority
        -
        • -
      - - - -
        -
      • -

        AbsorbMax

        -
        public int AbsorbMax
        -
        • -
      - - - -
        -
      • -

        AbsorbRatio

        -
        public double AbsorbRatio
        -
        • -
      - - - -
        -
      • -

        Slot

        -
        public int Slot
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ISpecialArmor.ArmorProperties

        -
        public ISpecialArmor.ArmorProperties(int priority,
-                             double ratio,
-                             int max)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        ApplyArmor

        -
        public static float ApplyArmor(EntityLivingBase entity,
-               ItemStack[] inventory,
-               DamageSource source,
-               double damage)
        -
        Gathers and applies armor reduction to damage being dealt to a entity.
        -
        Parameters:
        entity - The Entity being damage
        inventory - An array of armor items
        source - The damage source type
        damage - The total damage being done
        -
        Returns:
        The left over damage that has not been absorbed by the armor
        -
        • -
      - - - - - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        -
        • -
      - - - - -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/ISpecialArmor.html b/javadoc/net/minecraftforge/common/ISpecialArmor.html deleted file mode 100644 index dbf967a..0000000 --- a/javadoc/net/minecraftforge/common/ISpecialArmor.html +++ /dev/null @@ -1,296 +0,0 @@ - - - - - -ISpecialArmor (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Interface ISpecialArmor

-
-
-
-
    -
  • -
    -
    -
    public interface ISpecialArmor
    -
    This interface is to be implemented by ItemArmor classes. It will allow to - modify computation of damage and health loss. Computation will be called - before the actual armor computation, which can then be cancelled.
    -
    See Also:
    ItemArmor
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getProperties

        -
        ISpecialArmor.ArmorProperties getProperties(EntityLivingBase player,
-                                          ItemStack armor,
-                                          DamageSource source,
-                                          double damage,
-                                          int slot)
        -
        Retrieves the modifiers to be used when calculating armor damage. - - Armor will higher priority will have damage applied to them before - lower priority ones. If there are multiple pieces of armor with the - same priority, damage will be distributed between them based on there - absorption ratio.
        -
        Parameters:
        player - The entity wearing the armor.
        armor - The ItemStack of the armor item itself.
        source - The source of the damage, which can be used to alter armor - properties based on the type or source of damage.
        damage - The total damage being applied to the entity
        slot - The armor slot the item is in.
        -
        Returns:
        A ArmorProperties instance holding information about how the armor effects damage.
        -
        • -
      - - - -
        -
      • -

        getArmorDisplay

        -
        int getArmorDisplay(EntityPlayer player,
-                  ItemStack armor,
-                  int slot)
        -
        Get the displayed effective armor.
        -
        Parameters:
        player - The player wearing the armor.
        armor - The ItemStack of the armor item itself.
        slot - The armor slot the item is in.
        -
        Returns:
        The number of armor points for display, 2 per shield.
        -
        • -
      - - - -
        -
      • -

        damageArmor

        -
        void damageArmor(EntityLivingBase entity,
-               ItemStack stack,
-               DamageSource source,
-               int damage,
-               int slot)
        -
        Applies damage to the ItemStack. The mod is responsible for reducing the - item durability and stack size. If the stack is depleted it will be cleaned - up automatically.
        -
        Parameters:
        entity - The entity wearing the armor
        stack - The ItemStack of the armor item itself.
        source - The source of the damage, which can be used to alter armor - properties based on the type or source of damage.
        damage - The amount of damage being applied to the armor
        slot - The armor slot the item is in.
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/MinecraftForge.html b/javadoc/net/minecraftforge/common/MinecraftForge.html deleted file mode 100644 index f304d82..0000000 --- a/javadoc/net/minecraftforge/common/MinecraftForge.html +++ /dev/null @@ -1,375 +0,0 @@ - - - - - -MinecraftForge (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common
-

Class MinecraftForge

-
-
- -
-
    -
  • -
    -
    -
    public class MinecraftForge
-extends java.lang.Object
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static EventBusEVENT_BUS -
      The core Forge EventBusses, all events for Forge will be fired on these, - you should use this to register all your listeners.
      -
      static java.lang.StringMC_VERSION 
      static EventBusORE_GEN_BUS 
      static EventBusTERRAIN_GEN_BUS 
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      MinecraftForge() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static voidaddGrassSeed(ItemStack seed, - int weight) -
      Register a new seed to be dropped when breaking tall grass.
      -
      static java.lang.StringgetBrandingVersion() 
      static voidinitialize() -
      Method invoked by FML before any other mods are loaded.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Field Detail

      - - - -
        -
      • -

        EVENT_BUS

        -
        public static final EventBus EVENT_BUS
        -
        The core Forge EventBusses, all events for Forge will be fired on these, - you should use this to register all your listeners. - This replaces every register*Handler() function in the old version of Forge. - TERRAIN_GEN_BUS for terrain gen events - ORE_GEN_BUS for ore gen events - EVENT_BUS for everything else
        -
        • -
      - - - -
        -
      • -

        TERRAIN_GEN_BUS

        -
        public static final EventBus TERRAIN_GEN_BUS
        -
        • -
      - - - -
        -
      • -

        ORE_GEN_BUS

        -
        public static final EventBus ORE_GEN_BUS
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        MinecraftForge

        -
        public MinecraftForge()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addGrassSeed

        -
        public static void addGrassSeed(ItemStack seed,
-                int weight)
        -
        Register a new seed to be dropped when breaking tall grass.
        -
        Parameters:
        seed - The item to drop as a seed.
        weight - The relative probability of the seeds, - where wheat seeds are 10.
        -
        • -
      - - - -
        -
      • -

        initialize

        -
        public static void initialize()
        -
        Method invoked by FML before any other mods are loaded.
        -
        • -
      - - - -
        -
      • -

        getBrandingVersion

        -
        public static java.lang.String getBrandingVersion()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/UsernameCache.html b/javadoc/net/minecraftforge/common/UsernameCache.html deleted file mode 100644 index 055d13a..0000000 --- a/javadoc/net/minecraftforge/common/UsernameCache.html +++ /dev/null @@ -1,339 +0,0 @@ - - - - - -UsernameCache (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common
-

Class UsernameCache

-
-
- -
-
    -
  • -
    -
    -
    public final class UsernameCache
-extends java.lang.Object
    -
    Caches player's last known usernames -

    - Modders should use getLastKnownUsername(UUID) to determine a players - last known username.
    - For convenience, getMap() is provided to get an immutable copy of - the caches underlying map.

    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static booleancontainsUUID(java.util.UUID uuid) -
      Check if the cache contains the given player's username
      -
      static java.lang.StringgetLastKnownUsername(java.util.UUID uuid) -
      Get the player's last known username
      -
      static java.util.Map<java.util.UUID,java.lang.String>getMap() -
      Get an immutable copy of the cache's underlying map
      -
      protected static voidload() -
      Load the cache from file
      -
      protected static booleanremoveUsername(java.util.UUID uuid) -
      Remove a player's username from the cache
      -
      protected static voidsave() -
      Save the cache to file
      -
      protected static voidsetUsername(java.util.UUID uuid, - java.lang.String username) -
      Set a player's current username
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Method Detail

      - - - -
        -
      • -

        setUsername

        -
        protected static void setUsername(java.util.UUID uuid,
-               java.lang.String username)
        -
        Set a player's current username
        -
        Parameters:
        uuid - the player's UUID
        username - the player's username
        -
        • -
      - - - -
        -
      • -

        removeUsername

        -
        protected static boolean removeUsername(java.util.UUID uuid)
        -
        Remove a player's username from the cache
        -
        Parameters:
        uuid - the player's UUID
        -
        Returns:
        if the cache contained the user
        -
        • -
      - - - -
        -
      • -

        getLastKnownUsername

        -
        @Nullable
-public static java.lang.String getLastKnownUsername(java.util.UUID uuid)
        -
        Get the player's last known username -

        - May be null

        -
        Parameters:
        uuid - the player's UUID
        -
        Returns:
        the player's last known username, or null if the - cache doesn't have a record of the last username
        -
        • -
      - - - -
        -
      • -

        containsUUID

        -
        public static boolean containsUUID(java.util.UUID uuid)
        -
        Check if the cache contains the given player's username
        -
        Parameters:
        uuid - the player's UUID
        -
        Returns:
        if the cache contains a username for the given player
        -
        • -
      - - - -
        -
      • -

        getMap

        -
        public static java.util.Map<java.util.UUID,java.lang.String> getMap()
        -
        Get an immutable copy of the cache's underlying map
        -
        Returns:
        the map
        -
        • -
      - - - -
        -
      • -

        save

        -
        protected static void save()
        -
        Save the cache to file
        -
        • -
      - - - -
        -
      • -

        load

        -
        protected static void load()
        -
        Load the cache from file
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html b/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html deleted file mode 100644 index 3036b89..0000000 --- a/javadoc/net/minecraftforge/common/WorldSpecificSaveHandler.html +++ /dev/null @@ -1,422 +0,0 @@ - - - - - -WorldSpecificSaveHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common
-

Class WorldSpecificSaveHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    ISaveHandler
    -
    -
    -
    -
    public class WorldSpecificSaveHandler
-extends java.lang.Object
-implements ISaveHandler
    -
    • -
-
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html b/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html deleted file mode 100644 index 079f2fb..0000000 --- a/javadoc/net/minecraftforge/common/chunkio/ChunkIOExecutor.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - -ChunkIOExecutor (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.chunkio
-

Class ChunkIOExecutor

-
-
- -
-
    -
  • -
    -
    -
    public class ChunkIOExecutor
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ChunkIOExecutor

        -
        public ChunkIOExecutor()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - - - - - -
        -
      • -

        dropQueuedChunkLoad

        -
        public static void dropQueuedChunkLoad(World world,
-                       int x,
-                       int z,
-                       java.lang.Runnable runnable)
        -
        • -
      - - - -
        -
      • -

        adjustPoolSize

        -
        public static void adjustPoolSize(int players)
        -
        • -
      - - - -
        -
      • -

        tick

        -
        public static void tick()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/chunkio/package-frame.html b/javadoc/net/minecraftforge/common/chunkio/package-frame.html deleted file mode 100644 index a6b0808..0000000 --- a/javadoc/net/minecraftforge/common/chunkio/package-frame.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - -net.minecraftforge.common.chunkio (Forge API) - - - - -

net.minecraftforge.common.chunkio

-
-

Classes

- -
- - diff --git a/javadoc/net/minecraftforge/common/chunkio/package-summary.html b/javadoc/net/minecraftforge/common/chunkio/package-summary.html deleted file mode 100644 index f969902..0000000 --- a/javadoc/net/minecraftforge/common/chunkio/package-summary.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - -net.minecraftforge.common.chunkio (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Package net.minecraftforge.common.chunkio

-
-
- -
- -
- - - - - -
-
- - - -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/chunkio/package-tree.html b/javadoc/net/minecraftforge/common/chunkio/package-tree.html deleted file mode 100644 index 81d78b4..0000000 --- a/javadoc/net/minecraftforge/common/chunkio/package-tree.html +++ /dev/null @@ -1,126 +0,0 @@ - - - - - -net.minecraftforge.common.chunkio Class Hierarchy (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package net.minecraftforge.common.chunkio

-Package Hierarchies: - -
-
-

Class Hierarchy

- -
- -
- - - - - -
-
- - - -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/config/ConfigCategory.html b/javadoc/net/minecraftforge/common/config/ConfigCategory.html deleted file mode 100644 index f9c0e7d..0000000 --- a/javadoc/net/minecraftforge/common/config/ConfigCategory.html +++ /dev/null @@ -1,929 +0,0 @@ - - - - - -ConfigCategory (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.config
-

Class ConfigCategory

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.util.Map<java.lang.String,Property>
    -
    -
    -
    -
    public class ConfigCategory
-extends java.lang.Object
-implements java.util.Map<java.lang.String,Property>
    -
    • -
-
-
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ConfigCategory

        -
        public ConfigCategory(java.lang.String name)
        -
        • -
      - - - -
        -
      • -

        ConfigCategory

        -
        public ConfigCategory(java.lang.String name,
-              ConfigCategory parent)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Specified by:
        -
        equals in interface java.util.Map<java.lang.String,Property>
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        getName

        -
        public java.lang.String getName()
        -
        • -
      - - - -
        -
      • -

        getQualifiedName

        -
        public java.lang.String getQualifiedName()
        -
        • -
      - - - -
        -
      • -

        getQualifiedName

        -
        public static java.lang.String getQualifiedName(java.lang.String name,
-                                ConfigCategory parent)
        -
        • -
      - - - - - - - -
        -
      • -

        isChild

        -
        public boolean isChild()
        -
        • -
      - - - -
        -
      • -

        getValues

        -
        public java.util.Map<java.lang.String,Property> getValues()
        -
        • -
      - - - -
        -
      • -

        getOrderedValues

        -
        public java.util.List<Property> getOrderedValues()
        -
        • -
      - - - - - - - - - - - -
        -
      • -

        setLanguageKey

        -
        public ConfigCategory setLanguageKey(java.lang.String languagekey)
        -
        • -
      - - - -
        -
      • -

        getLanguagekey

        -
        public java.lang.String getLanguagekey()
        -
        • -
      - - - -
        -
      • -

        setComment

        -
        public void setComment(java.lang.String comment)
        -
        • -
      - - - -
        -
      • -

        getComment

        -
        public java.lang.String getComment()
        -
        • -
      - - - -
        -
      • -

        setRequiresWorldRestart

        -
        public ConfigCategory setRequiresWorldRestart(boolean requiresWorldRestart)
        -
        Sets the flag for whether or not this category can be edited while a world is running. Care should be taken to ensure - that only properties that are truly dynamic can be changed from the in-game options menu. Only set this flag to - true if all child properties/categories are unable to be modified while a world is running.
        -
        • -
      - - - -
        -
      • -

        requiresWorldRestart

        -
        public boolean requiresWorldRestart()
        -
        Returns whether or not this category is able to be edited while a world is running using the in-game Mod Options screen - as well as the Mods list screen, or only from the Mods list screen.
        -
        • -
      - - - -
        -
      • -

        setShowInGui

        -
        public ConfigCategory setShowInGui(boolean showInGui)
        -
        Sets whether or not this ConfigCategory should be allowed to show on config GUIs. - Defaults to true.
        -
        • -
      - - - -
        -
      • -

        showInGui

        -
        public boolean showInGui()
        -
        Gets whether or not this ConfigCategory should be allowed to show on config GUIs. - Defaults to true unless set to false.
        -
        • -
      - - - -
        -
      • -

        setRequiresMcRestart

        -
        public ConfigCategory setRequiresMcRestart(boolean requiresMcRestart)
        -
        Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. - Defaults to false. Only set this flag to true if ALL child properties/categories require - Minecraft to be restarted when changed. Setting this flag will also prevent modification - of the child properties/categories while a world is running.
        -
        • -
      - - - -
        -
      • -

        requiresMcRestart

        -
        public boolean requiresMcRestart()
        -
        Gets whether or not this ConfigCategory requires Minecraft to be restarted when changed. - Defaults to false unless set to true.
        -
        • -
      - - - -
        -
      • -

        setPropertyOrder

        -
        public ConfigCategory setPropertyOrder(java.util.List<java.lang.String> propertyOrder)
        -
        • -
      - - - -
        -
      • -

        getPropertyOrder

        -
        public java.util.List<java.lang.String> getPropertyOrder()
        -
        • -
      - - - -
        -
      • -

        containsKey

        -
        public boolean containsKey(java.lang.String key)
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String key)
        -
        • -
      - - - -
        -
      • -

        write

        -
        public void write(java.io.BufferedWriter out,
-         int indent)
-           throws java.io.IOException
        -
        Throws:
        -
        java.io.IOException
        -
        • -
      - - - -
        -
      • -

        hasChanged

        -
        public boolean hasChanged()
        -
        • -
      - - - -
        -
      • -

        size

        -
        public int size()
        -
        -
        Specified by:
        -
        size in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        isEmpty

        -
        public boolean isEmpty()
        -
        -
        Specified by:
        -
        isEmpty in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        containsKey

        -
        public boolean containsKey(java.lang.Object key)
        -
        -
        Specified by:
        -
        containsKey in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        containsValue

        -
        public boolean containsValue(java.lang.Object value)
        -
        -
        Specified by:
        -
        containsValue in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.Object key)
        -
        -
        Specified by:
        -
        get in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        put

        -
        public Property put(java.lang.String key,
-           Property value)
        -
        -
        Specified by:
        -
        put in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        remove

        -
        public Property remove(java.lang.Object key)
        -
        -
        Specified by:
        -
        remove in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        putAll

        -
        public void putAll(java.util.Map<? extends java.lang.String,? extends Property> m)
        -
        -
        Specified by:
        -
        putAll in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        clear

        -
        public void clear()
        -
        -
        Specified by:
        -
        clear in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        keySet

        -
        public java.util.Set<java.lang.String> keySet()
        -
        -
        Specified by:
        -
        keySet in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        values

        -
        public java.util.Collection<Property> values()
        -
        -
        Specified by:
        -
        values in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        entrySet

        -
        public java.util.Set<java.util.Map.Entry<java.lang.String,Property>> entrySet()
        -
        -
        Specified by:
        -
        entrySet in interface java.util.Map<java.lang.String,Property>
        -
        -
        • -
      - - - -
        -
      • -

        getChildren

        -
        public java.util.Set<ConfigCategory> getChildren()
        -
        • -
      - - - - -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/config/ConfigElement.html b/javadoc/net/minecraftforge/common/config/ConfigElement.html deleted file mode 100644 index 886c8a6..0000000 --- a/javadoc/net/minecraftforge/common/config/ConfigElement.html +++ /dev/null @@ -1,919 +0,0 @@ - - - - - -ConfigElement (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.config
-

Class ConfigElement<T>

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

      Property Summary

      - - - - - - - - - - -
      Properties 
      TypeProperty and Description
      booleanis -
      [Property, Category] Is this object a property object?
      -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectget() -
      [Property] Gets this property value.
      -
      java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry>getArrayEntryClass() -
      This method returns a class that implements IArrayEntry.
      -
      java.util.List<IConfigElement>getChildElements() -
      [Category] Gets this category's child categories/properties.
      -
      java.lang.StringgetComment() -
      [Property, Category] Gets the comment for this object.
      -
      java.lang.Class<? extends GuiConfigEntries.IConfigEntry>getConfigEntryClass() -
      This method returns a class that implements IConfigEntry or null.
      -
      java.lang.ObjectgetDefault() -
      [Property] Gets this property's default value.
      -
      java.lang.Object[]getDefaults() -
      [Property] Gets this property's default values.
      -
      java.lang.StringgetLanguageKey() -
      [Property, Category] Gets a language key for localization of config GUI entry names.
      -
      java.lang.Object[]getList() -
      [Property] Gets this property value as a list.
      -
      intgetMaxListLength() -
      [Property] Gets the max length of this list property, or -1 if the length is unlimited.
      -
      TgetMaxValue() -
      [Property] Gets this property's maximum value.
      -
      TgetMinValue() -
      [Property] Gets this property's minimum value.
      -
      java.lang.StringgetName() -
      [Property, Category] Gets the name of this object.
      -
      java.lang.StringgetQualifiedName() -
      [Category] Gets the qualified name of this object.
      -
      ConfigGuiTypegetType() -
      [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a - category object.
      -
      static ConfigGuiTypegetType(Property prop) 
      static ConfigElement<?>getTypedElement(Property prop) 
      java.util.regex.PatterngetValidationPattern() -
      [Property] Gets a Pattern object used in String property input validation.
      -
      java.lang.String[]getValidValues() -
      [Property] Gets a String array of valid values for this property.
      -
      booleanisDefault() -
      [Property] Is this property value equal to the default value?
      -
      booleanisList() -
      [Property] Is this property object a list?
      -
      booleanisListLengthFixed() -
      [Property] Does this list property have to remain a fixed length?
      -
      booleanisProperty() -
      [Property, Category] Is this object a property object?
      -
      ConfigElement<T>listCategoriesFirst(boolean categoriesFirst) 
      booleanrequiresMcRestart() -
      [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
      -
      booleanrequiresWorldRestart() -
      [Property, Category] Whether or not this element is safe to modify while a world is running.
      -
      voidset(T value) -
      [Property] Sets this property's value.
      -
      voidset(T[] aVal) -
      [Property] Sets this property's value to the specified array.
      -
      voidsetToDefault() -
      [Property] Sets this property's value to the default value.
      -
      booleanshowInGui() -
      [Property, Category] Whether or not this element should be allowed to show on config GUIs.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - - - - - -
        -
      • -

        ConfigElement

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

      Method Detail

      - - - -
        -
      • -

        listCategoriesFirst

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

        getName

        -
        public java.lang.String getName()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Gets the name of this object.
        -
        -
        Specified by:
        -
        getName in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        isProperty

        -
        public boolean isProperty()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Is this object a property object?
        -
        -
        Specified by:
        -
        isProperty in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getConfigEntryClass

        -
        public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
        -
        Description copied from interface: IConfigElement
        -
        This method returns a class that implements IConfigEntry or null. This class MUST - provide a constructor with the following parameter types: GuiConfig, GuiConfigEntries, IConfigElement
        -
        -
        Specified by:
        -
        getConfigEntryClass in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getArrayEntryClass

        -
        public java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
        -
        Description copied from interface: IConfigElement
        -
        This method returns a class that implements IArrayEntry. This class MUST provide a constructor with the - following parameter types: GuiEditArray, GuiEditArrayEntries, IConfigElement, Object
        -
        -
        Specified by:
        -
        getArrayEntryClass in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getQualifiedName

        -
        public java.lang.String getQualifiedName()
        -
        Description copied from interface: IConfigElement
        -
        [Category] Gets the qualified name of this object. This is typically only used for category objects.
        -
        -
        Specified by:
        -
        getQualifiedName in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getType

        -
        public ConfigGuiType getType()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Gets the ConfigGuiType value corresponding to the type of this property object, or CONFIG_CATEGORY if this is a - category object.
        -
        -
        Specified by:
        -
        getType in interface IConfigElement<T>
        -
        -
        • -
      - - - - - - - -
        -
      • -

        isList

        -
        public boolean isList()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Is this property object a list?
        -
        -
        Specified by:
        -
        isList in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        isListLengthFixed

        -
        public boolean isListLengthFixed()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Does this list property have to remain a fixed length?
        -
        -
        Specified by:
        -
        isListLengthFixed in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getMaxListLength

        -
        public int getMaxListLength()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets the max length of this list property, or -1 if the length is unlimited.
        -
        -
        Specified by:
        -
        getMaxListLength in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getComment

        -
        public java.lang.String getComment()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Gets the comment for this object. Used for the tooltip if getLanguageKey() + ".tooltip" is not defined in the - .lang file.
        -
        -
        Specified by:
        -
        getComment in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        isDefault

        -
        public boolean isDefault()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Is this property value equal to the default value?
        -
        -
        Specified by:
        -
        isDefault in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        setToDefault

        -
        public void setToDefault()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Sets this property's value to the default value.
        -
        -
        Specified by:
        -
        setToDefault in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        requiresWorldRestart

        -
        public boolean requiresWorldRestart()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Whether or not this element is safe to modify while a world is running. For Categories return false if ANY properties - in the category are modifiable while a world is running, true if all are not.
        -
        -
        Specified by:
        -
        requiresWorldRestart in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        showInGui

        -
        public boolean showInGui()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Whether or not this element should be allowed to show on config GUIs.
        -
        -
        Specified by:
        -
        showInGui in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        requiresMcRestart

        -
        public boolean requiresMcRestart()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Whether or not this element requires Minecraft to be restarted when changed.
        -
        -
        Specified by:
        -
        requiresMcRestart in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getValidValues

        -
        public java.lang.String[] getValidValues()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets a String array of valid values for this property. This is generally used for String properties to allow the user to - select a value from a list of valid values.
        -
        -
        Specified by:
        -
        getValidValues in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getLanguageKey

        -
        public java.lang.String getLanguageKey()
        -
        Description copied from interface: IConfigElement
        -
        [Property, Category] Gets a language key for localization of config GUI entry names. If the same key is specified with .tooltip - appended to the end, that key will return a localized tooltip when the mouse hovers over the property label/category button.
        -
        -
        Specified by:
        -
        getLanguageKey in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getDefault

        -
        public java.lang.Object getDefault()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets this property's default value. If this element is an array, this method should return a String - representation of that array using Arrays.toString()
        -
        -
        Specified by:
        -
        getDefault in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getDefaults

        -
        public java.lang.Object[] getDefaults()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets this property's default values.
        -
        -
        Specified by:
        -
        getDefaults in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getValidationPattern

        -
        public java.util.regex.Pattern getValidationPattern()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets a Pattern object used in String property input validation.
        -
        -
        Specified by:
        -
        getValidationPattern in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        get

        -
        public java.lang.Object get()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets this property value.
        -
        -
        Specified by:
        -
        get in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getList

        -
        public java.lang.Object[] getList()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets this property value as a list. Generally you should be sure of whether the property is a list before calling this.
        -
        -
        Specified by:
        -
        getList in interface IConfigElement<T>
        -
        -
        • -
      - - - - - -
        -
      • -

        set

        -
        public void set(T value)
        -
        Description copied from interface: IConfigElement
        -
        [Property] Sets this property's value.
        -
        -
        Specified by:
        -
        set in interface IConfigElement<T>
        -
        -
        • -
      - - - - - -
        -
      • -

        set

        -
        public void set(T[] aVal)
        -
        Description copied from interface: IConfigElement
        -
        [Property] Sets this property's value to the specified array.
        -
        -
        Specified by:
        -
        set in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getMinValue

        -
        public T getMinValue()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets this property's minimum value.
        -
        -
        Specified by:
        -
        getMinValue in interface IConfigElement<T>
        -
        -
        • -
      - - - -
        -
      • -

        getMaxValue

        -
        public T getMaxValue()
        -
        Description copied from interface: IConfigElement
        -
        [Property] Gets this property's maximum value.
        -
        -
        Specified by:
        -
        getMaxValue in interface IConfigElement<T>
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html b/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html deleted file mode 100644 index d1e0522..0000000 --- a/javadoc/net/minecraftforge/common/config/Configuration.UnicodeInputStreamReader.html +++ /dev/null @@ -1,340 +0,0 @@ - - - - - -Configuration.UnicodeInputStreamReader (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.config
-

Class Configuration.UnicodeInputStreamReader

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

      Field Summary

      -
        -
      • - - -

        Fields inherited from class java.io.Reader

        -lock
        • -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voidclose() 
      java.lang.StringgetEncoding() 
      intread(char[] cbuf, - int off, - int len) 
      -
        -
      • - - -

        Methods inherited from class java.io.Reader

        -mark, markSupported, read, read, read, ready, reset, skip
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        Configuration.UnicodeInputStreamReader

        -
        public Configuration.UnicodeInputStreamReader(java.io.InputStream source,
-                                      java.lang.String encoding)
-                                       throws java.io.IOException
        -
        Throws:
        -
        java.io.IOException
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getEncoding

        -
        public java.lang.String getEncoding()
        -
        • -
      - - - -
        -
      • -

        read

        -
        public int read(char[] cbuf,
-       int off,
-       int len)
-         throws java.io.IOException
        -
        -
        Specified by:
        -
        read in class java.io.Reader
        -
        Throws:
        -
        java.io.IOException
        -
        • -
      - - - -
        -
      • -

        close

        -
        public void close()
-           throws java.io.IOException
        -
        -
        Specified by:
        -
        close in interface java.io.Closeable
        -
        Specified by:
        -
        close in interface java.lang.AutoCloseable
        -
        Specified by:
        -
        close in class java.io.Reader
        -
        Throws:
        -
        java.io.IOException
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/config/Configuration.html b/javadoc/net/minecraftforge/common/config/Configuration.html deleted file mode 100644 index 0b955f3..0000000 --- a/javadoc/net/minecraftforge/common/config/Configuration.html +++ /dev/null @@ -1,1988 +0,0 @@ - - - - - -Configuration (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.config
-

Class Configuration

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

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voidaddCustomCategoryComment(java.lang.String category, - java.lang.String comment) 
      voidcopyCategoryProps(Configuration fromConfig, - java.lang.String[] ctgys) -
      Copies property objects from another Configuration object to this one using the list of category names.
      -
      static voidenableGlobalConfig() 
      Propertyget(java.lang.String category, - java.lang.String key, - boolean defaultValue) -
      Gets a boolean Property object without a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - boolean[] defaultValues) -
      Gets a boolean array Property without a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - boolean[] defaultValues, - java.lang.String comment) -
      Gets a boolean array Property with a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - boolean[] defaultValues, - java.lang.String comment, - boolean isListLengthFixed, - int maxListLength) -
      Gets a boolean array Property with all settings defined.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - boolean defaultValue, - java.lang.String comment) -
      Gets a boolean Property object with a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double defaultValue) -
      Gets a double Property object without a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double[] defaultValues) -
      Gets a double array Property object without a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double[] defaultValues, - java.lang.String comment) -
      Gets a double array Property object without a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double[] defaultValues, - java.lang.String comment, - double minValue, - double maxValue) -
      Gets a double array Property object with the defined comment, minimum and maximum bounds.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double[] defaultValues, - java.lang.String comment, - double minValue, - double maxValue, - boolean isListLengthFixed, - int maxListLength) -
      Gets a double array Property object with all settings defined.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double defaultValue, - java.lang.String comment) -
      Gets a double Property object with a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - double defaultValue, - java.lang.String comment, - double minValue, - double maxValue) -
      Gets a double Property object with the defined comment, minimum and maximum bounds
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int defaultValue) -
      Gets an integer Property object without a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int[] defaultValues) -
      Gets an integer array Property object without a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int[] defaultValues, - java.lang.String comment) -
      Gets an integer array Property object with a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int[] defaultValues, - java.lang.String comment, - int minValue, - int maxValue) -
      Gets an integer array Property object with the defined comment, minimum and maximum bounds.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int[] defaultValues, - java.lang.String comment, - int minValue, - int maxValue, - boolean isListLengthFixed, - int maxListLength) -
      Gets an integer array Property object with all settings defined.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int defaultValue, - java.lang.String comment) -
      Gets an integer Property object with a comment using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - int defaultValue, - java.lang.String comment, - int minValue, - int maxValue) -
      Gets an integer Property object with the defined comment, minimum and maximum bounds.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String defaultValue) -
      Gets a string Property without a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String[] defaultValues) -
      Gets a string array Property without a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String[] defaultValues, - java.lang.String comment) -
      Gets a string array Property with a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String[] defaultValues, - java.lang.String comment, - boolean isListLengthFixed, - int maxListLength, - java.util.regex.Pattern validationPattern) -
      Gets a string array Property with a comment with all settings defined.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String[] defaultValues, - java.lang.String comment, - java.util.regex.Pattern validationPattern) -
      Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String[] defaultValues, - java.lang.String comment, - Property.Type type) -
      Gets a list (array) Property object of the specified type using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String defaultValue, - java.lang.String comment) -
      Gets a string Property with a comment using the default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String defaultValue, - java.lang.String comment, - java.util.regex.Pattern validationPattern) -
      Gets a string Property with a comment using the defined validationPattern and otherwise default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String defaultValue, - java.lang.String comment, - Property.Type type) -
      Gets a Property object of the specified type using default settings.
      -
      Propertyget(java.lang.String category, - java.lang.String key, - java.lang.String defaultValue, - java.lang.String comment, - java.lang.String[] validValues) -
      Gets a string Property with a comment using the defined validValues array and otherwise default settings.
      -
      booleangetBoolean(java.lang.String name, - java.lang.String category, - boolean defaultValue, - java.lang.String comment) -
      Creates a boolean property.
      -
      booleangetBoolean(java.lang.String name, - java.lang.String category, - boolean defaultValue, - java.lang.String comment, - java.lang.String langKey) -
      Creates a boolean property.
      -
      ConfigCategorygetCategory(java.lang.String category) 
      java.util.Set<java.lang.String>getCategoryNames() 
      java.io.FilegetConfigFile() 
      java.lang.StringgetDefinedConfigVersion() 
      floatgetFloat(java.lang.String name, - java.lang.String category, - float defaultValue, - float minValue, - float maxValue, - java.lang.String comment) -
      Creates a float property.
      -
      floatgetFloat(java.lang.String name, - java.lang.String category, - float defaultValue, - float minValue, - float maxValue, - java.lang.String comment, - java.lang.String langKey) -
      Creates a float property.
      -
      intgetInt(java.lang.String name, - java.lang.String category, - int defaultValue, - int minValue, - int maxValue, - java.lang.String comment) -
      Creates a integer property.
      -
      intgetInt(java.lang.String name, - java.lang.String category, - int defaultValue, - int minValue, - int maxValue, - java.lang.String comment, - java.lang.String langKey) -
      Creates a integer property.
      -
      java.lang.StringgetLoadedConfigVersion() 
      java.lang.StringgetString(java.lang.String name, - java.lang.String category, - java.lang.String defaultValue, - java.lang.String comment) -
      Creates a string property.
      -
      java.lang.StringgetString(java.lang.String name, - java.lang.String category, - java.lang.String defaultValue, - java.lang.String comment, - java.util.regex.Pattern pattern) -
      Creates a string property.
      -
      java.lang.StringgetString(java.lang.String name, - java.lang.String category, - java.lang.String defaultValue, - java.lang.String comment, - java.lang.String langKey) -
      Creates a string property.
      -
      java.lang.StringgetString(java.lang.String name, - java.lang.String category, - java.lang.String defaultValue, - java.lang.String comment, - java.lang.String[] validValues) -
      Creates a string property.
      -
      java.lang.StringgetString(java.lang.String name, - java.lang.String category, - java.lang.String defaultValue, - java.lang.String comment, - java.lang.String[] validValues, - java.lang.String langKey) -
      Creates a string property.
      -
      java.lang.StringgetString(java.lang.String name, - java.lang.String category, - java.lang.String defaultValue, - java.lang.String comment, - java.lang.String langKey, - java.util.regex.Pattern pattern) -
      Creates a string property.
      -
      java.lang.String[]getStringList(java.lang.String name, - java.lang.String category, - java.lang.String[] defaultValues, - java.lang.String comment) -
      Creates a string list property.
      -
      java.lang.String[]getStringList(java.lang.String name, - java.lang.String category, - java.lang.String[] defaultValue, - java.lang.String comment, - java.lang.String[] validValues) -
      Creates a string list property.
      -
      java.lang.String[]getStringList(java.lang.String name, - java.lang.String category, - java.lang.String[] defaultValue, - java.lang.String comment, - java.lang.String[] validValues, - java.lang.String langKey) -
      Creates a string list property.
      -
      booleanhasCategory(java.lang.String category) 
      booleanhasChanged() 
      booleanhasKey(java.lang.String category, - java.lang.String key) 
      voidload() 
      booleanmoveProperty(java.lang.String oldCategory, - java.lang.String propName, - java.lang.String newCategory) -
      Moves a property from one category to another.
      -
      voidremoveCategory(ConfigCategory category) 
      booleanrenameProperty(java.lang.String category, - java.lang.String oldPropName, - java.lang.String newPropName) -
      Renames a property in a given category.
      -
      voidsave() 
      ConfigurationsetCategoryComment(java.lang.String category, - java.lang.String comment) -
      Adds a comment to the specified ConfigCategory object
      -
      ConfigurationsetCategoryConfigEntryClass(java.lang.String category, - java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz) -
      Sets the custom IConfigEntry class that should be used in place of the standard entry class (which is just a button that - navigates into the category).
      -
      ConfigurationsetCategoryLanguageKey(java.lang.String category, - java.lang.String langKey) -
      Adds a language key to the specified ConfigCategory object
      -
      ConfigurationsetCategoryPropertyOrder(java.lang.String category, - java.util.List<java.lang.String> propOrder) -
      Sets the order that direct child properties of this config category will be written to the config file and will be displayed in - config GUIs.
      -
      ConfigurationsetCategoryRequiresMcRestart(java.lang.String category, - boolean requiresMcRestart) -
      Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed.
      -
      ConfigurationsetCategoryRequiresWorldRestart(java.lang.String category, - boolean requiresWorldRestart) -
      Sets the flag for whether or not this category can be edited while a world is running.
      -
      java.lang.StringtoString() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        CATEGORY_GENERAL

        -
        public static final java.lang.String CATEGORY_GENERAL
        -
        See Also:
        Constant Field Values
        -
        • -
      - - - -
        -
      • -

        ALLOWED_CHARS

        -
        public static final java.lang.String ALLOWED_CHARS
        -
        See Also:
        Constant Field Values
        -
        • -
      - - - -
        -
      • -

        DEFAULT_ENCODING

        -
        public static final java.lang.String DEFAULT_ENCODING
        -
        See Also:
        Constant Field Values
        -
        • -
      - - - -
        -
      • -

        CATEGORY_SPLITTER

        -
        public static final java.lang.String CATEGORY_SPLITTER
        -
        See Also:
        Constant Field Values
        -
        • -
      - - - -
        -
      • -

        NEW_LINE

        -
        public static final java.lang.String NEW_LINE
        -
        • -
      - - - -
        -
      • -

        COMMENT_SEPARATOR

        -
        public static final java.lang.String COMMENT_SEPARATOR
        -
        See Also:
        Constant Field Values
        -
        • -
      - - - -
        -
      • -

        allowedProperties

        -
        public static final com.google.common.base.CharMatcher allowedProperties
        -
        • -
      - - - -
        -
      • -

        defaultEncoding

        -
        public java.lang.String defaultEncoding
        -
        • -
      - - - -
        -
      • -

        isChild

        -
        public boolean isChild
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Configuration

        -
        public Configuration()
        -
        • -
      - - - -
        -
      • -

        Configuration

        -
        public Configuration(java.io.File file)
        -
        Create a configuration file for the file given in parameter.
        -
        • -
      - - - -
        -
      • -

        Configuration

        -
        public Configuration(java.io.File file,
-             java.lang.String configVersion)
        -
        Create a configuration file for the file given in parameter with the provided config version number.
        -
        • -
      - - - -
        -
      • -

        Configuration

        -
        public Configuration(java.io.File file,
-             java.lang.String configVersion,
-             boolean caseSensitiveCustomCategories)
        -
        • -
      - - - -
        -
      • -

        Configuration

        -
        public Configuration(java.io.File file,
-             boolean caseSensitiveCustomCategories)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        toString

        -
        public java.lang.String toString()
        -
        -
        Overrides:
        -
        toString in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        getDefinedConfigVersion

        -
        public java.lang.String getDefinedConfigVersion()
        -
        • -
      - - - -
        -
      • -

        getLoadedConfigVersion

        -
        public java.lang.String getLoadedConfigVersion()
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           boolean defaultValue)
        -
        Gets a boolean Property object without a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        -
        Returns:
        a boolean Property object without a comment
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           boolean defaultValue,
-           java.lang.String comment)
        -
        Gets a boolean Property object with a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        -
        Returns:
        a boolean Property object without a comment
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           boolean[] defaultValues)
        -
        Gets a boolean array Property without a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        -
        Returns:
        a boolean array Property without a comment using these defaults: isListLengthFixed = false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           boolean[] defaultValues,
-           java.lang.String comment)
        -
        Gets a boolean array Property with a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        -
        Returns:
        a boolean array Property with a comment using these defaults: isListLengthFixed = false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           boolean[] defaultValues,
-           java.lang.String comment,
-           boolean isListLengthFixed,
-           int maxListLength)
        -
        Gets a boolean array Property with all settings defined.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array - length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        -
        Returns:
        a boolean array Property with all settings defined
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int defaultValue)
        -
        Gets an integer Property object without a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        -
        Returns:
        an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int defaultValue,
-           java.lang.String comment)
        -
        Gets an integer Property object with a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        -
        Returns:
        an integer Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int defaultValue,
-           java.lang.String comment,
-           int minValue,
-           int maxValue)
        -
        Gets an integer Property object with the defined comment, minimum and maximum bounds.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        -
        Returns:
        an integer Property object with the defined comment, minimum and maximum bounds
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int[] defaultValues)
        -
        Gets an integer array Property object without a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        -
        Returns:
        an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, - maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int[] defaultValues,
-           java.lang.String comment)
        -
        Gets an integer array Property object with a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        -
        Returns:
        an integer array Property object with default bounds of Integer.MIN_VALUE and Integer.MAX_VALUE, isListLengthFixed = false, - maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int[] defaultValues,
-           java.lang.String comment,
-           int minValue,
-           int maxValue)
        -
        Gets an integer array Property object with the defined comment, minimum and maximum bounds.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        -
        Returns:
        an integer array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed - = false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           int[] defaultValues,
-           java.lang.String comment,
-           int minValue,
-           int maxValue,
-           boolean isListLengthFixed,
-           int maxListLength)
        -
        Gets an integer array Property object with all settings defined.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array - length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        -
        Returns:
        an integer array Property object with all settings defined
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double defaultValue)
        -
        Gets a double Property object without a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        -
        Returns:
        a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double defaultValue,
-           java.lang.String comment)
        -
        Gets a double Property object with a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        -
        Returns:
        a double Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double defaultValue,
-           java.lang.String comment,
-           double minValue,
-           double maxValue)
        -
        Gets a double Property object with the defined comment, minimum and maximum bounds
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        -
        Returns:
        a double Property object with the defined comment, minimum and maximum bounds
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double[] defaultValues)
        -
        Gets a double array Property object without a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        -
        Returns:
        a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, - maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double[] defaultValues,
-           java.lang.String comment)
        -
        Gets a double array Property object without a comment using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        -
        Returns:
        a double array Property object with default bounds of Double.MIN_VALUE and Double.MAX_VALUE, isListLengthFixed = false, - maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double[] defaultValues,
-           java.lang.String comment,
-           double minValue,
-           double maxValue)
        -
        Gets a double array Property object with the defined comment, minimum and maximum bounds.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        -
        Returns:
        a double array Property object with the defined comment, minimum and maximum bounds, isListLengthFixed = - false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           double[] defaultValues,
-           java.lang.String comment,
-           double minValue,
-           double maxValue,
-           boolean isListLengthFixed,
-           int maxListLength)
        -
        Gets a double array Property object with all settings defined.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        minValue - minimum boundary
        maxValue - maximum boundary
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array - length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        -
        Returns:
        a double array Property object with all settings defined
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String defaultValue)
        -
        Gets a string Property without a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        -
        Returns:
        a string Property with validationPattern = null, validValues = null
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String defaultValue,
-           java.lang.String comment)
        -
        Gets a string Property with a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        -
        Returns:
        a string Property with validationPattern = null, validValues = null
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String defaultValue,
-           java.lang.String comment,
-           java.util.regex.Pattern validationPattern)
        -
        Gets a string Property with a comment using the defined validationPattern and otherwise default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        validationPattern - a Pattern object for input validation
        -
        Returns:
        a string Property with the defined validationPattern, validValues = null
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String defaultValue,
-           java.lang.String comment,
-           java.lang.String[] validValues)
        -
        Gets a string Property with a comment using the defined validValues array and otherwise default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        validValues - an array of valid values that this Property can be set to. If an array is provided the Config GUI control will be - a value cycle button.
        -
        Returns:
        a string Property with the defined validValues array, validationPattern = null
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String[] defaultValues)
        -
        Gets a string array Property without a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        -
        Returns:
        a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String[] defaultValues,
-           java.lang.String comment)
        -
        Gets a string array Property with a comment using the default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        -
        Returns:
        a string array Property with validationPattern = null, isListLengthFixed = false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String[] defaultValues,
-           java.lang.String comment,
-           java.util.regex.Pattern validationPattern)
        -
        Gets a string array Property with a comment using the defined validationPattern and otherwise default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        validationPattern - a Pattern object for input validation
        -
        Returns:
        a string array Property with the defined validationPattern, isListLengthFixed = false, maxListLength = -1
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String[] defaultValues,
-           java.lang.String comment,
-           boolean isListLengthFixed,
-           int maxListLength,
-           java.util.regex.Pattern validationPattern)
        -
        Gets a string array Property with a comment with all settings defined.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        isListLengthFixed - boolean for whether this array is required to be a specific length (defined by the default value array - length or maxListLength)
        maxListLength - the maximum length of this array, use -1 for no max length
        validationPattern - a Pattern object for input validation
        -
        Returns:
        a string array Property with a comment with all settings defined
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String defaultValue,
-           java.lang.String comment,
-           Property.Type type)
        -
        Gets a Property object of the specified type using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValue - the default value
        comment - a String comment
        type - a Property.Type enum value
        -
        Returns:
        a Property object of the specified type using default settings
        -
        • -
      - - - -
        -
      • -

        get

        -
        public Property get(java.lang.String category,
-           java.lang.String key,
-           java.lang.String[] defaultValues,
-           java.lang.String comment,
-           Property.Type type)
        -
        Gets a list (array) Property object of the specified type using default settings.
        -
        Parameters:
        category - the config category
        key - the Property key value
        defaultValues - an array containing the default values
        comment - a String comment
        type - a Property.Type enum value
        -
        Returns:
        a list (array) Property object of the specified type using default settings
        -
        • -
      - - - -
        -
      • -

        hasCategory

        -
        public boolean hasCategory(java.lang.String category)
        -
        • -
      - - - -
        -
      • -

        hasKey

        -
        public boolean hasKey(java.lang.String category,
-             java.lang.String key)
        -
        • -
      - - - -
        -
      • -

        load

        -
        public void load()
        -
        • -
      - - - -
        -
      • -

        save

        -
        public void save()
        -
        • -
      - - - -
        -
      • -

        getCategory

        -
        public ConfigCategory getCategory(java.lang.String category)
        -
        • -
      - - - -
        -
      • -

        removeCategory

        -
        public void removeCategory(ConfigCategory category)
        -
        • -
      - - - -
        -
      • -

        setCategoryComment

        -
        public Configuration setCategoryComment(java.lang.String category,
-                               java.lang.String comment)
        -
        Adds a comment to the specified ConfigCategory object
        -
        Parameters:
        category - the config category
        comment - a String comment
        -
        • -
      - - - -
        -
      • -

        addCustomCategoryComment

        -
        public void addCustomCategoryComment(java.lang.String category,
-                            java.lang.String comment)
        -
        • -
      - - - -
        -
      • -

        setCategoryLanguageKey

        -
        public Configuration setCategoryLanguageKey(java.lang.String category,
-                                   java.lang.String langKey)
        -
        Adds a language key to the specified ConfigCategory object
        -
        Parameters:
        category - the config category
        langKey - a language key string such as configcategory.general
        -
        • -
      - - - -
        -
      • -

        setCategoryConfigEntryClass

        -
        public Configuration setCategoryConfigEntryClass(java.lang.String category,
-                                        java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
        -
        Sets the custom IConfigEntry class that should be used in place of the standard entry class (which is just a button that - navigates into the category). This class MUST provide a constructor with the following parameter types: GuiConfig (the parent - GuiConfig screen will be provided), GuiPropertyList (the parent GuiPropertyList will be provided), IConfigElement - (the IConfigElement for this Property will be provided).
        -
        • -
      - - - -
        -
      • -

        setCategoryRequiresWorldRestart

        -
        public Configuration setCategoryRequiresWorldRestart(java.lang.String category,
-                                            boolean requiresWorldRestart)
        -
        Sets the flag for whether or not this category can be edited while a world is running. Care should be taken to ensure - that only properties that are truly dynamic can be changed from the in-game options menu. Only set this flag to - true if all child properties/categories are unable to be modified while a world is running.
        -
        • -
      - - - -
        -
      • -

        setCategoryRequiresMcRestart

        -
        public Configuration setCategoryRequiresMcRestart(java.lang.String category,
-                                         boolean requiresMcRestart)
        -
        Sets whether or not this ConfigCategory requires Minecraft to be restarted when changed. - Defaults to false. Only set this flag to true if ALL child properties/categories require - Minecraft to be restarted when changed. Setting this flag will also prevent modification - of the child properties/categories while a world is running.
        -
        • -
      - - - -
        -
      • -

        setCategoryPropertyOrder

        -
        public Configuration setCategoryPropertyOrder(java.lang.String category,
-                                     java.util.List<java.lang.String> propOrder)
        -
        Sets the order that direct child properties of this config category will be written to the config file and will be displayed in - config GUIs.
        -
        • -
      - - - -
        -
      • -

        enableGlobalConfig

        -
        public static void enableGlobalConfig()
        -
        • -
      - - - -
        -
      • -

        hasChanged

        -
        public boolean hasChanged()
        -
        • -
      - - - -
        -
      • -

        getCategoryNames

        -
        public java.util.Set<java.lang.String> getCategoryNames()
        -
        • -
      - - - -
        -
      • -

        renameProperty

        -
        public boolean renameProperty(java.lang.String category,
-                     java.lang.String oldPropName,
-                     java.lang.String newPropName)
        -
        Renames a property in a given category.
        -
        Parameters:
        category - the category in which the property resides
        oldPropName - the existing property name
        newPropName - the new property name
        -
        Returns:
        true if the category and property exist, false otherwise
        -
        • -
      - - - -
        -
      • -

        moveProperty

        -
        public boolean moveProperty(java.lang.String oldCategory,
-                   java.lang.String propName,
-                   java.lang.String newCategory)
        -
        Moves a property from one category to another.
        -
        Parameters:
        oldCategory - the category the property currently resides in
        propName - the name of the property to move
        newCategory - the category the property should be moved to
        -
        Returns:
        true if the old category and property exist, false otherwise
        -
        • -
      - - - -
        -
      • -

        copyCategoryProps

        -
        public void copyCategoryProps(Configuration fromConfig,
-                     java.lang.String[] ctgys)
        -
        Copies property objects from another Configuration object to this one using the list of category names. Properties that only exist in the - "from" object are ignored. Pass null for the ctgys array to include all categories.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(java.lang.String name,
-                         java.lang.String category,
-                         java.lang.String defaultValue,
-                         java.lang.String comment)
        -
        Creates a string property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(java.lang.String name,
-                         java.lang.String category,
-                         java.lang.String defaultValue,
-                         java.lang.String comment,
-                         java.lang.String langKey)
        -
        Creates a string property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(java.lang.String name,
-                         java.lang.String category,
-                         java.lang.String defaultValue,
-                         java.lang.String comment,
-                         java.util.regex.Pattern pattern)
        -
        Creates a string property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(java.lang.String name,
-                         java.lang.String category,
-                         java.lang.String defaultValue,
-                         java.lang.String comment,
-                         java.lang.String langKey,
-                         java.util.regex.Pattern pattern)
        -
        Creates a string property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(java.lang.String name,
-                         java.lang.String category,
-                         java.lang.String defaultValue,
-                         java.lang.String comment,
-                         java.lang.String[] validValues)
        -
        Creates a string property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        validValues - A list of valid values that this property can be set to.
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString(java.lang.String name,
-                         java.lang.String category,
-                         java.lang.String defaultValue,
-                         java.lang.String comment,
-                         java.lang.String[] validValues,
-                         java.lang.String langKey)
        -
        Creates a string property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        validValues - A list of valid values that this property can be set to.
        langKey - A language key used for localization of GUIs
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getStringList

        -
        public java.lang.String[] getStringList(java.lang.String name,
-                               java.lang.String category,
-                               java.lang.String[] defaultValues,
-                               java.lang.String comment)
        -
        Creates a string list property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getStringList

        -
        public java.lang.String[] getStringList(java.lang.String name,
-                               java.lang.String category,
-                               java.lang.String[] defaultValue,
-                               java.lang.String comment,
-                               java.lang.String[] validValues)
        -
        Creates a string list property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getStringList

        -
        public java.lang.String[] getStringList(java.lang.String name,
-                               java.lang.String category,
-                               java.lang.String[] defaultValue,
-                               java.lang.String comment,
-                               java.lang.String[] validValues,
-                               java.lang.String langKey)
        -
        Creates a string list property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new string property.
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean(java.lang.String name,
-                 java.lang.String category,
-                 boolean defaultValue,
-                 java.lang.String comment)
        -
        Creates a boolean property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new boolean property.
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean(java.lang.String name,
-                 java.lang.String category,
-                 boolean defaultValue,
-                 java.lang.String comment,
-                 java.lang.String langKey)
        -
        Creates a boolean property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        -
        Returns:
        The value of the new boolean property.
        -
        • -
      - - - -
        -
      • -

        getInt

        -
        public int getInt(java.lang.String name,
-         java.lang.String category,
-         int defaultValue,
-         int minValue,
-         int maxValue,
-         java.lang.String comment)
        -
        Creates a integer property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new integer property.
        -
        • -
      - - - -
        -
      • -

        getInt

        -
        public int getInt(java.lang.String name,
-         java.lang.String category,
-         int defaultValue,
-         int minValue,
-         int maxValue,
-         java.lang.String comment,
-         java.lang.String langKey)
        -
        Creates a integer property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        -
        Returns:
        The value of the new integer property.
        -
        • -
      - - - -
        -
      • -

        getFloat

        -
        public float getFloat(java.lang.String name,
-             java.lang.String category,
-             float defaultValue,
-             float minValue,
-             float maxValue,
-             java.lang.String comment)
        -
        Creates a float property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        -
        Returns:
        The value of the new float property.
        -
        • -
      - - - -
        -
      • -

        getFloat

        -
        public float getFloat(java.lang.String name,
-             java.lang.String category,
-             float defaultValue,
-             float minValue,
-             float maxValue,
-             java.lang.String comment,
-             java.lang.String langKey)
        -
        Creates a float property.
        -
        Parameters:
        name - Name of the property.
        category - Category of the property.
        defaultValue - Default value of the property.
        minValue - Minimum value of the property.
        maxValue - Maximum value of the property.
        comment - A brief description what the property does.
        langKey - A language key used for localization of GUIs
        -
        Returns:
        The value of the new float property.
        -
        • -
      - - - -
        -
      • -

        getConfigFile

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

Enum Property.Type

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

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      chargetID() 
      static Property.TypetryParse(char id) 
      static Property.TypevalueOf(java.lang.String name) -
      Returns the enum constant of this type with the specified name.
      -
      static Property.Type[]values() -
      Returns an array containing the constants of this enum type, in -the order they are declared.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Enum

        -clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -getClass, notify, notifyAll, wait, wait, wait
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

        -
        public static Property.Type[] values()
        -
        Returns an array containing the constants of this enum type, in -the order they are declared. This method may be used to iterate -over the constants as follows: -
        -for (Property.Type c : Property.Type.values())
-    System.out.println(c);
-
        -
        Returns:
        an array containing the constants of this enum type, in the order they are declared
        -
        • -
      - - - -
        -
      • -

        valueOf

        -
        public static Property.Type valueOf(java.lang.String name)
        -
        Returns the enum constant of this type with the specified name. -The string must match exactly an identifier used to declare an -enum constant in this type. (Extraneous whitespace characters are -not permitted.)
        -
        Parameters:
        name - the name of the enum constant to be returned.
        -
        Returns:
        the enum constant with the specified name
        -
        Throws:
        -
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        -
        java.lang.NullPointerException - if the argument is null
        -
        • -
      - - - -
        -
      • -

        tryParse

        -
        public static Property.Type tryParse(char id)
        -
        • -
      - - - -
        -
      • -

        getID

        -
        public char getID()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/config/Property.html b/javadoc/net/minecraftforge/common/config/Property.html deleted file mode 100644 index 3c842c9..0000000 --- a/javadoc/net/minecraftforge/common/config/Property.html +++ /dev/null @@ -1,1733 +0,0 @@ - - - - - -Property (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.config
-

Class Property

-
-
- -
-
    -
  • -
    -
    -
    public class Property
-extends java.lang.Object
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass and Description
      static class Property.Type 
      -
      • -
    - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      java.lang.Stringcomment 
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry>getArrayEntryClass() -
      Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if - none has been set.
      -
      booleangetBoolean() -
      Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.
      -
      booleangetBoolean(boolean _default) -
      Returns the value in this property as a boolean, - if the value is not a valid boolean, it will return the - provided default.
      -
      boolean[]getBooleanList() -
      Returns the boolean value of all values that can - be parsed in the list.
      -
      java.lang.Class<? extends GuiConfigEntries.IConfigEntry>getConfigEntryClass() -
      Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if - none has been set.
      -
      java.lang.StringgetDefault() -
      Gets the raw String default value of this Property.
      -
      java.lang.String[]getDefaults() -
      Gets the raw String[] default values of this Property.
      -
      doublegetDouble() -
      Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.
      -
      doublegetDouble(double _default) -
      Returns the value in this property as a double, - if the value is not a valid double, it will return the - provided default.
      -
      double[]getDoubleList() -
      Returns the double value of all values that can - be parsed in the list.
      -
      intgetInt() -
      Returns the value in this property as an integer, - if the value is not a valid integer, it will return the initially provided default.
      -
      intgetInt(int _default) -
      Returns the value in this property as an integer, - if the value is not a valid integer, it will return the - provided default.
      -
      int[]getIntList() -
      Returns the integer value of all values that can - be parsed in the list.
      -
      java.lang.StringgetLanguageKey() -
      Gets the language key string for this Property.
      -
      intgetMaxListLength() -
      Gets the maximum length of this list/array Property.
      -
      java.lang.StringgetMaxValue() -
      Gets the maximum value.
      -
      java.lang.StringgetMinValue() -
      Gets the minimum value.
      -
      java.lang.StringgetName() -
      Gets the name/key for this Property.
      -
      java.lang.StringgetString() -
      Returns the value in this property as it's raw string.
      -
      java.lang.String[]getStringList() 
      Property.TypegetType() -
      Gets the Property.Type enum value for this Property.
      -
      java.util.regex.PatterngetValidationPattern() -
      Gets the Pattern object used to validate user input for this Property.
      -
      java.lang.String[]getValidValues() -
      Gets the array of valid values that this String Property can be set to, or null if not defined.
      -
      booleanhasChanged() -
      Gets the changed status of this Property.
      -
      booleanisBooleanList() -
      Checks if all of current values stored in this property can be converted to a boolean.
      -
      booleanisBooleanValue() -
      Checks if the current value held by this property is a valid boolean value.
      -
      booleanisDefault() -
      Returns whether or not this Property is defaulted.
      -
      booleanisDoubleList() -
      Checks if all of the current values stored in this property can be converted to a double.
      -
      booleanisDoubleValue() -
      Checks if the current value held by this property is a valid double value.
      -
      booleanisIntList() -
      Checks if all of the current values stored in this property can be converted to an integer.
      -
      booleanisIntValue() -
      Checks if the current value stored in this property can be converted to an integer.
      -
      booleanisList() -
      Returns whether or not this Property is a list/array.
      -
      booleanisListLengthFixed() -
      Returns whether or not this list/array has a fixed length.
      -
      booleanrequiresMcRestart() -
      Gets whether or not this Property requires Minecraft to be restarted when changed.
      -
      booleanrequiresWorldRestart() -
      Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen - as well as the Mods list screen, or only from the Mods list screen.
      -
      voidset(boolean value) 
      voidset(boolean[] values) 
      voidset(double value) 
      voidset(double[] values) 
      voidset(int value) 
      voidset(int[] values) 
      voidset(java.lang.String value) 
      voidset(java.lang.String[] values) 
      PropertysetArrayEntryClass(java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> clazz) -
      Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type.
      -
      PropertysetConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz) -
      Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type.
      -
      PropertysetDefaultValue(boolean defaultValue) -
      Sets the default boolean value of this Property.
      -
      PropertysetDefaultValue(double defaultValue) -
      Sets the default double value of this Property.
      -
      PropertysetDefaultValue(int defaultValue) -
      Sets the default int value of this Property.
      -
      PropertysetDefaultValue(java.lang.String defaultValue) -
      Sets the default string value of this Property.
      -
      PropertysetDefaultValues(boolean[] defaultValues) -
      Sets the default boolean[] values of this Property.
      -
      PropertysetDefaultValues(double[] defaultValues) -
      Sets the default double[] values of this Property
      -
      PropertysetDefaultValues(int[] defaultValues) -
      Sets the default int[] values of this Property.
      -
      PropertysetDefaultValues(java.lang.String[] defaultValues) -
      Sets the default String[] values of this Property.
      -
      PropertysetIsListLengthFixed(boolean isListLengthFixed) -
      Sets the flag for whether this list/array Property has a fixed length.
      -
      PropertysetLanguageKey(java.lang.String langKey) -
      Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3.
      -
      PropertysetMaxListLength(int max) -
      Sets the maximum length of this list/array Property.
      -
      PropertysetMaxValue(double maxValue) -
      Sets the maximum double value of this Property.
      -
      PropertysetMaxValue(int maxValue) -
      Sets the maximum int value of this Property.
      -
      PropertysetMinValue(double minValue) -
      Sets the minimum double value of this Property.
      -
      PropertysetMinValue(int minValue) -
      Sets the minimum int value of this Property.
      -
      voidsetName(java.lang.String name) -
      Sets the name/key for this Property.
      -
      PropertysetRequiresMcRestart(boolean requiresMcRestart) -
      Sets whether or not this Property requires Minecraft to be restarted when changed.
      -
      PropertysetRequiresWorldRestart(boolean requiresWorldRestart) -
      Sets the flag for whether or not this Property can be edited while a world is running.
      -
      PropertysetShowInGui(boolean showInGui) -
      Sets whether or not this Property should be allowed to show on config GUIs.
      -
      PropertysetToDefault() -
      Sets the current value(s) of this Property to the default value(s).
      -
      PropertysetValidationPattern(java.util.regex.Pattern validationPattern) -
      Sets a regex Pattern object used to validate user input for formatted String or String[] properties.
      -
      PropertysetValidValues(java.lang.String[] validValues) -
      Sets the array of valid values that this String Property can be set to.
      -
      PropertysetValue(boolean value) -
      Sets the value of this Property to the provided boolean value.
      -
      PropertysetValue(double value) -
      Sets the value of this Property to the provided double value.
      -
      PropertysetValue(int value) -
      Sets the value of this Property to the provided int value.
      -
      PropertysetValue(java.lang.String value) -
      Sets the value of this Property to the provided String value.
      -
      PropertysetValues(boolean[] values) -
      Sets the values of this Property to the provided boolean[] values.
      -
      PropertysetValues(double[] values) -
      Sets the values of this Property to the provided double[] values.
      -
      PropertysetValues(int[] values) -
      Sets the values of this Property to the provided int[] values.
      -
      PropertysetValues(java.lang.String[] values) -
      Sets the values of this Property to the provided String[] values.
      -
      booleanshowInGui() -
      Gets whether or not this Property should be allowed to show on config GUIs.
      -
      booleanwasRead() -
      Determines if this config value was just created, or if it was read from the config file.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Field Detail

      - - - -
        -
      • -

        comment

        -
        public java.lang.String comment
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String value,
-        Property.Type type)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String value,
-        Property.Type type,
-        boolean read)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String value,
-        Property.Type type,
-        java.lang.String[] validValues)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String value,
-        Property.Type type,
-        java.lang.String langKey)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String value,
-        Property.Type type,
-        boolean read,
-        java.lang.String langKey)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String value,
-        Property.Type type,
-        java.lang.String[] validValues,
-        java.lang.String langKey)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String[] values,
-        Property.Type type)
        -
        • -
      - - - -
        -
      • -

        Property

        -
        public Property(java.lang.String name,
-        java.lang.String[] values,
-        Property.Type type,
-        java.lang.String langKey)
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        isDefault

        -
        public boolean isDefault()
        -
        Returns whether or not this Property is defaulted.
        -
        Returns:
        true if the current value(s) is(are) deeply equal to the default value(s)
        -
        • -
      - - - -
        -
      • -

        setToDefault

        -
        public Property setToDefault()
        -
        Sets the current value(s) of this Property to the default value(s).
        -
        • -
      - - - -
        -
      • -

        getDefault

        -
        public java.lang.String getDefault()
        -
        Gets the raw String default value of this Property. Check for isList() == false first.
        -
        Returns:
        the default value String
        -
        • -
      - - - -
        -
      • -

        getDefaults

        -
        public java.lang.String[] getDefaults()
        -
        Gets the raw String[] default values of this Property. Check for isList() == true first.
        -
        Returns:
        the default values String[]
        -
        • -
      - - - -
        -
      • -

        setRequiresWorldRestart

        -
        public Property setRequiresWorldRestart(boolean requiresWorldRestart)
        -
        Sets the flag for whether or not this Property can be edited while a world is running. Care should be taken to ensure - that only properties that are truly dynamic can be changed from the in-game options menu. When set to false the Property will be - editable from both the main menu Mods list config screen and the in-game Mod Options config screen. When set to true the Property - will only be editable from the main menu Mods list config screen.
        -
        • -
      - - - -
        -
      • -

        requiresWorldRestart

        -
        public boolean requiresWorldRestart()
        -
        Returns whether or not this Property is able to be edited while a world is running using the in-game Mod Options screen - as well as the Mods list screen, or only from the Mods list screen. Setting this flag to true will disable editing of - this property while a world is running.
        -
        • -
      - - - -
        -
      • -

        setShowInGui

        -
        public Property setShowInGui(boolean showInGui)
        -
        Sets whether or not this Property should be allowed to show on config GUIs. - Defaults to true.
        -
        • -
      - - - -
        -
      • -

        showInGui

        -
        public boolean showInGui()
        -
        Gets whether or not this Property should be allowed to show on config GUIs. - Defaults to true unless set to false.
        -
        • -
      - - - -
        -
      • -

        setRequiresMcRestart

        -
        public Property setRequiresMcRestart(boolean requiresMcRestart)
        -
        Sets whether or not this Property requires Minecraft to be restarted when changed. - Defaults to false. Setting this flag to true will also disable editing of - this property while a world is running.
        -
        • -
      - - - -
        -
      • -

        requiresMcRestart

        -
        public boolean requiresMcRestart()
        -
        Gets whether or not this Property requires Minecraft to be restarted when changed. - Defaults to false unless set to true.
        -
        • -
      - - - -
        -
      • -

        setMaxListLength

        -
        public Property setMaxListLength(int max)
        -
        Sets the maximum length of this list/array Property. Only important if isList() == true. If the current values array or default - values array is longer than the new maximum it will be resized. If calling both this method and setIsListLengthFixed(true), this - method should be called afterwards (but is not required).
        -
        • -
      - - - -
        -
      • -

        getMaxListLength

        -
        public int getMaxListLength()
        -
        Gets the maximum length of this list/array Property. Only important if isList() == true.
        -
        • -
      - - - -
        -
      • -

        setIsListLengthFixed

        -
        public Property setIsListLengthFixed(boolean isListLengthFixed)
        -
        Sets the flag for whether this list/array Property has a fixed length. Only important if isList() == true. If calling both this - method and setMaxListLength(), this method should be called first (but is not required).
        -
        • -
      - - - -
        -
      • -

        isListLengthFixed

        -
        public boolean isListLengthFixed()
        -
        Returns whether or not this list/array has a fixed length. Only important if isList() == true.
        -
        • -
      - - - -
        -
      • -

        setConfigEntryClass

        -
        public Property setConfigEntryClass(java.lang.Class<? extends GuiConfigEntries.IConfigEntry> clazz)
        -
        Sets a custom IConfigEntry class that should be used in place of the standard entry class for this Property type. This class - MUST provide a constructor with the following parameter types: GuiConfig (the owning GuiConfig screen will be provided), - GuiConfigEntries (the owning GuiConfigEntries will be provided), IConfigElement (the IConfigElement for this Property - will be provided).
        -
        • -
      - - - -
        -
      • -

        getConfigEntryClass

        -
        public java.lang.Class<? extends GuiConfigEntries.IConfigEntry> getConfigEntryClass()
        -
        Gets the custom IConfigEntry class that should be used in place of the standard entry class for this Property type, or null if - none has been set.
        -
        Returns:
        a class that implements IConfigEntry
        -
        • -
      - - - -
        -
      • -

        setArrayEntryClass

        -
        public Property setArrayEntryClass(java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> clazz)
        -
        Sets a custom IGuiEditListEntry class that should be used in place of the standard entry class for this Property type. This class - MUST provide a constructor with the following parameter types: GuiEditList (the owning GuiEditList screen will be provided), - GuiPropertyList (the parent GuiPropertyList will be provided), IConfigProperty (the IConfigProperty for this Property - will be provided).
        -
        Parameters:
        clazz - a class that implements IConfigEntry
        -
        • -
      - - - -
        -
      • -

        getArrayEntryClass

        -
        public java.lang.Class<? extends GuiEditArrayEntries.IArrayEntry> getArrayEntryClass()
        -
        Gets the custom IArrayEntry class that should be used in place of the standard entry class for this Property type, or null if - none has been set.
        -
        Returns:
        a class that implements IArrayEntry
        -
        • -
      - - - -
        -
      • -

        setValidationPattern

        -
        public Property setValidationPattern(java.util.regex.Pattern validationPattern)
        -
        Sets a regex Pattern object used to validate user input for formatted String or String[] properties.
        -
        Parameters:
        validationPattern -
        -
        • -
      - - - -
        -
      • -

        getValidationPattern

        -
        public java.util.regex.Pattern getValidationPattern()
        -
        Gets the Pattern object used to validate user input for this Property.
        -
        Returns:
        the user input validation Pattern object, or null if none is set
        -
        • -
      - - - -
        -
      • -

        setLanguageKey

        -
        public Property setLanguageKey(java.lang.String langKey)
        -
        Sets the localization language key for this Property so that the config GUI screens are nice and pretty <3. The string languageKey + - ".tooltip" is used for tooltips when a user hovers the mouse over a GUI property label.
        -
        Parameters:
        langKey - a string language key such as myawesomemod.config.myPropName
        -
        • -
      - - - -
        -
      • -

        getLanguageKey

        -
        public java.lang.String getLanguageKey()
        -
        Gets the language key string for this Property.
        -
        Returns:
        the language key
        -
        • -
      - - - -
        -
      • -

        setDefaultValue

        -
        public Property setDefaultValue(java.lang.String defaultValue)
        -
        Sets the default string value of this Property.
        -
        Parameters:
        defaultValue - a String value
        -
        • -
      - - - -
        -
      • -

        setDefaultValues

        -
        public Property setDefaultValues(java.lang.String[] defaultValues)
        -
        Sets the default String[] values of this Property.
        -
        Parameters:
        defaultValues - an array of String values
        -
        • -
      - - - -
        -
      • -

        setDefaultValue

        -
        public Property setDefaultValue(int defaultValue)
        -
        Sets the default int value of this Property.
        -
        Parameters:
        defaultValue - an int value
        -
        • -
      - - - -
        -
      • -

        setDefaultValues

        -
        public Property setDefaultValues(int[] defaultValues)
        -
        Sets the default int[] values of this Property.
        -
        Parameters:
        defaultValues - an array of int values
        -
        • -
      - - - -
        -
      • -

        setDefaultValue

        -
        public Property setDefaultValue(double defaultValue)
        -
        Sets the default double value of this Property.
        -
        Parameters:
        defaultValue - a double value
        -
        • -
      - - - -
        -
      • -

        setDefaultValues

        -
        public Property setDefaultValues(double[] defaultValues)
        -
        Sets the default double[] values of this Property
        -
        Parameters:
        defaultValues - an array of double values
        -
        • -
      - - - -
        -
      • -

        setDefaultValue

        -
        public Property setDefaultValue(boolean defaultValue)
        -
        Sets the default boolean value of this Property.
        -
        Parameters:
        defaultValue - a boolean value
        -
        • -
      - - - -
        -
      • -

        setDefaultValues

        -
        public Property setDefaultValues(boolean[] defaultValues)
        -
        Sets the default boolean[] values of this Property.
        -
        Parameters:
        defaultValues - an array of boolean values
        -
        • -
      - - - -
        -
      • -

        setMinValue

        -
        public Property setMinValue(int minValue)
        -
        Sets the minimum int value of this Property.
        -
        Parameters:
        minValue - an int value
        -
        • -
      - - - -
        -
      • -

        setMaxValue

        -
        public Property setMaxValue(int maxValue)
        -
        Sets the maximum int value of this Property.
        -
        Parameters:
        maxValue - an int value
        -
        • -
      - - - -
        -
      • -

        setMinValue

        -
        public Property setMinValue(double minValue)
        -
        Sets the minimum double value of this Property.
        -
        Parameters:
        minValue - a double value
        -
        • -
      - - - -
        -
      • -

        setMaxValue

        -
        public Property setMaxValue(double maxValue)
        -
        Sets the maximum double value of this Property.
        -
        Parameters:
        maxValue - a double value
        -
        • -
      - - - -
        -
      • -

        getMinValue

        -
        public java.lang.String getMinValue()
        -
        Gets the minimum value.
        -
        Returns:
        the minimum value bound
        -
        • -
      - - - -
        -
      • -

        getMaxValue

        -
        public java.lang.String getMaxValue()
        -
        Gets the maximum value.
        -
        Returns:
        the maximum value bound
        -
        • -
      - - - -
        -
      • -

        getString

        -
        public java.lang.String getString()
        -
        Returns the value in this property as it's raw string.
        -
        Returns:
        current value
        -
        • -
      - - - -
        -
      • -

        setValidValues

        -
        public Property setValidValues(java.lang.String[] validValues)
        -
        Sets the array of valid values that this String Property can be set to. When an array of valid values is defined for a Property the - GUI control for that property will be a value cycle button.
        -
        Parameters:
        validValues - a String array of valid values
        -
        • -
      - - - -
        -
      • -

        getValidValues

        -
        public java.lang.String[] getValidValues()
        -
        Gets the array of valid values that this String Property can be set to, or null if not defined.
        -
        Returns:
        a String array of valid values
        -
        • -
      - - - -
        -
      • -

        getInt

        -
        public int getInt()
        -
        Returns the value in this property as an integer, - if the value is not a valid integer, it will return the initially provided default.
        -
        Returns:
        The value
        -
        • -
      - - - -
        -
      • -

        getInt

        -
        public int getInt(int _default)
        -
        Returns the value in this property as an integer, - if the value is not a valid integer, it will return the - provided default.
        -
        Parameters:
        _default - The default to provide if the current value is not a valid integer
        -
        Returns:
        The value
        -
        • -
      - - - -
        -
      • -

        isIntValue

        -
        public boolean isIntValue()
        -
        Checks if the current value stored in this property can be converted to an integer.
        -
        Returns:
        True if the type of the Property is an Integer
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean(boolean _default)
        -
        Returns the value in this property as a boolean, - if the value is not a valid boolean, it will return the - provided default.
        -
        Parameters:
        _default - The default to provide
        -
        Returns:
        The value as a boolean, or the default
        -
        • -
      - - - -
        -
      • -

        getBoolean

        -
        public boolean getBoolean()
        -
        Returns the value in this property as a boolean, if the value is not a valid boolean, it will return the provided default.
        -
        Returns:
        The value as a boolean, or the default
        -
        • -
      - - - -
        -
      • -

        isBooleanValue

        -
        public boolean isBooleanValue()
        -
        Checks if the current value held by this property is a valid boolean value.
        -
        Returns:
        True if it is a boolean value
        -
        • -
      - - - -
        -
      • -

        isDoubleValue

        -
        public boolean isDoubleValue()
        -
        Checks if the current value held by this property is a valid double value.
        -
        Returns:
        True if the value can be converted to an double
        -
        • -
      - - - -
        -
      • -

        getDouble

        -
        public double getDouble(double _default)
        -
        Returns the value in this property as a double, - if the value is not a valid double, it will return the - provided default.
        -
        Parameters:
        _default - The default to provide if the current value is not a valid double
        -
        Returns:
        The value
        -
        • -
      - - - -
        -
      • -

        getDouble

        -
        public double getDouble()
        -
        Returns the value in this property as a double, if the value is not a valid double, it will return the provided default.
        -
        Parameters:
        _default - The default to provide if the current value is not a valid double
        -
        Returns:
        The value
        -
        • -
      - - - -
        -
      • -

        getStringList

        -
        public java.lang.String[] getStringList()
        -
        • -
      - - - -
        -
      • -

        getIntList

        -
        public int[] getIntList()
        -
        Returns the integer value of all values that can - be parsed in the list.
        -
        Returns:
        Array of length 0 if none of the values could be parsed.
        -
        • -
      - - - -
        -
      • -

        isIntList

        -
        public boolean isIntList()
        -
        Checks if all of the current values stored in this property can be converted to an integer.
        -
        Returns:
        True if the type of the Property is an Integer List
        -
        • -
      - - - -
        -
      • -

        getBooleanList

        -
        public boolean[] getBooleanList()
        -
        Returns the boolean value of all values that can - be parsed in the list.
        -
        Returns:
        Array of length 0 if none of the values could be parsed.
        -
        • -
      - - - -
        -
      • -

        isBooleanList

        -
        public boolean isBooleanList()
        -
        Checks if all of current values stored in this property can be converted to a boolean.
        -
        Returns:
        True if it is a boolean value
        -
        • -
      - - - -
        -
      • -

        getDoubleList

        -
        public double[] getDoubleList()
        -
        Returns the double value of all values that can - be parsed in the list.
        -
        Returns:
        Array of length 0 if none of the values could be parsed.
        -
        • -
      - - - -
        -
      • -

        isDoubleList

        -
        public boolean isDoubleList()
        -
        Checks if all of the current values stored in this property can be converted to a double.
        -
        Returns:
        True if the type of the Property is a double List
        -
        • -
      - - - -
        -
      • -

        getName

        -
        public java.lang.String getName()
        -
        Gets the name/key for this Property.
        -
        Returns:
        the Property name
        -
        • -
      - - - -
        -
      • -

        setName

        -
        public void setName(java.lang.String name)
        -
        Sets the name/key for this Property.
        -
        Parameters:
        name - a name
        -
        • -
      - - - -
        -
      • -

        wasRead

        -
        public boolean wasRead()
        -
        Determines if this config value was just created, or if it was read from the config file. - This is useful for mods who auto-assign their blocks to determine if the ID returned is - a configured one, or a automatically generated one.
        -
        Returns:
        True if this property was loaded from the config file with a value
        -
        • -
      - - - -
        -
      • -

        getType

        -
        public Property.Type getType()
        -
        Gets the Property.Type enum value for this Property.
        -
        Returns:
        the Property's type
        -
        • -
      - - - -
        -
      • -

        isList

        -
        public boolean isList()
        -
        Returns whether or not this Property is a list/array.
        -
        Returns:
        true if this Property is a list/array, false otherwise
        -
        • -
      - - - -
        -
      • -

        hasChanged

        -
        public boolean hasChanged()
        -
        Gets the changed status of this Property.
        -
        Returns:
        true if this Property has changed, false otherwise
        -
        • -
      - - - -
        -
      • -

        setValue

        -
        public Property setValue(java.lang.String value)
        -
        Sets the value of this Property to the provided String value.
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(java.lang.String value)
        -
        • -
      - - - -
        -
      • -

        setValues

        -
        public Property setValues(java.lang.String[] values)
        -
        Sets the values of this Property to the provided String[] values.
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(java.lang.String[] values)
        -
        • -
      - - - -
        -
      • -

        setValue

        -
        public Property setValue(int value)
        -
        Sets the value of this Property to the provided int value.
        -
        • -
      - - - -
        -
      • -

        setValue

        -
        public Property setValue(boolean value)
        -
        Sets the value of this Property to the provided boolean value.
        -
        • -
      - - - -
        -
      • -

        setValue

        -
        public Property setValue(double value)
        -
        Sets the value of this Property to the provided double value.
        -
        • -
      - - - -
        -
      • -

        setValues

        -
        public Property setValues(boolean[] values)
        -
        Sets the values of this Property to the provided boolean[] values.
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(boolean[] values)
        -
        • -
      - - - -
        -
      • -

        setValues

        -
        public Property setValues(int[] values)
        -
        Sets the values of this Property to the provided int[] values.
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(int[] values)
        -
        • -
      - - - -
        -
      • -

        setValues

        -
        public Property setValues(double[] values)
        -
        Sets the values of this Property to the provided double[] values.
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(double[] values)
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(int value)
        -
        • -
      - - - -
        -
      • -

        set

        -
        public void set(boolean value)
        -
        • -
      - - - -
        -
      • -

        set

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

net.minecraftforge.common.config

-
-

Classes

- -

Enums

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

Package net.minecraftforge.common.config

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

Hierarchy For Package net.minecraftforge.common.config

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Enum Hierarchy

- -
- -
- - - - - -
-
- - - -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html b/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html deleted file mode 100644 index 7d79bb3..0000000 --- a/javadoc/net/minecraftforge/common/network/DimensionMessageHandler.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - -DimensionMessageHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.network
-

Class DimensionMessageHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    -
    -
    -
    -
    public class DimensionMessageHandler
-extends io.netty.channel.SimpleChannelInboundHandler<ForgeMessage.DimensionRegisterMessage>
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      -
        -
      • - - -

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        -io.netty.channel.ChannelHandler.Sharable
        • -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, - ForgeMessage.DimensionRegisterMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, - java.lang.Throwable cause) 
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        -acceptInboundMessage, channelRead
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        -channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        -handlerAdded, handlerRemoved, isSharable
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface io.netty.channel.ChannelHandler

        -handlerAdded, handlerRemoved
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DimensionMessageHandler

        -
        public DimensionMessageHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        exceptionCaught

        -
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
-                   java.lang.Throwable cause)
-                     throws java.lang.Exception
        -
        -
        Specified by:
        -
        exceptionCaught in interface io.netty.channel.ChannelHandler
        -
        Specified by:
        -
        exceptionCaught in interface io.netty.channel.ChannelInboundHandler
        -
        Overrides:
        -
        exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter
        -
        Throws:
        -
        java.lang.Exception
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html b/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html deleted file mode 100644 index 8471382..0000000 --- a/javadoc/net/minecraftforge/common/network/FluidIdRegistryMessageHandler.html +++ /dev/null @@ -1,349 +0,0 @@ - - - - - -FluidIdRegistryMessageHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.network
-

Class FluidIdRegistryMessageHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    -
    -
    -
    -
    public class FluidIdRegistryMessageHandler
-extends io.netty.channel.SimpleChannelInboundHandler<ForgeMessage.FluidIdMapMessage>
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      -
        -
      • - - -

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        -io.netty.channel.ChannelHandler.Sharable
        • -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      protected voidchannelRead0(io.netty.channel.ChannelHandlerContext ctx, - ForgeMessage.FluidIdMapMessage msg) 
      voidexceptionCaught(io.netty.channel.ChannelHandlerContext ctx, - java.lang.Throwable cause) 
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

        -acceptInboundMessage, channelRead
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        -channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        -handlerAdded, handlerRemoved, isSharable
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface io.netty.channel.ChannelHandler

        -handlerAdded, handlerRemoved
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        FluidIdRegistryMessageHandler

        -
        public FluidIdRegistryMessageHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        channelRead0

        -
        protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
-                ForgeMessage.FluidIdMapMessage msg)
-                     throws java.lang.Exception
        -
        -
        Specified by:
        -
        channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<ForgeMessage.FluidIdMapMessage>
        -
        Throws:
        -
        java.lang.Exception
        -
        • -
      - - - -
        -
      • -

        exceptionCaught

        -
        public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
-                   java.lang.Throwable cause)
-                     throws java.lang.Exception
        -
        -
        Specified by:
        -
        exceptionCaught in interface io.netty.channel.ChannelHandler
        -
        Specified by:
        -
        exceptionCaught in interface io.netty.channel.ChannelInboundHandler
        -
        Overrides:
        -
        exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter
        -
        Throws:
        -
        java.lang.Exception
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html deleted file mode 100644 index 2e63a43..0000000 --- a/javadoc/net/minecraftforge/common/network/ForgeMessage.DimensionRegisterMessage.html +++ /dev/null @@ -1,264 +0,0 @@ - - - - - -ForgeMessage.DimensionRegisterMessage (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common.network
-

Class ForgeMessage.DimensionRegisterMessage

-
-
- -
-
    -
  • -
    -
    Enclosing class:
    -
    ForgeMessage
    -
    -
    -
    -
    public static class ForgeMessage.DimensionRegisterMessage
-extends ForgeMessage
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ForgeMessage.DimensionRegisterMessage

        -
        public ForgeMessage.DimensionRegisterMessage()
        -
        • -
      - - - -
        -
      • -

        ForgeMessage.DimensionRegisterMessage

        -
        public ForgeMessage.DimensionRegisterMessage(int dimensionId,
-                                     int providerId)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html deleted file mode 100644 index 30e89b3..0000000 --- a/javadoc/net/minecraftforge/common/network/ForgeMessage.FluidIdMapMessage.html +++ /dev/null @@ -1,250 +0,0 @@ - - - - - -ForgeMessage.FluidIdMapMessage (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common.network
-

Class ForgeMessage.FluidIdMapMessage

-
-
- -
-
    -
  • -
    -
    Enclosing class:
    -
    ForgeMessage
    -
    -
    -
    -
    public static class ForgeMessage.FluidIdMapMessage
-extends ForgeMessage
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ForgeMessage.FluidIdMapMessage

        -
        public ForgeMessage.FluidIdMapMessage()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/ForgeMessage.html b/javadoc/net/minecraftforge/common/network/ForgeMessage.html deleted file mode 100644 index 279d7d7..0000000 --- a/javadoc/net/minecraftforge/common/network/ForgeMessage.html +++ /dev/null @@ -1,253 +0,0 @@ - - - - - -ForgeMessage (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common.network
-

Class ForgeMessage

-
-
- -
- -
-
-
    -
  • - - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      ForgeMessage() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        ForgeMessage

        -
        public ForgeMessage()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html b/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html deleted file mode 100644 index 57d9047..0000000 --- a/javadoc/net/minecraftforge/common/network/ForgeNetworkHandler.html +++ /dev/null @@ -1,256 +0,0 @@ - - - - - -ForgeNetworkHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.network
-

Class ForgeNetworkHandler

-
-
- -
-
    -
  • -
    -
    -
    public class ForgeNetworkHandler
-extends java.lang.Object
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static voidregisterChannel(ForgeModContainer forgeModContainer, - Side side) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        ForgeNetworkHandler

        -
        public ForgeNetworkHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        registerChannel

        -
        public static void registerChannel(ForgeModContainer forgeModContainer,
-                   Side side)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html b/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html deleted file mode 100644 index 2561969..0000000 --- a/javadoc/net/minecraftforge/common/network/ForgeRuntimeCodec.html +++ /dev/null @@ -1,386 +0,0 @@ - - - - - -ForgeRuntimeCodec (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.network
-

Class ForgeRuntimeCodec

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler
    -
    -
    -
    -
    public class ForgeRuntimeCodec
-extends FMLIndexedMessageToMessageCodec<ForgeMessage>
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      -
        -
      • - - -

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        -io.netty.channel.ChannelHandler.Sharable
        • -
      -
      • -
    - - - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      ForgeRuntimeCodec() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voiddecodeInto(io.netty.channel.ChannelHandlerContext ctx, - io.netty.buffer.ByteBuf source, - ForgeMessage msg) 
      voidencodeInto(io.netty.channel.ChannelHandlerContext ctx, - ForgeMessage msg, - io.netty.buffer.ByteBuf target) 
      - -
        -
      • - - -

        Methods inherited from class io.netty.handler.codec.MessageToMessageCodec

        -acceptInboundMessage, acceptOutboundMessage, channelRead, write
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelDuplexHandler

        -bind, close, connect, deregister, disconnect, flush, read
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        -channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        -handlerRemoved, isSharable
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface io.netty.channel.ChannelHandler

        -handlerRemoved
        • -
      -
      • -
    -
    • -
-
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html b/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html deleted file mode 100644 index 1e680ad..0000000 --- a/javadoc/net/minecraftforge/common/network/ServerToClientConnectionEstablishedHandler.html +++ /dev/null @@ -1,314 +0,0 @@ - - - - - -ServerToClientConnectionEstablishedHandler (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.network
-

Class ServerToClientConnectionEstablishedHandler

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    -
    -
    -
    -
    public class ServerToClientConnectionEstablishedHandler
-extends io.netty.channel.ChannelInboundHandlerAdapter
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      -
        -
      • - - -

        Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        -io.netty.channel.ChannelHandler.Sharable
        • -
      -
      • -
    - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      voiduserEventTriggered(io.netty.channel.ChannelHandlerContext ctx, - java.lang.Object evt) 
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

        -channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
        • -
      -
        -
      • - - -

        Methods inherited from class io.netty.channel.ChannelHandlerAdapter

        -handlerAdded, handlerRemoved, isSharable
        • -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

        Methods inherited from interface io.netty.channel.ChannelHandler

        -handlerAdded, handlerRemoved
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        ServerToClientConnectionEstablishedHandler

        -
        public ServerToClientConnectionEstablishedHandler()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        userEventTriggered

        -
        public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
-                      java.lang.Object evt)
-                        throws java.lang.Exception
        -
        -
        Specified by:
        -
        userEventTriggered in interface io.netty.channel.ChannelInboundHandler
        -
        Overrides:
        -
        userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter
        -
        Throws:
        -
        java.lang.Exception
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/network/package-frame.html b/javadoc/net/minecraftforge/common/network/package-frame.html deleted file mode 100644 index da935c4..0000000 --- a/javadoc/net/minecraftforge/common/network/package-frame.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - - -net.minecraftforge.common.network (Forge API) - - - - -

net.minecraftforge.common.network

-
-

Classes

- -
- - diff --git a/javadoc/net/minecraftforge/common/network/package-summary.html b/javadoc/net/minecraftforge/common/network/package-summary.html deleted file mode 100644 index 9e251ff..0000000 --- a/javadoc/net/minecraftforge/common/network/package-summary.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - -net.minecraftforge.common.network (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Package net.minecraftforge.common.network

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

Hierarchy For Package net.minecraftforge.common.network

-Package Hierarchies: - -
-
-

Class Hierarchy

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

net.minecraftforge.common

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/javadoc/net/minecraftforge/common/package-summary.html b/javadoc/net/minecraftforge/common/package-summary.html deleted file mode 100644 index bf0f415..0000000 --- a/javadoc/net/minecraftforge/common/package-summary.html +++ /dev/null @@ -1,308 +0,0 @@ - - - - - -net.minecraftforge.common (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Package net.minecraftforge.common

-
-
- -
- -
- - - - - -
-
- - - -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/package-tree.html b/javadoc/net/minecraftforge/common/package-tree.html deleted file mode 100644 index 830d987..0000000 --- a/javadoc/net/minecraftforge/common/package-tree.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - -net.minecraftforge.common Class Hierarchy (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package net.minecraftforge.common

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

- -
- -
- - - - - -
-
- - - -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html deleted file mode 100644 index d3e4c49..0000000 --- a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.CallBackProvider.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - - -AsynchronousExecutor.CallBackProvider (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common.util
-

Interface AsynchronousExecutor.CallBackProvider<P,T,C,E extends java.lang.Throwable>

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    java.util.concurrent.ThreadFactory
    -
    -
    -
    Enclosing class:
    -
    AsynchronousExecutor<P,T,C,E extends java.lang.Throwable>
    -
    -
    -
    -
    public static interface AsynchronousExecutor.CallBackProvider<P,T,C,E extends java.lang.Throwable>
-extends java.util.concurrent.ThreadFactory
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      TcallStage1(P parameter) -
      Normally an asynchronous call, but can be synchronous
      -
      voidcallStage2(P parameter, - T object) -
      Synchronous call
      -
      voidcallStage3(P parameter, - T object, - C callback) -
      Synchronous call, called multiple times, once per registered callback
      -
      -
        -
      • - - -

        Methods inherited from interface java.util.concurrent.ThreadFactory

        -newThread
        • -
      -
      • -
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - - - -
        -
      • -

        callStage1

        -
        T callStage1(P parameter)
-             throws E extends java.lang.Throwable
        -
        Normally an asynchronous call, but can be synchronous
        -
        Parameters:
        parameter - parameter object provided
        -
        Returns:
        the created object
        -
        Throws:
        -
        E extends java.lang.Throwable
        -
        • -
      - - - - - -
        -
      • -

        callStage2

        -
        void callStage2(P parameter,
-              T object)
-                throws E extends java.lang.Throwable
        -
        Synchronous call
        -
        Parameters:
        parameter - parameter object provided
        object - the previously created object
        -
        Throws:
        -
        E extends java.lang.Throwable
        -
        • -
      - - - - - -
        -
      • -

        callStage3

        -
        void callStage3(P parameter,
-              T object,
-              C callback)
-                throws E extends java.lang.Throwable
        -
        Synchronous call, called multiple times, once per registered callback
        -
        Parameters:
        parameter - parameter object provided
        object - the previously created object
        callback - the current callback to execute
        -
        Throws:
        -
        E extends java.lang.Throwable
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html b/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html deleted file mode 100644 index 98f08a3..0000000 --- a/javadoc/net/minecraftforge/common/util/AsynchronousExecutor.html +++ /dev/null @@ -1,474 +0,0 @@ - - - - - -AsynchronousExecutor (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.util
-

Class AsynchronousExecutor<P,T,C,E extends java.lang.Throwable>

-
-
- -
-
    -
  • -
    Type Parameters:
    P - The type of parameter you provide to make the object that will be created. It should implement Object.hashCode() and Object.equals(Object) if you want to get the value early.
    T - The type of object you provide. This is created in stage 1, and passed to stage 2, 3, and returned if get() is called.
    C - The type of callback you provide. You may register many of these to be passed to the provider in stage 3, one at a time.
    E - A type of exception you may throw and expect to be handled by the main thread
    -
    -
    -
    public final class AsynchronousExecutor<P,T,C,E extends java.lang.Throwable>
-extends java.lang.Object
    -
    Executes tasks using a multi-stage process executor. Synchronous executions are via finishActive() or the get(Object) methods. -
  • Stage 1 creates the object from a parameter, and is usually called asynchronously. -
  • Stage 2 takes the parameter and object from stage 1 and does any synchronous processing to prepare it. -
  • Stage 3 takes the parameter and object from stage 1, as well as a callback that was registered, and performs any synchronous calculations.
- - -
-
- -
-
- -
- - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/BlockSnapshot.html b/javadoc/net/minecraftforge/common/util/BlockSnapshot.html deleted file mode 100644 index df83bce..0000000 --- a/javadoc/net/minecraftforge/common/util/BlockSnapshot.html +++ /dev/null @@ -1,697 +0,0 @@ - - - - - -BlockSnapshot (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.util
-

Class BlockSnapshot

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class BlockSnapshot
-extends java.lang.Object
-implements java.io.Serializable
    -
    Represents a captured snapshot of a block which will not change - automatically. -

    - Unlike Block, which only one object can exist per coordinate, BlockSnapshot - can exist multiple times for any given Block.

    -
    See Also:
    Serialized Form
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Field Detail

      - - - -
        -
      • -

        x

        -
        public final int x
        -
        • -
      - - - -
        -
      • -

        y

        -
        public final int y
        -
        • -
      - - - -
        -
      • -

        z

        -
        public final int z
        -
        • -
      - - - -
        -
      • -

        dimId

        -
        public final int dimId
        -
        • -
      - - - -
        -
      • -

        replacedBlock

        -
        public transient Block replacedBlock
        -
        • -
      - - - -
        -
      • -

        meta

        -
        public final int meta
        -
        • -
      - - - -
        -
      • -

        flag

        -
        public int flag
        -
        • -
      - - - -
        -
      • -

        world

        -
        public transient World world
        -
        • -
      - - - - -
      • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        BlockSnapshot

        -
        public BlockSnapshot(World world,
-             int x,
-             int y,
-             int z,
-             Block block,
-             int meta)
        -
        • -
      - - - -
        -
      • -

        BlockSnapshot

        -
        public BlockSnapshot(World world,
-             int x,
-             int y,
-             int z,
-             Block block,
-             int meta,
-             NBTTagCompound nbt)
        -
        • -
      - - - -
        -
      • -

        BlockSnapshot

        -
        public BlockSnapshot(World world,
-             int x,
-             int y,
-             int z,
-             Block block,
-             int meta,
-             int flag)
        -
        • -
      - - - -
        -
      • -

        BlockSnapshot

        -
        public BlockSnapshot(int dimension,
-             int x,
-             int y,
-             int z,
-             java.lang.String modid,
-             java.lang.String blockName,
-             int meta,
-             int flag,
-             NBTTagCompound nbt)
        -
        Raw constructor designed for serialization usages.
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getBlockSnapshot

        -
        public static BlockSnapshot getBlockSnapshot(World world,
-                             int x,
-                             int y,
-                             int z)
        -
        • -
      - - - -
        -
      • -

        getBlockSnapshot

        -
        public static BlockSnapshot getBlockSnapshot(World world,
-                             int x,
-                             int y,
-                             int z,
-                             int flag)
        -
        • -
      - - - - - - - -
        -
      • -

        getCurrentBlock

        -
        public Block getCurrentBlock()
        -
        • -
      - - - -
        -
      • -

        getWorld

        -
        public World getWorld()
        -
        • -
      - - - -
        -
      • -

        getReplacedBlock

        -
        public Block getReplacedBlock()
        -
        • -
      - - - -
        -
      • -

        getTileEntity

        -
        public TileEntity getTileEntity()
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public boolean restore()
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public boolean restore(boolean force)
        -
        • -
      - - - -
        -
      • -

        restore

        -
        public boolean restore(boolean force,
-              boolean applyPhysics)
        -
        • -
      - - - -
        -
      • -

        restoreToLocation

        -
        public boolean restoreToLocation(World world,
-                        int x,
-                        int y,
-                        int z,
-                        boolean force,
-                        boolean applyPhysics)
        -
        • -
      - - - -
        -
      • -

        writeToNBT

        -
        public void writeToNBT(NBTTagCompound compound)
        -
        • -
      - - - -
        -
      • -

        equals

        -
        public boolean equals(java.lang.Object obj)
        -
        -
        Overrides:
        -
        equals in class java.lang.Object
        -
        -
        • -
      - - - -
        -
      • -

        hashCode

        -
        public int hashCode()
        -
        -
        Overrides:
        -
        hashCode in class java.lang.Object
        -
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html b/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html deleted file mode 100644 index 8ff601c..0000000 --- a/javadoc/net/minecraftforge/common/util/ChunkCoordComparator.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - - -ChunkCoordComparator (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.util
-

Class ChunkCoordComparator

-
-
- -
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.util.Comparator<ChunkCoordIntPair>
    -
    -
    -
    -
    public class ChunkCoordComparator
-extends java.lang.Object
-implements java.util.Comparator<ChunkCoordIntPair>
    -
    • -
-
-
-
    -
  • - - - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      intcompare(ChunkCoordIntPair a, - ChunkCoordIntPair b) 
      -
        -
      • - - -

        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
        • -
      -
      • -
    -
    • -
-
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/Constants.NBT.html b/javadoc/net/minecraftforge/common/util/Constants.NBT.html deleted file mode 100644 index 4cc53fa..0000000 --- a/javadoc/net/minecraftforge/common/util/Constants.NBT.html +++ /dev/null @@ -1,439 +0,0 @@ - - - - - -Constants.NBT (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.util
-

Class Constants.NBT

-
-
- -
-
    -
  • -
    -
    Enclosing class:
    -
    Constants
    -
    -
    -
    -
    public static class Constants.NBT
-extends java.lang.Object
    -
    NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, - table used in NBTBase.func_150283_g - - Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)
    -
    • -
-
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/Constants.html b/javadoc/net/minecraftforge/common/util/Constants.html deleted file mode 100644 index e1a8cc9..0000000 --- a/javadoc/net/minecraftforge/common/util/Constants.html +++ /dev/null @@ -1,252 +0,0 @@ - - - - - -Constants (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - -
-
net.minecraftforge.common.util
-

Class Constants

-
-
- -
-
    -
  • -
    -
    -
    public class Constants
-extends java.lang.Object
    -
    A class containing constants for magic numbers used in the minecraft codebase. - Everything here should be checked each update, and have a comment relating to where to check it.
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Nested Class Summary

      - - - - - - - - - - -
      Nested Classes 
      Modifier and TypeClass and Description
      static class Constants.NBT -
      NBT Tag type IDS, used when storing the nbt to disc, Should align with NBTBase.getId, - table used in NBTBase.func_150283_g - - Main use is checking tag type in NBTTagCompound.func_150297_b(String, int)
      -
      -
      • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      Constants() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        Constants

        -
        public Constants()
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- -
    -
  • Detail: 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
-
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/EnumHelper.html b/javadoc/net/minecraftforge/common/util/EnumHelper.html deleted file mode 100644 index dff6c7b..0000000 --- a/javadoc/net/minecraftforge/common/util/EnumHelper.html +++ /dev/null @@ -1,544 +0,0 @@ - - - - - -EnumHelper (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.util
-

Class EnumHelper

-
-
- -
-
    -
  • -
    -
    Direct Known Subclasses:
    -
    EnumHelperClient
    -
    -
    -
    -
    public class EnumHelper
-extends java.lang.Object
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        EnumHelper

        -
        public EnumHelper()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        addAction

        -
        public static EnumAction addAction(java.lang.String name)
        -
        • -
      - - - -
        -
      • -

        addArmorMaterial

        -
        public static ItemArmor.ArmorMaterial addArmorMaterial(java.lang.String name,
-                                       int durability,
-                                       int[] reductionAmounts,
-                                       int enchantability)
        -
        • -
      - - - -
        -
      • -

        addArt

        -
        public static EntityPainting.EnumArt addArt(java.lang.String name,
-                            java.lang.String tile,
-                            int sizeX,
-                            int sizeY,
-                            int offsetX,
-                            int offsetY)
        -
        • -
      - - - -
        -
      • -

        addCreatureAttribute

        -
        public static EnumCreatureAttribute addCreatureAttribute(java.lang.String name)
        -
        • -
      - - - -
        -
      • -

        addCreatureType

        -
        public static EnumCreatureType addCreatureType(java.lang.String name,
-                               java.lang.Class typeClass,
-                               int maxNumber,
-                               Material material,
-                               boolean peaceful,
-                               boolean animal)
        -
        • -
      - - - - - - - -
        -
      • -

        addEnchantmentType

        -
        public static EnumEnchantmentType addEnchantmentType(java.lang.String name)
        -
        • -
      - - - - - - - - - - - - - - - -
        -
      • -

        addSkyBlock

        -
        public static EnumSkyBlock addSkyBlock(java.lang.String name,
-                       int lightValue)
        -
        • -
      - - - - - - - -
        -
      • -

        addToolMaterial

        -
        public static Item.ToolMaterial addToolMaterial(java.lang.String name,
-                                int harvestLevel,
-                                int maxUses,
-                                float efficiency,
-                                float damage,
-                                int enchantability)
        -
        • -
      - - - -
        -
      • -

        addRarity

        -
        public static EnumRarity addRarity(java.lang.String name,
-                   EnumChatFormatting color,
-                   java.lang.String displayName)
        -
        • -
      - - - -
        -
      • -

        setFailsafeFieldValue

        -
        public static void setFailsafeFieldValue(java.lang.reflect.Field field,
-                         java.lang.Object target,
-                         java.lang.Object value)
-                                  throws java.lang.Exception
        -
        Throws:
        -
        java.lang.Exception
        -
        • -
      - - - -
        -
      • -

        addEnum

        -
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType,
-                                      java.lang.String enumName,
-                                      java.lang.Object... paramValues)
        -
        • -
      - - - -
        -
      • -

        addEnum

        -
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class[][] map,
-                                      java.lang.Class<T> enumType,
-                                      java.lang.String enumName,
-                                      java.lang.Object... paramValues)
        -
        • -
      - - - -
        -
      • -

        addEnum

        -
        public static <T extends java.lang.Enum<?>> T addEnum(java.lang.Class<T> enumType,
-                                      java.lang.String enumName,
-                                      java.lang.Class<?>[] paramTypes,
-                                      java.lang.Object[] paramValues)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/FakePlayer.html b/javadoc/net/minecraftforge/common/util/FakePlayer.html deleted file mode 100644 index e9da208..0000000 --- a/javadoc/net/minecraftforge/common/util/FakePlayer.html +++ /dev/null @@ -1,558 +0,0 @@ - - - - - -FakePlayer (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.util
-

Class FakePlayer

-
-
- -
- -
-
- -
-
- -
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html b/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html deleted file mode 100644 index aa30560..0000000 --- a/javadoc/net/minecraftforge/common/util/FakePlayerFactory.html +++ /dev/null @@ -1,289 +0,0 @@ - - - - - -FakePlayerFactory (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.util
-

Class FakePlayerFactory

-
-
- -
-
    -
  • -
    -
    -
    public class FakePlayerFactory
-extends java.lang.Object
    -
    • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      FakePlayerFactory() 
      -
      • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static FakePlayerget(WorldServer world, - com.mojang.authlib.GameProfile username) -
      Get a fake player with a given username, - Mods should either hold weak references to the return value, or listen for a - WorldEvent.Unload and kill all references to prevent worlds staying in memory.
      -
      static FakePlayergetMinecraft(WorldServer world) 
      static voidunloadWorld(WorldServer world) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        FakePlayerFactory

        -
        public FakePlayerFactory()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - - - - - -
        -
      • -

        get

        -
        public static FakePlayer get(WorldServer world,
-             com.mojang.authlib.GameProfile username)
        -
        Get a fake player with a given username, - Mods should either hold weak references to the return value, or listen for a - WorldEvent.Unload and kill all references to prevent worlds staying in memory.
        -
        • -
      - - - -
        -
      • -

        unloadWorld

        -
        public static void unloadWorld(WorldServer world)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/ForgeDirection.html b/javadoc/net/minecraftforge/common/util/ForgeDirection.html deleted file mode 100644 index 80c84b4..0000000 --- a/javadoc/net/minecraftforge/common/util/ForgeDirection.html +++ /dev/null @@ -1,551 +0,0 @@ - - - - - -ForgeDirection (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - -
-
net.minecraftforge.common.util
-

Enum ForgeDirection

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

      Field Detail

      - - - -
        -
      • -

        offsetX

        -
        public final int offsetX
        -
        • -
      - - - -
        -
      • -

        offsetY

        -
        public final int offsetY
        -
        • -
      - - - -
        -
      • -

        offsetZ

        -
        public final int offsetZ
        -
        • -
      - - - -
        -
      • -

        flag

        -
        public final int flag
        -
        • -
      - - - -
        -
      • -

        VALID_DIRECTIONS

        -
        public static final ForgeDirection[] VALID_DIRECTIONS
        -
        • -
      - - - -
        -
      • -

        OPPOSITES

        -
        public static final int[] OPPOSITES
        -
        • -
      - - - -
        -
      • -

        ROTATION_MATRIX

        -
        public static final int[][] ROTATION_MATRIX
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        values

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

        valueOf

        -
        public static ForgeDirection 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
        -
        • -
      - - - -
        -
      • -

        getOrientation

        -
        public static ForgeDirection getOrientation(int id)
        -
        • -
      - - - - - - - - -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
- - -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/RotationHelper.html b/javadoc/net/minecraftforge/common/util/RotationHelper.html deleted file mode 100644 index 2676874..0000000 --- a/javadoc/net/minecraftforge/common/util/RotationHelper.html +++ /dev/null @@ -1,279 +0,0 @@ - - - - - -RotationHelper (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - -
-
net.minecraftforge.common.util
-

Class RotationHelper

-
-
- -
-
    -
  • -
    -
    -
    public class RotationHelper
-extends java.lang.Object
    -
    This class is a helper function for vanilla blocks, and should not be called by Modders. - Refer to block.rotateBlock and block.getValidRotations instead.
    -
    • -
-
-
- -
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        RotationHelper

        -
        public RotationHelper()
        -
        • -
      -
      • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getValidVanillaBlockRotations

        -
        public static ForgeDirection[] getValidVanillaBlockRotations(Block block)
        -
        • -
      - - - -
        -
      • -

        rotateVanillaBlock

        -
        public static boolean rotateVanillaBlock(Block block,
-                         World worldObj,
-                         int x,
-                         int y,
-                         int z,
-                         ForgeDirection axis)
        -
        • -
      -
      • -
    -
    • -
-
-
- - -
- - - - - -
-
- - - -
- -
-
-
    -
  • Summary: 
    • -
  • Nested | 
    • -
  • Field | 
    • -
  • Constr | 
    • -
  • Method
    • -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/package-frame.html b/javadoc/net/minecraftforge/common/util/package-frame.html deleted file mode 100644 index 02ed6d9..0000000 --- a/javadoc/net/minecraftforge/common/util/package-frame.html +++ /dev/null @@ -1,35 +0,0 @@ - - - - - -net.minecraftforge.common.util (Forge API) - - - - -

net.minecraftforge.common.util

-
-

Interfaces

- -

Classes

- -

Enums

- -
- - diff --git a/javadoc/net/minecraftforge/common/util/package-summary.html b/javadoc/net/minecraftforge/common/util/package-summary.html deleted file mode 100644 index 4f8ebac..0000000 --- a/javadoc/net/minecraftforge/common/util/package-summary.html +++ /dev/null @@ -1,207 +0,0 @@ - - - - - -net.minecraftforge.common.util (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Package net.minecraftforge.common.util

-
-
- -
- -
- - - - - -
-
- - - -
- -
- - -
- - - diff --git a/javadoc/net/minecraftforge/common/util/package-tree.html b/javadoc/net/minecraftforge/common/util/package-tree.html deleted file mode 100644 index a714776..0000000 --- a/javadoc/net/minecraftforge/common/util/package-tree.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - -net.minecraftforge.common.util Class Hierarchy (Forge API) - - - - - - - -
- - - - - -
-
- - - -
- -
- - -
- -
-

Hierarchy For Package net.minecraftforge.common.util

-Package Hierarchies: - -
-
-

Class Hierarchy

- -

Interface Hierarchy

- -

Enum Hierarchy

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