script-sdk/org.tribot.script.sdk.types/GroundItem

GroundItem

open class GroundItem : Modellable, Actionable, Named, Identifiable, Interactable, Stackable, ItemDefinable

Represents an item on the ground

Constructors

GroundItem

constructor(groundItem: RSGroundItem)

Types

OwnerType

enum OwnerType

Properties

definition

open val definition: ItemDefinition

Functions

adjustCameraTo

open fun adjustCameraTo(): Boolean

Moves the camera to a position where the given entity or position is in view.

click

open fun click(): Boolean

Interacts with the entity, with the first action available.

open fun click(action: String): Boolean

Interacts with the entity, given a specific action.

distance

open fun distance(): Int

Determines the distance between this entity/tile and the local player

distanceTo

open fun distanceTo(position: Positionable): Int

Determines the distance between this entity/tile and the given entity/tile

equals

open fun equals(o: Any): Boolean

getActions

open fun getActions(): List<String>

Gets the available actions for the entity, usually dependent on their definition.

getDespawnTicks

open fun getDespawnTicks(): Int

getId

open fun getId(): Int

Gets the ID of the entity

getLegacyRSGroundItem

open fun getLegacyRSGroundItem(): RSGroundItem

getModel

open fun getModel(): Optional<Model>

Gets the entity model

getName

open fun getName(): String

Determines the name of the entity of the object this method is called on.

getOwnerType

open fun getOwnerType(): GroundItem.OwnerType

getRevealTick

open fun getRevealTick(): Int

getStack

open fun getStack(): Int

Gets the stack of this item, which is how many of the item is occupying the item space.

getTile

open fun getTile(): WorldTile

Gets the WorldTile of this entity/position

hashCode

open fun hashCode(): Int

hover

open fun hover(action: String): Boolean

Hovers the specified action on this entity.

open fun hover(): Boolean

Moves the mouse to a human-randomized point on the entity.

hoverMenu

open fun hoverMenu(action: String): Boolean

Hovers the specified action on this entity, always right-clicking and hovering over the menu

interact

open fun interact(action: String): Boolean

open fun interact(action: String, interruptCondition: BooleanSupplier): Boolean

Attempts to interact with the entity using the given action.

isHovering

open fun isHovering(): Boolean

Checks if the mouse is currently over this entity

isVisible

open fun isVisible(): Boolean

Determines if the entity is on the screen and able to be clicked.

toString

open fun toString(): String

GroundItem

See also

Constructors

Types

Properties

Functions