org.osbot.rs07.input.mouse

Class ClickMouseEvent

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.event.Event

org.osbot.rs07.input.mouse.MouseEvent

org.osbot.rs07.input.mouse.ClickMouseEvent

public class ClickMouseEvent
extends MouseEvent

Represents an event which its task is to click the mouse at a given position, moving the mouse to the position as necessary.

Nested Class Summary

Nested classes/interfaces inherited from class org.osbot.rs07.event.Event

Event.EventMode, Event.EventStatus

Field Summary

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
ClickMouseEvent(MouseDestination destination) Creates an instance of this event, which performs a left button click mouse event at the given destination, moving the mouse to the position as necessary.
ClickMouseEvent(MouseDestination destination, boolean rightClick) Creates an instance of this event, which performs a click mouse event at the given destination, using the left or right mouse button as specified, moving the mouse to the position as necessary.
ClickMouseEvent(MouseDestination destination, boolean rightClick, int checkCrossHairColor) Creates an instance of this event, which performs a click mouse event at the given destination, using the left or right mouse button as specified, moving the mouse to the position as necessary.

Method Summary

Modifier and Type	Method and Description
int	execute() This is the execution method.
void	onEnd() Called after this event is executed.
void	onStart() Called before this event is executed.

Methods inherited from class org.osbot.rs07.input.mouse.MouseEvent

updateDestination

Methods inherited from class org.osbot.rs07.event.Event

addChild, exchangeContext, getChildren, getMode, getParent, getStatus, hasFailed, hasFinished, interrupt, isQueued, isWorking, removeChild, setAsync, setBlocking, setFailed, setFinished, setParent

Methods inherited from class org.osbot.rs07.script.MethodProvider

execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

ClickMouseEvent

public ClickMouseEvent(MouseDestination destination)

Creates an instance of this event, which performs a left button click mouse event at the given destination, moving the mouse to the position as necessary.

Parameters:

destination - The destination to click.

ClickMouseEvent

public ClickMouseEvent(MouseDestination destination,
                       boolean rightClick)

Creates an instance of this event, which performs a click mouse event at the given destination, using the left or right mouse button as specified, moving the mouse to the position as necessary.

Parameters:

destination - The destination to click.

rightClick - Whether to left or right click at the destination.

ClickMouseEvent

public ClickMouseEvent(MouseDestination destination,
                       boolean rightClick,
                       int checkCrossHairColor)

Creates an instance of this event, which performs a click mouse event at the given destination, using the left or right mouse button as specified, moving the mouse to the position as necessary.

Parameters:

destination - The destination to click.

rightClick - Whether to left or right click at the destination.

checkCrossHairColor - Determines whether we check the cross hair color to help determine if the interaction was successful -1: Don't check 0: cross hair color should be 0 1: cross hair color should be 1 2: cross hair color should be 2 Ignored if right-click

Method Detail

onStart

public void onStart()

Description copied from class: Event

Called before this event is executed.

Overrides:

onStart in class Event

onEnd

public void onEnd()

Description copied from class: Event

Called after this event is executed.

Overrides:

onEnd in class Event

execute

public int execute()
            throws java.lang.InterruptedException

Description copied from class: Event

This is the execution method. Works like onLoop() in OSBot v1.

Specified by:

execute in class Event

Returns:

A positive number to wait between calls in milliseconds, or a negative number to stop the event.

Throws:

java.lang.InterruptedException - Thrown when execution is interrupted