org.osbot.rs07.input.mouse

Class MoveMouseEvent

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.MoveMouseEvent

public class MoveMouseEvent
extends MouseEvent

Represents an event which its task it is to move the mouse to a specified destination by either dragging or normal mouse movement. destination by either dragging or normal mouse movement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MoveMouseEvent.Vector

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

Event.EventMode, Event.EventStatus

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	useNewMouse
static boolean	useSystemMouse

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
MoveMouseEvent(Entity e)
MoveMouseEvent(MouseDestination destination) Creates an instance of this event which moves the mouse to the given destination, with dragging set to false.
MoveMouseEvent(MouseDestination destination, boolean drag) Creates an instance of this event which moves the mouse to the given destination, dragging as specified.
MoveMouseEvent(RS2Widget widget)

Method Summary

Modifier and Type	Method and Description
int	execute() This is the execution method.
static boolean	isNewMouse() Checks if the new mouse option is enabled
void	setIgnoreVisibility(boolean ignoreVisibility)

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, onEnd, onStart, 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

Field Detail

useSystemMouse

public static boolean useSystemMouse

useNewMouse

public static boolean useNewMouse

Constructor Detail

MoveMouseEvent

public MoveMouseEvent(MouseDestination destination)

Creates an instance of this event which moves the mouse to the given destination, with dragging set to false.

Parameters:

destination - The mouse destination.

MoveMouseEvent

public MoveMouseEvent(MouseDestination destination,
                      boolean drag)

Creates an instance of this event which moves the mouse to the given destination, dragging as specified.

Parameters:

destination - The mouse destination.

drag - Whether to drag the mouse.

MoveMouseEvent

public MoveMouseEvent(Entity e)

MoveMouseEvent

public MoveMouseEvent(RS2Widget widget)

Method Detail

setIgnoreVisibility

public void setIgnoreVisibility(boolean ignoreVisibility)

isNewMouse

public static boolean isNewMouse()

Checks if the new mouse option is enabled

Returns:

True if the new mouse option is enabled

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