org.osbot.rs07.api

Class Mouse

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Mouse

public class Mouse
extends API

Represents the API regarding mouse functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mouse.CrossHairColor An enum representing the state of the mouse cursor of the client.

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
Mouse()

Method Summary

Modifier and Type	Method and Description
boolean	click(boolean rightClick) Performs a mouse click.
boolean	click(int x, int y, boolean rightClick) Moves the mouse to the specified destination.
boolean	click(MouseDestination destination) Moves the mouse to the specified destination and performs a left click on the destination.
boolean	click(MouseDestination destination, boolean rightClick) Moves the mouse to the specified destination and performs a left or a right click as specified on the destination.
boolean	continualClick(MouseDestination destination, Condition condition) Moves the mouse to the specified destination and performs a left click for as long as the condition evaluates to false.
boolean	continualClick(MouseDestination destination, Condition condition, boolean rightClick) Moves the mouse to the specified destination and performs a click for as long as the condition evaluates to false.
java.awt.Color	getColor() Gets the color at the mouse cursor.
Mouse.CrossHairColor	getCrossHairColor() Returns the current state/color of the mouse cross hair of the client.
java.util.List<Entity>	getEntitiesOnCursor() Returns a list of actively interact-able entities being hovered over by the mouse cursor.
java.awt.event.MouseListener	getListener() Gets the client's mouse listener.
int	getOnCursorCount() The number of entities with options under your cursor.
java.awt.Point	getPosition() Gets the current mouse position.
void	initializeModule()
boolean	isDefaultPaintEnabled() Checks if the default mouse debug paint is disabled or not
boolean	isOnCursor(Entity entity) Returns if this entity is on the cursor/mouse position.
boolean	isOnScreen() Detects if the mouse is on the game screen.
boolean	move(int x, int y) Moves the mouse to the specified destination.
boolean	move(MouseDestination destination) Moves the mouse to the specified destination.
boolean	move(MouseDestination destination, boolean drag) Moves the mouse to the specified destination.
boolean	moveOutsideScreen() Moves the mouse to a random position outside the screen.
void	scrollDown()
void	scrollUp()
void	setDefaultPaintEnabled(boolean on) Sets the default mouse debug paint on or off

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

exchangeContext, 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

Mouse

public Mouse()

Method Detail

isDefaultPaintEnabled

public boolean isDefaultPaintEnabled()

Checks if the default mouse debug paint is disabled or not

Returns:

Whether the default mouse paint is disabled or not

setDefaultPaintEnabled

public void setDefaultPaintEnabled(boolean on)

Sets the default mouse debug paint on or off

Parameters:

on - Set the default mouse debug paint on or off

getOnCursorCount

public int getOnCursorCount()

The number of entities with options under your cursor.

Returns:

The number of entities with options under your cursor.

moveOutsideScreen

public final boolean moveOutsideScreen()

Moves the mouse to a random position outside the screen.

Returns:

True if successfully executed.

isOnScreen

public boolean isOnScreen()

Detects if the mouse is on the game screen.

Returns:

True if the mouse is on the game screen.

move

public final boolean move(MouseDestination destination)

Moves the mouse to the specified destination.

Parameters:

destination - The destination to move the mouse to.

Returns:

True if successfully executed.

move

public final boolean move(MouseDestination destination,
                          boolean drag)

Moves the mouse to the specified destination.

Parameters:

destination - The destination to move the mouse to.

drag - Whether to hold the left mouse button whilst moving the mouse.

Returns:

True if successfully executed.

getColor

public java.awt.Color getColor()

Gets the color at the mouse cursor.

Returns:

The color at the mouse cursor.

move

public final boolean move(int x,
                          int y)

Moves the mouse to the specified destination.

Parameters:

x - The x coordinate to move to.

y - The y coordinate to move to.

Returns:

True if the event has failed.

click

public final boolean click(int x,
                           int y,
                           boolean rightClick)

Moves the mouse to the specified destination.

Parameters:

x - The x coordinate to move to.

y - The y coordinate to move to.

rightClick - True to right click, False to left click

Returns:

True if the event has failed.

click

public final boolean click(MouseDestination destination)

Moves the mouse to the specified destination and performs a left click on the destination.

Parameters:

destination - The destination to click.

Returns:

True if successfully executed.

click

public final boolean click(boolean rightClick)

Performs a mouse click.

Parameters:

rightClick - Whether to perform right click

Returns:

True if successfully executed

click

public final boolean click(MouseDestination destination,
                           boolean rightClick)

Moves the mouse to the specified destination and performs a left or a right click as specified on the destination.

Parameters:

destination - The destination to click.

rightClick - Whether to right click the destination.

Returns:

True if successfully executed.

continualClick

public final boolean continualClick(MouseDestination destination,
                                    Condition condition)

Moves the mouse to the specified destination and performs a left click for as long as the condition evaluates to false.

Parameters:

destination - The destination to click.

condition - The conditions for which as long as it's false the click will continue.

Returns:

True if executed successfully.

continualClick

public final boolean continualClick(MouseDestination destination,
                                    Condition condition,
                                    boolean rightClick)

Moves the mouse to the specified destination and performs a click for as long as the condition evaluates to false.

Parameters:

destination - The destination to click.

condition - The condition for which as long as it's false the click will continue.

rightClick - Whether to use the right mouse button button to click.

Returns:

True if executed successfully.

isOnCursor

public boolean isOnCursor(Entity entity)

Returns if this entity is on the cursor/mouse position.

Parameters:

entity - The entity to check

Returns:

True if this entity is on the cursor/mouse position.

getEntitiesOnCursor

public java.util.List<Entity> getEntitiesOnCursor()

Returns a list of actively interact-able entities being hovered over by the mouse cursor.

Returns:

The list of active interact-able entities being hovered over by the mouse cursor.

getListener

public java.awt.event.MouseListener getListener()

Gets the client's mouse listener.

Returns:

The mouse listener.

getPosition

public java.awt.Point getPosition()

Gets the current mouse position.

Returns:

The mouse position.

scrollUp

public void scrollUp()

scrollDown

public void scrollDown()

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getCrossHairColor

public Mouse.CrossHairColor getCrossHairColor()

Returns the current state/color of the mouse cross hair of the client.

Returns:

The current state/color of the mouse cross hair of the client.