Package org.dreambot.api.input.event.impl

Class InteractionEvent

    • Constructor Detail

      • InteractionEvent

        public InteractionEvent​(AbstractMouseDestination destination)
        Instantiates a new Interaction event.
        Parameters:
        destination - the destination

    • Method Detail

      • getInterrupt

        public Condition getInterrupt()

      • setInterrupt

        public void setInterrupt​(Condition c)

      • interactForceLeft

        public boolean interactForceLeft​(java.lang.String action)
        Interacts with current object by forcing a left click. (Interact without using Menus)
        Parameters:
        action - the action which to check for before clicking.
        Returns:
        the result of the interaction, true if successful, otherwise false.

      • interactForceRight

        public boolean interactForceRight​(java.lang.String action)
        Interacts with the current object by forcing a left right. (Interact using Menus)
        Parameters:
        action - the action to use for interacting.
        Returns:
        the result of the interaction, true if successful, otherwise false.

      • interact

        public boolean interact​(java.lang.String action)
        Interacts with the given object using an action. Will choose best type interaction, using both left and right clicks.
        Parameters:
        action - the action
        Returns:
        results of interaction, true if interaction with the object was successful, otherwise false.

      • interact

        public boolean interact()
        Interacts with the given object. Will choose the best type given the provided arguments.
        Returns:
        results of interaction, true if interaction with the object was successful, otherwise false.

      • interact

        public boolean interact​(java.lang.String action,
                        boolean right,
                        boolean forceRight)
        Interacts with the given object using an action. Will choose the best type given the provided arguments.
        Parameters:
        action - the action
        right - this will allow usage of right click to interact. (WILL NOT FORCE RIGHT CLICK)
        forceRight - the override click type, and forces interaction to use a right click.
        Returns:
        results of interaction, true if interaction with the object was successful, otherwise false.

      • interact

        public boolean interact​(java.lang.String action,
                        InteractionSetting... settings)
        Interacts with the given object using an action. Checks interaction settings for specifics on how to interact with the object.
        Parameters:
        action - String value of the action to interact with.
        settings - Settings to use for specifics on how to interact with the object.
        Returns:
        True if interaction is successful, otherwise false.

      • stop

        public void stop()
        Kills the current interaction event instance.

      • isHoverOnly

        public boolean isHoverOnly()

      • setHoverOnly

        public void setHoverOnly​(boolean hoverOnly)

      • getMaxRetryAttempts

        public static int getMaxRetryAttempts()

      • setMaxRetryAttempts

        public static void setMaxRetryAttempts​(int maxRetryAttempts)