Package com.osrsbots.orb.api.util

Class ClientUI

  • public class ClientUI
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      ClientUI()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean addConfigPanel​(java.lang.String name, java.lang.String description, net.runelite.client.config.Config configClass)  
      static boolean addConfigPanel​(java.lang.String name, net.runelite.client.config.Config configClass)  
      static void addOverlay​(net.runelite.client.ui.overlay.Overlay overlay)  
      static void addSidePanel​(java.lang.String name, net.runelite.client.ui.PluginPanel panel)
      Add custom PluginPanel to RuneLites side toolbar, referencing a provided PluginPanel.
      static boolean applyCustomSettings​(@NotNull javax.swing.JPanel widgets)
      Applies custom "settings" to ORB's user interface, referencing a provided JPanel.
      static void drawMouse​(boolean enabled)  
      static void drawMouseTrail​(boolean enabled)  
      static void drawSubText​(java.lang.String text)
      An additional display for a String, on the game overlay, printed under the position of drawText(String text).
      static void drawSubText2​(java.lang.String text)  
      static void drawText​(java.lang.String text)
      Displays a String on the game overlay.
      static @Nullable net.runelite.client.config.Config getConfig​(java.lang.Class<? extends net.runelite.client.config.Config> clazz)  
      static void highlightEntities​(@Nullable java.lang.Object... objs)  
      static void highlightEntity​(@Nullable java.lang.Object obj)  
      static boolean isDefaultOverlayDisabled()  
      static boolean isUserInputLocked()
      Checks if user input is currently locked.
      static boolean removeConfigPanel​(java.lang.String name)  
      static void removeOverlay​(net.runelite.client.ui.overlay.Overlay overlay)  
      static void removeSidePanel()
      Removes custom PluginPanel from RuneLites side toolbar/
      static void setTargetFPS​(int fps)  
      static boolean toggleConfigPanel​(java.lang.String name, boolean open)
      Open Script's custom Config within RuneLites side toolbar
      static void toggleDefaultOverlay​(boolean enabled)  
      static void toggleLockedInputOverlay​(boolean enabled)  
      static void toggleSidePanel​(boolean open)
      Open/Close the added side panel for a relevant script.
      static void toggleUserInput​(boolean enabled)
      Toggles end-user's input, enabling or disabling it during script execution.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ClientUI

        public ClientUI()

    • Method Detail

      • toggleUserInput

        public static void toggleUserInput​(boolean enabled)
        Toggles end-user's input, enabling or disabling it during script execution. Game canvas is painted with a gray overlay when input is locked.
        Parameters:
        enabled - true to enable user input, false to disable.

      • toggleLockedInputOverlay

        public static void toggleLockedInputOverlay​(boolean enabled)

      • highlightEntity

        public static void highlightEntity​(@Nullable
                                   @Nullable java.lang.Object obj)

      • highlightEntities

        public static void highlightEntities​(@Nullable
                                     @Nullable java.lang.Object... objs)

      • isUserInputLocked

        public static boolean isUserInputLocked()
        Checks if user input is currently locked. Game canvas is painted with a gray overlay when input is locked.
        Returns:
        true if user input is locked, false otherwise.

      • drawText

        public static void drawText​(java.lang.String text)
        Displays a String on the game overlay.
        Parameters:
        text - Text to be displayed on the overlay.

      • drawSubText

        public static void drawSubText​(java.lang.String text)
        An additional display for a String, on the game overlay, printed under the position of drawText(String text).
        Parameters:
        text - Subtext to be displayed on the overlay.

      • drawSubText2

        public static void drawSubText2​(java.lang.String text)

      • applyCustomSettings

        public static boolean applyCustomSettings​(@NotNull
                                          @NotNull javax.swing.JPanel widgets)
        Applies custom "settings" to ORB's user interface, referencing a provided JPanel. Provided panel is automatically resized to width-230 x height-250.
        Parameters:
        widgets - A defined JPanel with provided components
        Returns:
        true if custom settings are applied successfully, false otherwise.

      • addSidePanel

        public static void addSidePanel​(@Nonnull
                                java.lang.String name,
                                @Nonnull
                                net.runelite.client.ui.PluginPanel panel)
        Add custom PluginPanel to RuneLites side toolbar, referencing a provided PluginPanel.
        Parameters:
        name - Name is shown when toolbar button is hovered
        panel - PluginPanel contains the components for your user interface
        See Also:
        net.runelite.client.ui.PluginPanel

      • toggleSidePanel

        public static void toggleSidePanel​(boolean open)
        Open/Close the added side panel for a relevant script.

      • removeSidePanel

        public static void removeSidePanel()
        Removes custom PluginPanel from RuneLites side toolbar/

      • addOverlay

        public static void addOverlay​(@Nonnull
                              net.runelite.client.ui.overlay.Overlay overlay)

      • removeOverlay

        public static void removeOverlay​(@Nonnull
                                 net.runelite.client.ui.overlay.Overlay overlay)

      • toggleDefaultOverlay

        public static void toggleDefaultOverlay​(boolean enabled)

      • isDefaultOverlayDisabled

        public static boolean isDefaultOverlayDisabled()

      • setTargetFPS

        public static void setTargetFPS​(int fps)

      • toggleConfigPanel

        public static boolean toggleConfigPanel​(java.lang.String name,
                                        boolean open)
        Open Script's custom Config within RuneLites side toolbar

      • addConfigPanel

        public static boolean addConfigPanel​(@Nonnull
                                     java.lang.String name,
                                     @Nonnull
                                     java.lang.String description,
                                     @Nonnull
                                     net.runelite.client.config.Config configClass)

      • addConfigPanel

        public static boolean addConfigPanel​(@Nonnull
                                     java.lang.String name,
                                     @Nonnull
                                     net.runelite.client.config.Config configClass)

      • removeConfigPanel

        public static boolean removeConfigPanel​(@Nonnull
                                        java.lang.String name)

      • getConfig

        @Nullable
public static @Nullable net.runelite.client.config.Config getConfig​(@Nonnull
                                                                    java.lang.Class<? extends net.runelite.client.config.Config> clazz)

      • drawMouse

        public static void drawMouse​(@Nonnull
                             boolean enabled)

      • drawMouseTrail

        public static void drawMouseTrail​(@Nonnull
                                  boolean enabled)