Package org.rspeer.game.component

Class Item

java.lang.Object

org.rspeer.game.component.Item

All Implemented Interfaces:

Actionable, Defined<RSItemDefinition,ItemDefinition>, Identifiable, Interactable, Nameable

public class Item
extends Object
implements Identifiable, Nameable, Interactable, Defined<RSItemDefinition,ItemDefinition>

Represents an Item in game

Nested Class Summary

Nested classes/interfaces inherited from interface org.rspeer.game.adapter.type.Actionable

Actionable.Query<Q extends Actionable.Query<Q>>

Nested classes/interfaces inherited from interface org.rspeer.game.adapter.type.Identifiable

Identifiable.Query<Q extends Identifiable.Query<Q>>

Nested classes/interfaces inherited from interface org.rspeer.game.adapter.type.Nameable

Nameable.Query<Q extends Nameable.Query<Q>>

Constructor Summary

Constructors

Constructor	Description
Item(int index, int id, int stackSize, InterfaceAddress address)

Method Summary

Modifier and Type	Method	Description
MenuAction	actionOf(String action)
static Item	combine(RSInventory inv, InterfaceComponent component, int index)
static Item	direct(boolean forceComponent, RSInventory inv, InterfaceComponent component)
static Item	direct(RSInventory inv, InterfaceComponent component)
boolean	equals(Object o)
static Item	from(InterfaceComponent component)
List<String>	getActions()
Rectangle	getBounds()
InterfaceComponent	getComponent()
ItemDefinition	getDefinition()
int	getId()
int	getIndex()
String	getName()
String[]	getRawActions()
CompletableFuture<Sprite>	getSprite(int border, int shadow, int stackable, boolean noted)
int	getStackSize()
static Item	getTableElement(InterfaceComponent component, int index)
int	hashCode()
boolean	isNoted()
static boolean	isNullId(int id)
boolean	isPlaceholder()
boolean	isStackable()
boolean	isUnbound()
static Item	parent(RSInventory inv, InterfaceComponent component)
void	setActionOverride(BiFunction<Item,String,MenuAction> actionOverride)
void	setActionSupplier(Function<Item,List<String>> actionSupplier)
String	toString()
static Item	unbound(int index, int id, int stackSize)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.rspeer.game.adapter.type.Actionable

containsAction, containsAction

Methods inherited from interface org.rspeer.game.adapter.type.Interactable

actionOf, interact, interact, interact, interact, interact

Constructor Detail

Item

public Item(int index,
            int id,
            int stackSize,
            InterfaceAddress address)

Method Detail

unbound

public static Item unbound(int index,
                           int id,
                           int stackSize)

combine

public static Item combine(RSInventory inv,
                           InterfaceComponent component,
                           int index)

parent

public static Item parent(RSInventory inv,
                          InterfaceComponent component)

from

public static Item from(InterfaceComponent component)

direct

public static Item direct(RSInventory inv,
                          InterfaceComponent component)

direct

public static Item direct(boolean forceComponent,
                          RSInventory inv,
                          InterfaceComponent component)

getTableElement

public static Item getTableElement(InterfaceComponent component,
                                   int index)

isNullId

public static boolean isNullId(int id)

getComponent

public InterfaceComponent getComponent()

isUnbound

public boolean isUnbound()

getName

public String getName()

Specified by:

getName in interface Nameable

getId

public int getId()

Specified by:

getId in interface Identifiable

getIndex

public int getIndex()

getStackSize

public int getStackSize()

getDefinition

public ItemDefinition getDefinition()

Specified by:

getDefinition in interface Defined<RSItemDefinition,ItemDefinition>

isStackable

public boolean isStackable()

isNoted

public boolean isNoted()

isPlaceholder

public boolean isPlaceholder()

actionOf

public MenuAction actionOf(String action)

Specified by:

actionOf in interface Interactable

getRawActions

public String[] getRawActions()

Specified by:

getRawActions in interface Actionable

getActions

public List<String> getActions()

Specified by:

getActions in interface Actionable

getSprite

public CompletableFuture<Sprite> getSprite(int border,
                                           int shadow,
                                           int stackable,
                                           boolean noted)

Parameters:

stackable - 0 = Never show item quantity number 1 = Always show item quantity number 2 = Only show item quantity number if it's greater than 1

toString

public String toString()

Overrides:

toString in class Object

getBounds

public Rectangle getBounds()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setActionOverride

public void setActionOverride(BiFunction<Item,String,MenuAction> actionOverride)

setActionSupplier

public void setActionSupplier(Function<Item,List<String>> actionSupplier)