Package net.neoforged.fml.loading

Interface EarlyLoadingScreenController

All Known Subinterfaces:
ImmediateWindowProvider
public interface EarlyLoadingScreenController
Interface for use by NeoForge to control the early loading screen.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    completeProgress()
    Clears all current progress in preparation for drawing a Minecraft overlay on top of the loading screen.
    static @Nullable EarlyLoadingScreenController
    current()
    Gets the current loading screen controller.
    void
    periodicTick()
    After calling taking over the main window, the game may still want to periodically ask the loading screen to update itself independently.
    long
    takeOverGlfwWindow()
    Takes over ownership of the GLFW window created by the early loading screen.
    void
    updateProgress(String label)
    Sets a label for the main progress bar on the early loading screen.

  • Method Details

    • current

      @Nullable static @Nullable EarlyLoadingScreenController current()
      Gets the current loading screen controller.

    • takeOverGlfwWindow

      long takeOverGlfwWindow()
      Takes over ownership of the GLFW window created by the early loading screen.

      This method can only be called once and once this method is called, any off-thread interaction with the window seizes.

      Returns:
      The GLFW window handle for the window in a state that can be used by the game.

    • periodicTick

      void periodicTick()
      After calling taking over the main window, the game may still want to periodically ask the loading screen to update itself independently. It will call this method to do so.

    • updateProgress

      void updateProgress(String label)
      Sets a label for the main progress bar on the early loading screen.

    • completeProgress

      void completeProgress()
      Clears all current progress in preparation for drawing a Minecraft overlay on top of the loading screen.