Package io.github.thecsdev.tcdcommons.api.client.gui.util

Class GuiUtils

java.lang.Object
io.github.thecsdev.tcdcommons.api.client.gui.util.GuiUtils
public final class GuiUtils extends Object

  • Method Summary

    Modifier and Type
    Method
    Description
    static net.minecraft.client.gui.tooltip.TooltipPositioner
    createDefaultTooltipPositioner(TElement target)
    Creates a TooltipPositioner with default behavior, for a given TElement.
    static @Nullable net.minecraft.client.gui.widget.ButtonWidget
    findButtonWidgetOnScreen(net.minecraft.client.gui.screen.Screen screen, net.minecraft.text.Text buttonText)
    Attempts to find and return a ButtonWidget on a Screen using the ButtonWidget's Text.
    static net.minecraft.client.gui.screen.Screen
    getCurrentScreenParent()
    Attempts to find the parent Screen of the MinecraftClient.currentScreen.
    static net.minecraft.client.gui.screen.Screen
    getParentScreen(@Nullable net.minecraft.client.gui.screen.Screen of)
    Attempts to find the parent Screen of the given Screen.
    static net.minecraft.client.gui.screen.Screen
    initScreen(net.minecraft.client.gui.screen.Screen screen)
    Re-initializes a Screen using Screen.init(MinecraftClient, int, int).
    static void
    playClickSound()
    Forked from ClickableWidget.playDownSound(SoundManager).
    Plays a GUI click sound.
    static net.minecraft.client.gui.screen.Screen
    showUrlPrompt(String url, boolean trusted)
    Shows the user a prompt screen to open a given web URL.

    MinecraftClient.currentScreen is passed at the parent screen.
    See showUrlPrompt(Screen, String, boolean).
    static net.minecraft.client.gui.screen.Screen
    showUrlPrompt(net.minecraft.client.gui.screen.Screen parent, String url, boolean trusted)
    Shows the user a prompt screen to open a given web URL.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • playClickSound

      public static void playClickSound()
      Forked from ClickableWidget.playDownSound(SoundManager).
      Plays a GUI click sound.

    • showUrlPrompt

      public static net.minecraft.client.gui.screen.Screen showUrlPrompt(String url, boolean trusted)
      Shows the user a prompt screen to open a given web URL.

      MinecraftClient.currentScreen is passed at the parent screen.
      See showUrlPrompt(Screen, String, boolean).
      Parameters:
      url - The web URL to open.
      trusted - Whether or not the given URL can be trusted.

    • showUrlPrompt

      public static net.minecraft.client.gui.screen.Screen showUrlPrompt(net.minecraft.client.gui.screen.Screen parent, String url, boolean trusted)
      Shows the user a prompt screen to open a given web URL.
      Parameters:
      parent - The currently opened screen, aka the screen that will be opened once the ConfirmLinkScreen is closed.
      url - The web URL to open.
      trusted - Whether or not the given URL can be trusted.

    • initScreen

      public static net.minecraft.client.gui.screen.Screen initScreen(net.minecraft.client.gui.screen.Screen screen) throws NullPointerException
      Re-initializes a Screen using Screen.init(MinecraftClient, int, int).
      Parameters:
      screen - The screen to re-initialize.
      Throws:
      NullPointerException - If MinecraftClient.getWindow() returns null.

    • getCurrentScreenParent

      public static net.minecraft.client.gui.screen.Screen getCurrentScreenParent()
      Attempts to find the parent Screen of the MinecraftClient.currentScreen.

    • getParentScreen

      public static net.minecraft.client.gui.screen.Screen getParentScreen(@Nullable @Nullable net.minecraft.client.gui.screen.Screen of)
      Attempts to find the parent Screen of the given Screen.

    • createDefaultTooltipPositioner

      public static net.minecraft.client.gui.tooltip.TooltipPositioner createDefaultTooltipPositioner(TElement target)
      Creates a TooltipPositioner with default behavior, for a given TElement.
      Parameters:
      target - The TElement to create the TooltipPositioner for.

    • findButtonWidgetOnScreen

      @Nullable public static @Nullable net.minecraft.client.gui.widget.ButtonWidget findButtonWidgetOnScreen(net.minecraft.client.gui.screen.Screen screen, net.minecraft.text.Text buttonText) throws NullPointerException
      Attempts to find and return a ButtonWidget on a Screen using the ButtonWidget's Text.
      Parameters:
      screen - The target Screen.
      buttonText - The Text to look for on found ButtonWidgets.
      Throws:
      NullPointerException - If an argument is null.