Class ClientUI


  • @Singleton
    public class ClientUI
    extends java.lang.Object
    Client UI.
    • Field Detail

      • ICON

        public static final java.awt.image.BufferedImage ICON
    • Method Detail

      • onGameStateChanged

        @Subscribe
        public void onGameStateChanged​(net.runelite.api.events.GameStateChanged event)
      • init

        public void init()
                  throws java.lang.Exception
        Initialize UI.
        Throws:
        java.lang.Exception
      • show

        public void show()
      • paint

        public void paint​(java.awt.Graphics graphics)
        Paint this component to target graphics
        Parameters:
        graphics - the graphics
      • getWidth

        public int getWidth()
        Gets component width.
        Returns:
        the width
      • getHeight

        public int getHeight()
        Gets component height.
        Returns:
        the height
      • isFocused

        public boolean isFocused()
        Returns true if this component has focus.
        Returns:
        true if component has focus
      • requestFocus

        public void requestFocus()
        Request focus on this component and then on client component
      • forceFocus

        public void forceFocus()
        Attempt to forcibly bring the client frame to front
      • getCurrentCursor

        public java.awt.Cursor getCurrentCursor()
        Returns current cursor set on game container
        Returns:
        awt cursor
      • getDefaultCursor

        public java.awt.Cursor getDefaultCursor()
        Returns current custom cursor or default system cursor if cursor is not set
        Returns:
        awt cursor
      • setCursor

        public void setCursor​(java.awt.image.BufferedImage image,
                              java.lang.String name)
        Changes cursor for client window. Requires $init() to be called first. FIXME: This is working properly only on Windows, Linux and Mac are displaying cursor incorrectly
        Parameters:
        image - cursor image
        name - cursor name
      • setCursor

        public void setCursor​(java.awt.Cursor cursor)
        Changes cursor for client window. Requires $init() to be called first.
        Parameters:
        cursor - awt cursor
      • getCanvasOffset

        public net.runelite.api.Point getCanvasOffset()
        Get offset of game canvas in game window
        Returns:
        game canvas offset
      • paintOverlays

        public void paintOverlays​(java.awt.Graphics2D graphics)
        Paint UI related overlays to target graphics
        Parameters:
        graphics - target graphics
      • getGraphicsConfiguration

        public java.awt.GraphicsConfiguration getGraphicsConfiguration()
      • getTrayIcon

        public java.awt.TrayIcon getTrayIcon()