Interface UkulibAPI

public interface UkulibAPI
This interface is used to integrate your mod with Ukulib.

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    enableModMenuIntegration()
    This method is used to enable or disable the integration with Mod Menu.
    default Map<String, UnaryOperator<net.minecraft.client.gui.screens.Screen>>
    getProvidedConfigScreens()
    The map of the config screens, linked to their mod id.
    default UnaryOperator<net.minecraft.client.gui.screens.Screen>
    supplyConfigScreen()
    This method is used to show your mod's config screen in the Ukulib config screen.

  • Method Details

    • supplyConfigScreen

      default UnaryOperator<net.minecraft.client.gui.screens.Screen> supplyConfigScreen()
      This method is used to show your mod's config screen in the Ukulib config screen. The lambda parameter is the parent screen.
      Returns:
      A function that takes a parent screen and returns a config screen.

    • enableModMenuIntegration

      default boolean enableModMenuIntegration()
      This method is used to enable or disable the integration with Mod Menu.
      Returns:
      Whether to enable the integration with Mod Menu.

    • getProvidedConfigScreens

      default Map<String, UnaryOperator<net.minecraft.client.gui.screens.Screen>> getProvidedConfigScreens()
      The map of the config screens, linked to their mod id.
      Returns:
      the map