de.ellpeck.rockbottom.api.item

Class Item

java.lang.Object

de.ellpeck.rockbottom.api.item.Item

Direct Known Subclasses:

ItemBasic

public class Item
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxAmount
protected ResourceName	name
protected ResourceName	unlocName

Constructor Summary

Constructors

Constructor and Description
Item(ResourceName name)

Method Summary

Modifier and Type	Method and Description
boolean	attacksMultipleEntities(IWorld world, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
boolean	canHoldButtonToAttack(IWorld world, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
void	describeItem(IAssetManager manager, ItemInstance instance, java.util.List<java.lang.String> desc, boolean isAdvanced, boolean isRealItem) Allows items to add to the tooltip
int	getAttackCooldown(IWorld world, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
int	getAttackDamage(IWorld world, Entity entity, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
java.util.List<Entity>	getCustomAttackableEntities(IWorld world, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
int	getDespawnTime(ItemInstance instance)
int	getHighestPossibleMeta()
int	getInteractionPriority(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
java.lang.String	getLocalizedName(ItemInstance instance)
int	getMaxAmount()
double	getMaxInteractionDistance(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
float	getMiningSpeed(IWorld world, int x, int y, TileLayer layer, Tile tile, boolean isRightTool, ItemInstance instance)
ResourceName	getName()
IItemRenderer	getRenderer()
java.util.Map<ToolProperty,java.lang.Integer>	getToolProperties(ItemInstance instance)
ResourceName	getUnlocalizedName(ItemInstance instance)
boolean	isDataSensitive(ItemInstance instance) Deprecated. This method is now unused - items will always be data sensitive
boolean	onEntityAttack(IWorld world, double mouseX, double mouseY, AbstractEntityPlayer player, Entity entity, ItemInstance instance)
boolean	onInteractWith(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
boolean	onInteractWithDestKey(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractEntityPlayer player, ItemInstance instance)
void	onTileBroken(IWorld world, int x, int y, TileLayer layer, AbstractEntityPlayer player, Tile tile, ItemInstance instance)
Item	register()
Item	setMaxAmount(int amount)
void	takeDamage(ItemInstance instance, AbstractEntityPlayer player, int amount)
ItemInstance	takeDamage(ItemInstance instance, int amount)
java.lang.String	toString()
boolean	useMetaAsDurability()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

protected final ResourceName name

unlocName

protected final ResourceName unlocName

maxAmount

protected int maxAmount

Constructor Detail

Item

public Item(ResourceName name)

Method Detail

getRenderer

public IItemRenderer getRenderer()

register

public Item register()

getMaxAmount

public int getMaxAmount()

setMaxAmount

public Item setMaxAmount(int amount)

getName

public ResourceName getName()

getUnlocalizedName

public ResourceName getUnlocalizedName(ItemInstance instance)

getLocalizedName

public java.lang.String getLocalizedName(ItemInstance instance)

describeItem

public void describeItem(IAssetManager manager,
                         ItemInstance instance,
                         java.util.List<java.lang.String> desc,
                         boolean isAdvanced,
                         boolean isRealItem)

Allows items to add to the tooltip

Parameters:

instance - The item that is being described

desc - The item description. You can add to this list or replace it.

isAdvanced - If the player is holding SHIFT to view advanced info

isRealItem - Does the player actually own this item or is it a preview in a GUI? Used by tools to display durability descriptors only on real items.

onInteractWith

public boolean onInteractWith(IWorld world,
                              int x,
                              int y,
                              TileLayer layer,
                              double mouseX,
                              double mouseY,
                              AbstractEntityPlayer player,
                              ItemInstance instance)

onInteractWithDestKey

public boolean onInteractWithDestKey(IWorld world,
                                     int x,
                                     int y,
                                     TileLayer layer,
                                     double mouseX,
                                     double mouseY,
                                     AbstractEntityPlayer player,
                                     ItemInstance instance)

getInteractionPriority

public int getInteractionPriority(IWorld world,
                                  int x,
                                  int y,
                                  TileLayer layer,
                                  double mouseX,
                                  double mouseY,
                                  AbstractEntityPlayer player,
                                  ItemInstance instance)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDespawnTime

public int getDespawnTime(ItemInstance instance)

isDataSensitive

@Deprecated
public boolean isDataSensitive(ItemInstance instance)

Deprecated. This method is now unused - items will always be data sensitive

getToolProperties

public java.util.Map<ToolProperty,java.lang.Integer> getToolProperties(ItemInstance instance)

getMiningSpeed

public float getMiningSpeed(IWorld world,
                            int x,
                            int y,
                            TileLayer layer,
                            Tile tile,
                            boolean isRightTool,
                            ItemInstance instance)

onTileBroken

public void onTileBroken(IWorld world,
                         int x,
                         int y,
                         TileLayer layer,
                         AbstractEntityPlayer player,
                         Tile tile,
                         ItemInstance instance)

getHighestPossibleMeta

public int getHighestPossibleMeta()

getMaxInteractionDistance

public double getMaxInteractionDistance(IWorld world,
                                        int x,
                                        int y,
                                        TileLayer layer,
                                        double mouseX,
                                        double mouseY,
                                        AbstractEntityPlayer player,
                                        ItemInstance instance)

canHoldButtonToAttack

public boolean canHoldButtonToAttack(IWorld world,
                                     double mouseX,
                                     double mouseY,
                                     AbstractEntityPlayer player,
                                     ItemInstance instance)

getCustomAttackableEntities

public java.util.List<Entity> getCustomAttackableEntities(IWorld world,
                                                          double mouseX,
                                                          double mouseY,
                                                          AbstractEntityPlayer player,
                                                          ItemInstance instance)

onEntityAttack

public boolean onEntityAttack(IWorld world,
                              double mouseX,
                              double mouseY,
                              AbstractEntityPlayer player,
                              Entity entity,
                              ItemInstance instance)

getAttackDamage

public int getAttackDamage(IWorld world,
                           Entity entity,
                           double mouseX,
                           double mouseY,
                           AbstractEntityPlayer player,
                           ItemInstance instance)

getAttackCooldown

public int getAttackCooldown(IWorld world,
                             double mouseX,
                             double mouseY,
                             AbstractEntityPlayer player,
                             ItemInstance instance)

attacksMultipleEntities

public boolean attacksMultipleEntities(IWorld world,
                                       double mouseX,
                                       double mouseY,
                                       AbstractEntityPlayer player,
                                       ItemInstance instance)

useMetaAsDurability

public boolean useMetaAsDurability()

takeDamage

public void takeDamage(ItemInstance instance,
                       AbstractEntityPlayer player,
                       int amount)

takeDamage

public ItemInstance takeDamage(ItemInstance instance,
                               int amount)