Package org.tribot.script.sdk

Class ScriptListening

  • public class ScriptListening
extends java.lang.Object
    Contains listeners for script events. These are scoped to the script and are removed when it ends.

    • Constructor Detail

      • ScriptListening

        public ScriptListening()

    • Method Detail

      • addBreakEndListener

        public static void addBreakEndListener​(java.lang.Runnable listener)
        Adds a listener that will run when a break ends
        Parameters:
        listener - the break end listener

      • removeBreakEndListener

        public static void removeBreakEndListener​(java.lang.Runnable listener)
        Removes a break end listener
        Parameters:
        listener - the listener to remove

      • addBreakStartListener

        public static void addBreakStartListener​(BreakStartListener listener)
        Adds a listener that will run when a break starts
        Parameters:
        listener - the break start listener

      • removeBreakStartListener

        public static void removeBreakStartListener​(BreakStartListener listener)
        Removes a break start listener
        Parameters:
        listener - the listener to remove

      • addPreBreakStartListener

        public static void addPreBreakStartListener​(PreBreakStartListener listener)
        Adds a listener that will run before a break starts, before the break handler actually triggers. This can be used to prevent breaking while not in combat, for example.
        Parameters:
        listener - the pre break start listener

      • removePreBreakStartListener

        public static void removePreBreakStartListener​(PreBreakStartListener listener)
        Removes a pre break start listener
        Parameters:
        listener - the listener to remove

      • addEndingListener

        public static void addEndingListener​(java.lang.Runnable listener)
        Adds a listener that will run when the script ends. This is useful for cleanup tasks.
        Parameters:
        listener - the script end listener

      • removeEndingListener

        public static void removeEndingListener​(java.lang.Runnable listener)
        Removes an ending listener
        Parameters:
        listener - the listener to remove

      • addPreEndingListener

        public static void addPreEndingListener​(java.lang.Runnable listener)
        Adds a listener that will run right before the script ends. This is useful for cleanup tasks.
        Parameters:
        listener - the script pre end listener

      • removePreEndingListener

        public static void removePreEndingListener​(java.lang.Runnable listener)
        Removes a pre ending listener
        Parameters:
        listener - the listener to remove

      • addPauseListener

        public static void addPauseListener​(java.lang.Runnable listener)
        Adds a listener that will run when the script is paused by the pause button
        Parameters:
        listener - the script pause listener

      • removePauseListener

        public static void removePauseListener​(java.lang.Runnable listener)
        Removes a pause listener
        Parameters:
        listener - the listener to remove

      • addResumeListener

        public static void addResumeListener​(java.lang.Runnable listener)
        Adds a listener that will run when the script is resumed by the resume button
        Parameters:
        listener - the script resume listener

      • removeResumeListener

        public static void removeResumeListener​(java.lang.Runnable listener)
        Removes a resume listener
        Parameters:
        listener - the listener to remove

      • addMouseClickListener

        public static void addMouseClickListener​(MouseClickListener listener)
        Adds a mouse click listener
        Parameters:
        listener - the mouse click listener

      • removeMouseClickListener

        public static void removeMouseClickListener​(MouseClickListener listener)
        Removes a mouse click listener
        Parameters:
        listener - the listener to remove

      • addMouseDragListener

        public static void addMouseDragListener​(MouseDragListener listener)
        Adds a mouse drag listener
        Parameters:
        listener - the mouse drag listener

      • removeMouseDragListener

        public static void removeMouseDragListener​(MouseDragListener listener)
        Removes a mouse drag listener
        Parameters:
        listener - the listener to remove

      • addMouseMoveListener

        public static void addMouseMoveListener​(MouseMoveListener listener)
        Adds a mouse move listener
        Parameters:
        listener - the mouse move listener

      • removeMouseMoveListener

        public static void removeMouseMoveListener​(MouseMoveListener listener)
        Removes a mouse move listener
        Parameters:
        listener - the listener to remove

      • addMouseReleaseListener

        public static void addMouseReleaseListener​(MouseReleaseListener listener)
        Adds a mouse release listener
        Parameters:
        listener - the mouse release listener

      • removeMouseReleaseListener

        public static void removeMouseReleaseListener​(MouseReleaseListener listener)
        Removes a mouse release listener
        Parameters:
        listener - the listener to remove

      • addMouseEventOverrideListener

        public static void addMouseEventOverrideListener​(MouseEventOverrideListener listener)
        Adds a mouse event override listener
        Parameters:
        listener - the mouse event override listener

      • removeMouseEventOverrideListener

        public static void removeMouseEventOverrideListener​(MouseEventOverrideListener listener)
        Removes a mouse event override listener
        Parameters:
        listener - the mouse event override to remove

      • addKeyEventOverrideListener

        public static void addKeyEventOverrideListener​(KeyEventOverrideListener listener)
        Adds a key event override listener
        Parameters:
        listener - the key event override listener

      • removeKeyEventOverrideListener

        public static void removeKeyEventOverrideListener​(KeyEventOverrideListener listener)
        Removes a key event override listener
        Parameters:
        listener - the key event override to remove