Package rs.kreme.ksbot.api.wrappers

Class KSGroundItem

java.lang.Object

rs.kreme.ksbot.api.wrappers.KSGroundItem

All Implemented Interfaces:

Interactable, Locatable, Positionable

public final class KSGroundItem
extends java.lang.Object
implements Locatable, Interactable

Constructor Summary

Constructors

Constructor	Description
KSGroundItem(int id, int quantity)
KSGroundItem(int id, int quantity, net.runelite.api.Tile tile)
KSGroundItem(net.runelite.client.game.ItemStack itemStack)

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getActions()	Retrieves the available actions for the item.
long	getPrice()	Gets the item's price.
net.runelite.api.coords.WorldPoint	getWorldLocation()	Retrieves the world location of the ground item.
void	interact(int action)	Interacts with the item based on the provided action index.
void	interact(int index, net.runelite.api.MenuAction menuAction)	Deprecated.
void	interact(int index, net.runelite.api.MenuAction menuAction, int param0, int param1)	Deprecated.
boolean	interact(java.lang.String option)	Interacts with the item based on the provided option string.
void	interact(net.runelite.api.MenuAction menuAction)	Interacts with the item based on the provided MenuAction.
boolean	isNoted()	Checks if the item is noted (i.e., has a note ID).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface rs.kreme.ksbot.api.interfaces.Interactable

getClickBounds, getOptionIndex, hasAction

Methods inherited from interface rs.kreme.ksbot.api.interfaces.Locatable

distanceTo, distanceTo, getLocalLocation, getPlane, getWorldX, getWorldY

Constructor Detail

KSGroundItem

public KSGroundItem(int id,
                    int quantity,
                    net.runelite.api.Tile tile)

KSGroundItem

public KSGroundItem(int id,
                    int quantity)

KSGroundItem

public KSGroundItem(net.runelite.client.game.ItemStack itemStack)

Method Detail

getWorldLocation

public net.runelite.api.coords.WorldPoint getWorldLocation()

Retrieves the world location of the ground item.

Specified by:

getWorldLocation in interface Locatable

Specified by:

getWorldLocation in interface Positionable

Returns:

The WorldPoint of the ground item.

isNoted

public boolean isNoted()

Checks if the item is noted (i.e., has a note ID).

Returns:

true if the item is noted, false otherwise.

getPrice

public long getPrice()

Gets the item's price.

Returns:

The price of the item.

interact

public void interact(int action)

Interacts with the item based on the provided action index.

Specified by:

interact in interface Interactable

Parameters:

action - The action index.

interact

public boolean interact(java.lang.String option)

Interacts with the item based on the provided option string.

Specified by:

interact in interface Interactable

Parameters:

option - The action string.

getActions

public java.lang.String[] getActions()

Retrieves the available actions for the item.

Specified by:

getActions in interface Interactable

Returns:

An array of available actions.

interact

public void interact(net.runelite.api.MenuAction menuAction)

Interacts with the item based on the provided MenuAction.

Specified by:

interact in interface Interactable

Parameters:

menuAction - The MenuAction to perform.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

interact

@Deprecated
public void interact(int index,
                     net.runelite.api.MenuAction menuAction,
                     int param0,
                     int param1)

Deprecated.

Specified by:

interact in interface Interactable

interact

@Deprecated
public void interact(int index,
                     net.runelite.api.MenuAction menuAction)

Deprecated.

Specified by:

interact in interface Interactable