From 0427ab89f1753a44b30cbc35ce021cbbdc845109 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:52:45 +0300 Subject: fix missing source folder --- javadoc/cpw/mods/fml/common/FMLCommonHandler.html | 1096 +++++++++++++++++++++ 1 file changed, 1096 insertions(+) create mode 100644 javadoc/cpw/mods/fml/common/FMLCommonHandler.html (limited to 'javadoc/cpw/mods/fml/common/FMLCommonHandler.html') diff --git a/javadoc/cpw/mods/fml/common/FMLCommonHandler.html b/javadoc/cpw/mods/fml/common/FMLCommonHandler.html new file mode 100644 index 0000000..79752d1 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/FMLCommonHandler.html @@ -0,0 +1,1096 @@ + + + + + +FMLCommonHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
cpw.mods.fml.common
+

Class FMLCommonHandler

+
+
+ +
+
    +
  • +
    +
    +
    public class FMLCommonHandler
+extends java.lang.Object
    +
    The main class for non-obfuscated hook handling code + + Anything that doesn't require obfuscated or client/server specific code should + go in this handler + + It also contains a reference to the sided handler instance that is valid + allowing for common code to access specific properties from the obfuscated world + without a direct dependency
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FMLCommonHandler

        +
        public FMLCommonHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        bus

        +
        public EventBus bus()
        +
        The FML event bus. Subscribe here for FML related events
        +
        Returns:
        the event bus
        +
        • +
      + + + + + + + +
        +
      • +

        instance

        +
        public static FMLCommonHandler instance()
        +
        Returns:
        the instance
        +
        • +
      + + + +
        +
      • +

        findContainerFor

        +
        public ModContainer findContainerFor(java.lang.Object mod)
        +
        Find the container that associates with the supplied mod object
        +
        Parameters:
        mod -
        +
        • +
      + + + +
        +
      • +

        getFMLLogger

        +
        public org.apache.logging.log4j.Logger getFMLLogger()
        +
        Get the forge mod loader logging instance (goes to the forgemodloader log file)
        +
        Returns:
        The log instance for the FML log file
        +
        • +
      + + + +
        +
      • +

        getSide

        +
        public Side getSide()
        +
        • +
      + + + +
        +
      • +

        getEffectiveSide

        +
        public Side getEffectiveSide()
        +
        Return the effective side for the context in the game. This is dependent + on thread analysis to try and determine whether the code is running in the + server or not. Use at your own risk
        +
        • +
      + + + +
        +
      • +

        raiseException

        +
        public void raiseException(java.lang.Throwable exception,
+                  java.lang.String message,
+                  boolean stopGame)
        +
        Raise an exception
        +
        • +
      + + + +
        +
      • +

        computeBranding

        +
        public void computeBranding()
        +
        • +
      + + + +
        +
      • +

        getBrandings

        +
        public java.util.List<java.lang.String> getBrandings(boolean includeMC)
        +
        • +
      + + + + + + + +
        +
      • +

        onPostServerTick

        +
        public void onPostServerTick()
        +
        • +
      + + + +
        +
      • +

        onPostWorldTick

        +
        public void onPostWorldTick(World world)
        +
        Every tick just after world and other ticks occur
        +
        • +
      + + + +
        +
      • +

        onPreServerTick

        +
        public void onPreServerTick()
        +
        • +
      + + + +
        +
      • +

        onPreWorldTick

        +
        public void onPreWorldTick(World world)
        +
        Every tick just before world and other ticks occur
        +
        • +
      + + + +
        +
      • +

        handleServerAboutToStart

        +
        public boolean handleServerAboutToStart(MinecraftServer server)
        +
        • +
      + + + +
        +
      • +

        handleServerStarting

        +
        public boolean handleServerStarting(MinecraftServer server)
        +
        • +
      + + + +
        +
      • +

        handleServerStarted

        +
        public void handleServerStarted()
        +
        • +
      + + + +
        +
      • +

        handleServerStopping

        +
        public void handleServerStopping()
        +
        • +
      + + + +
        +
      • +

        getSavesDirectory

        +
        public java.io.File getSavesDirectory()
        +
        • +
      + + + +
        +
      • +

        getMinecraftServerInstance

        +
        public MinecraftServer getMinecraftServerInstance()
        +
        • +
      + + + +
        +
      • +

        showGuiScreen

        +
        public void showGuiScreen(java.lang.Object clientGuiElement)
        +
        • +
      + + + +
        +
      • +

        queryUser

        +
        public void queryUser(StartupQuery query)
