org.osbot.rs07.api.model

Class Item

java.lang.Object

org.osbot.rs07.api.model.Item

All Implemented Interfaces:

Identifiable, Interactable

public class Item
extends java.lang.Object
implements Identifiable, Interactable

Represents an item.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TEMPLATE_ID

Constructor Summary

Constructors

Constructor and Description
Item(MethodProvider methods, int rootId, int id, int amount) Deprecated. for internal use only.
Item(RS2Widget owner, int id, int amount) Deprecated. for internal use only.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String[]	getActions() Gets the model actions of this identifiable.
int	getAmount() Gets the amount for this item.
ItemDefinition	getDefinition() Gets the item definition for this item.
int	getId() Gets the id of this identifiable.
int[]	getModelIds() Gets the model ids of this identifiable.
java.lang.String	getName() This will return the name of the item.
int	getNotedId()
RS2Widget	getOwner() Gets the owner RS2Widget of this item
int	getUnnotedId()
boolean	hasAction(java.lang.String... action) Check if identifiable contains one or more of specified actions.
boolean	hover() Attempts to hover the mouse over the next click needed to interact with this Interactable.
boolean	idContains(int... ids)
boolean	interact(java.lang.String... actions) Executes an @link org.osbot.rs07.event.InteractionEvent which attempts to interact with this Interactable with the specified actions (if any).
boolean	isNote() Whether this item is a note or not.
boolean	nameContains(java.lang.String... names)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TEMPLATE_ID

public static final int TEMPLATE_ID

See Also:

Constant Field Values

Constructor Detail

Item

public Item(RS2Widget owner,
            int id,
            int amount)

Deprecated. for internal use only.

Item

public Item(MethodProvider methods,
            int rootId,
            int id,
            int amount)

Deprecated. for internal use only.

Method Detail

getOwner

public RS2Widget getOwner()

Gets the owner RS2Widget of this item

Returns:

The owner RS2Widget of this item

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public int getId()

Gets the id of this identifiable.

Specified by:

getId in interface Identifiable

Returns:

The id of this identifiable.

getAmount

public int getAmount()

Gets the amount for this item.

Returns:

The amount for this item.

getName

public java.lang.String getName()

This will return the name of the item. If it's a noted item, it will try and grab the name from its non noted version from the ItemDefinition class. However it can not be guaranteed that there will a definition loaded for it. In the case of a noted item and the non noted version is available in the ItemDefinitions, the name will return with (n) at the end. Else it will return "null". In the case of a non noted item the normal name will be returned.

Specified by:

getName in interface Identifiable

Returns:

The name.

nameContains

public boolean nameContains(java.lang.String... names)

Parameters:

names - The array of names to compare against.

Returns:

True if any of the names matches the item's getName()

idContains

public boolean idContains(int... ids)

Parameters:

ids - The array of ids to compare against.

Returns:

True if any of the names matches the item's getName()

getModelIds

public int[] getModelIds()

Gets the model ids of this identifiable.

Specified by:

getModelIds in interface Identifiable

Returns:

The model ids of this identifiable.

isNote

public boolean isNote()

Whether this item is a note or not.

Returns:

True if this item is a note.

getUnnotedId

public int getUnnotedId()

Returns:

The id of the un-noted version of this item.

getNotedId

public int getNotedId()

Returns:

The id of the noted version of this item.

getDefinition

public ItemDefinition getDefinition()

Gets the item definition for this item.

Returns:

The item definition for this item.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

interact

public boolean interact(java.lang.String... actions)

Executes an @link org.osbot.rs07.event.InteractionEvent which attempts to interact with this Interactable with the specified actions (if any).

Specified by:

interact in interface Interactable

Parameters:

actions - The actions to chose from the menu while hovering over this Interactable.

Returns:

Whether or not the interaction event executed successfully.

hover

public boolean hover()

Attempts to hover the mouse over the next click needed to interact with this Interactable. This method will never click the mouse, so it can be used to speed up scripts while they are idling.

Specified by:

hover in interface Interactable

hasAction

public boolean hasAction(java.lang.String... action)

Check if identifiable contains one or more of specified actions.

Specified by:

hasAction in interface Identifiable

Parameters:

action - The actions you wish to check.

Returns:

If the object contains at least one action specified.

getActions

public java.lang.String[] getActions()

Gets the model actions of this identifiable.

Specified by:

getActions in interface Identifiable

Returns:

The model actions of this identifiable.