Package com.epicbot.api.shared.entity

Interface Item

All Superinterfaces:
Actionable, Identifiable, Nameable, Validatable
All Known Subinterfaces:
GroundItem, ItemWidget, WidgetChild, WidgetChildItem
public interface Item extends Actionable, Identifiable, Nameable, Validatable
An item in the game (e.g. a ground item or inventory item).

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getGroundActions()
    Gets the available actions when this item is on the ground.
    default int
    getHighAlchemyPrice()
    Get the high alchemy price for this item.
    default int
    getLowAlchemyPrice()
    Get the low alchemy price for this item.
    int
    getNotedId()
    Gets the noted item id of the noted or un-noted variant of this item.
    int
    getStackSize()
    Gets the stack size of the item.
    int
    getStorePrice()
    Gets the store price of the item.
    int
    getUnNotedId()
    Gets the un-noted item id of the noted or un-noted variant of this item.
    boolean
    hasGroundAction(String... actions)
    Determines if this item has one of the given ground actions.
    boolean
    isMembers()
    Gets whether or not this item is a members only item.
    boolean
    isNoted()
    Gets whether or not this item is noted.
    boolean
    isStackable()
    Gets whether or not this item is stackable in a players inventory.
    boolean
    isTradable()
    Gets whether or not this item is tradable.

    Methods inherited from interface com.epicbot.api.shared.entity.details.Actionable

    getActions, hasAction, hasActionMatch

    Methods inherited from interface com.epicbot.api.shared.entity.details.Identifiable

    getId

    Methods inherited from interface com.epicbot.api.shared.entity.details.Nameable

    getName

    Methods inherited from interface com.epicbot.api.shared.entity.details.Validatable

    isValid

  • Method Details

    • getStorePrice

      int getStorePrice()
      Gets the store price of the item. All items have a store price and the store price can be used to calculate high and low alchemy values.
      Returns:
      the general store value of the item

    • getLowAlchemyPrice

      default int getLowAlchemyPrice()
      Get the low alchemy price for this item.
      Returns:
      the low alchemy price (storePrice * 0.4)

    • getHighAlchemyPrice

      default int getHighAlchemyPrice()
      Get the high alchemy price for this item.
      Returns:
      the high alchemy price (storePrice * 0.6)

    • isNoted

      boolean isNoted()
      Gets whether or not this item is noted.
      Returns:
      true if noted, false otherwise

    • isStackable

      boolean isStackable()
      Gets whether or not this item is stackable in a players inventory.
      Returns:
      true if stackable, false otherwise

    • isTradable

      boolean isTradable()
      Gets whether or not this item is tradable.
      Returns:
      true if tradable, false otherwise

    • isMembers

      boolean isMembers()
      Gets whether or not this item is a members only item.
      Returns:
      true if members only, false otherwise

    • getStackSize

      int getStackSize()
      Gets the stack size of the item.
      Returns:
      int

    • getGroundActions

      List<String> getGroundActions()
      Gets the available actions when this item is on the ground.
      Returns:
      list of actions

    • hasGroundAction

      boolean hasGroundAction(String... actions)
      Determines if this item has one of the given ground actions.
      Parameters:
      actions - one or multiple actions
      Returns:
      true if it has one of the given actions, false otherwise

    • getNotedId

      int getNotedId()
      Gets the noted item id of the noted or un-noted variant of this item.
      Returns:
      int

    • getUnNotedId

      int getUnNotedId()
      Gets the un-noted item id of the noted or un-noted variant of this item.
      Returns:
      int