org.osbot.rs07.input.mouse

Class MouseDestination

java.lang.Object

org.osbot.rs07.input.mouse.MouseDestination

Direct Known Subclasses:

AreaDestination, BankSlotDestination, DepositBoxSlotDestination, EntityDestination, EquipmentSlotDestination, InventorySlotDestination, MainScreenTileDestination, MiniMapTileDestination, PointDestination, RectangleDestination, StoreSlotDestination, TradeOfferItemDestination, WidgetDestination

public abstract class MouseDestination
extends java.lang.Object

Represents an abstract mouse destination.

Constructor Summary

Constructors

Constructor and Description
MouseDestination(Bot bot) Constructor to be used in the OSBot 2 classes.

Method Summary

Modifier and Type	Method and Description
abstract boolean	evaluate() Evaluates whether an interaction for this mouse destination is allowed to be performed.
abstract java.awt.geom.Area	getArea() Gets the destination area specified by a Area object.
Bot	getBot()
abstract java.awt.Rectangle	getBoundingBox() Gets the bounding box rectangle of this mouse destination.
java.awt.Shape	getShape() Gets the optimal shape of this mouse destination.
boolean	isHover() Determines if this mouse destination is for hovering only.
abstract boolean	isVisible() Determines whether this destination is visible.
MouseDestination	setHover(boolean hover) Sets whether or not this mouse destination is for hovering only.

Methods inherited from class java.lang.Object

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

Constructor Detail

MouseDestination

public MouseDestination(Bot bot)

Constructor to be used in the OSBot 2 classes.

Parameters:

bot - The bot instance

Method Detail

getBot

public Bot getBot()

isHover

public boolean isHover()

Determines if this mouse destination is for hovering only.

Returns:

True if this mouse destination is for hovering only.

setHover

public MouseDestination setHover(boolean hover)

Sets whether or not this mouse destination is for hovering only.

Parameters:

hover - The hover only value

Returns:

This destination

getArea

public abstract java.awt.geom.Area getArea()

Gets the destination area specified by a Area object.

Returns:

The destination Area.

evaluate

public abstract boolean evaluate()

Evaluates whether an interaction for this mouse destination is allowed to be performed.

Returns:

True if an interaction is allowed to be performed.

getBoundingBox

public abstract java.awt.Rectangle getBoundingBox()

Gets the bounding box rectangle of this mouse destination.

Returns:

The bounding box rectangle of this mouse destination.

getShape

public java.awt.Shape getShape()

Gets the optimal shape of this mouse destination.

Returns:

The optimal shape of this mouse destination.

isVisible

public abstract boolean isVisible()

Determines whether this destination is visible.

Returns:

Whether this destination is visible.