+               throws java.lang.InterruptedException
        +
        Throws:
        +
        java.lang.InterruptedException
        +
        • +
      + + + +
        +
      • +

        onServerStart

        +
        public void onServerStart(MinecraftServer dedicatedServer)
        +
        • +
      + + + +
        +
      • +

        onServerStarted

        +
        public void onServerStarted()
        +
        • +
      + + + +
        +
      • +

        onPreClientTick

        +
        public void onPreClientTick()
        +
        • +
      + + + +
        +
      • +

        onPostClientTick

        +
        public void onPostClientTick()
        +
        • +
      + + + +
        +
      • +

        onRenderTickStart

        +
        public void onRenderTickStart(float timer)
        +
        • +
      + + + +
        +
      • +

        onRenderTickEnd

        +
        public void onRenderTickEnd(float timer)
        +
        • +
      + + + +
        +
      • +

        onPlayerPreTick

        +
        public void onPlayerPreTick(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        onPlayerPostTick

        +
        public void onPlayerPostTick(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        registerCrashCallable

        +
        public void registerCrashCallable(ICrashCallable callable)
        +
        • +
      + + + + + + + + + + + + + + + +
        +
      • +

        confirmBackupLevelDatUse

        +
        public void confirmBackupLevelDatUse(SaveHandler handler)
        +
        • +
      + + + +
        +
      • +

        shouldServerBeKilledQuietly

        +
        public boolean shouldServerBeKilledQuietly()
        +
        • +
      + + + +
        +
      • +

        expectServerStopped

        +
        public void expectServerStopped()
        +
        Make handleExit() wait for handleServerStopped(). + + For internal use only!
        +
        • +
      + + + +
        +
      • +

        handleExit

        +
        public void handleExit(int retVal)
        +
        Delayed System.exit() until the server is actually stopped/done saving. + + For internal use only!
        +
        Parameters:
        retVal - Exit code for System.exit()
        +
        • +
      + + + +
        +
      • +

        handleServerStopped

        +
        public void handleServerStopped()
        +
        • +
      + + + +
        +
      • +

        getModName

        +
        public java.lang.String getModName()
        +
        • +
      + + + +
        +
      • +

        addModToResourcePack

        +
        public void addModToResourcePack(ModContainer container)
        +
        • +
      + + + +
        +
      • +

        getCurrentLanguage

        +
        public java.lang.String getCurrentLanguage()
        +
        • +
      + + + +
        +
      • +

        bootstrap

        +
        public void bootstrap()
        +
        • +
      + + + +
        +
      • +

        getClientToServerNetworkManager

        +
        public NetworkManager getClientToServerNetworkManager()
        +
        • +
      + + + +
        +
      • +

        fireMouseInput

        +
        public void fireMouseInput()
        +
        • +
      + + + +
        +
      • +

        fireKeyInput

        +
        public void fireKeyInput()
        +
        • +
      + + + +
        +
      • +

        firePlayerChangedDimensionEvent

        +
        public void firePlayerChangedDimensionEvent(EntityPlayer player,
+                                   int fromDim,
+                                   int toDim)
        +
        • +
      + + + +
        +
      • +

        firePlayerLoggedIn

        +
        public void firePlayerLoggedIn(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        firePlayerLoggedOut

        +
        public void firePlayerLoggedOut(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        firePlayerRespawnEvent

        +
        public void firePlayerRespawnEvent(EntityPlayer player)
        +
        • +
      + + + +
        +
      • +

        firePlayerItemPickupEvent

        +
        public void firePlayerItemPickupEvent(EntityPlayer player,
+                             EntityItem item)
        +
        • +
      + + + + + + + +
        +
      • +

        firePlayerSmeltedEvent

        +
        public void firePlayerSmeltedEvent(EntityPlayer player,
+                          ItemStack smelted)
        +
        • +
      + + + +
        +
      • +

        getClientPlayHandler

        +
        public INetHandler getClientPlayHandler()
        +
        • +
      + + + +
        +
      • +

        waitForPlayClient

        +
        public void waitForPlayClient()
        +
        • +
      + + + +
        +
      • +

        fireNetRegistrationEvent

        +
        public void fireNetRegistrationEvent(NetworkManager manager,
+                            java.util.Set<java.lang.String> channelSet,
+                            java.lang.String channel,
+                            Side side)
        +
        • +
      + + + +
        +
      • +

        shouldAllowPlayerLogins

        +
        public boolean shouldAllowPlayerLogins()
        +
        • +
      + + + +
        +
      • +

        exitJava

        +
        public void exitJava(int exitCode,
+            boolean hardExit)
        +
        Used to exit from java, with system exit preventions in place. Will be tidy about it and just log a message, + unless debugging is enabled
        +
        Parameters:
        exitCode - The exit code
        hardExit - Perform a halt instead of an exit (only use when the world is unsavable) - read the warnings at Runtime.halt(int)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + -- cgit v1.2.3