Interactable

Represents an "interactable" entity. This is an entity that is both positionable (has a position), and clickable.

Inheritors

Functions

Link copied to clipboard
abstract fun adjustCameraTo(): Boolean
Moves the camera to a position where the given entity or position is in view.
Link copied to clipboard
abstract fun click(): Boolean
Interacts with the entity, with the first action available.
abstract fun click(action: String): Boolean
Interacts with the entity, given a specific action.
Link copied to clipboard
open fun distance(): Int
Determines the distance between this entity/tile and the local player
Link copied to clipboard
open fun distanceTo(position: Positionable): Int
Determines the distance between this entity/tile and the given entity/tile
Link copied to clipboard
abstract fun getTile(): WorldTile
Gets the WorldTile of this entity/position
Link copied to clipboard
abstract fun hover(): Boolean
Moves the mouse to a human-randomized point on the entity.
open fun hover(action: String): Boolean
Hovers the specified action on this entity.
Link copied to clipboard
open fun hoverMenu(action: String): Boolean
Hovers the specified action on this entity, always right-clicking and hovering over the menu
Link copied to clipboard
open fun interact(action: String): Boolean
open fun interact(action: String, interruptCondition: BooleanSupplier): Boolean
Attempts to interact with the entity using the given action.
Link copied to clipboard
abstract fun isHovering(): Boolean
Checks if the mouse is currently over this entity
Link copied to clipboard
abstract fun isVisible(): Boolean
Determines if the entity is on the screen and able to be clicked.