org.cloudburstmc.server.item.behavior

Class ItemBehavior

java.lang.Object

org.cloudburstmc.server.item.behavior.ItemBehavior

All Implemented Interfaces:

Cloneable

public abstract class ItemBehavior
extends Object
implements Cloneable

author: MagicDroidX Nukkit Project

Constructor Summary

Constructors

Constructor and Description
ItemBehavior()

Method Summary

Modifier and Type	Method and Description
boolean	canBeActivated(ItemStack item)
boolean	canBePlaced(ItemStack item)
boolean	canDestroy(ItemStack item, Identifier type)
boolean	canPlaceOn(ItemStack item, Identifier type)
int	getArmorPoints(ItemStack item)
int	getAttackDamage(ItemStack item)
BlockState	getBlock(ItemStack item)
int	getEnchantAbility(ItemStack item)
int	getFuelTime(ItemStack item)
int	getMaxDurability(ItemStack item)
int	getMaxStackSize(ItemStack item)
Optional<TierType>	getTier(ItemStack item)
int	getToughness(ItemStack item)
boolean	isTool(ItemStack item)
boolean	onActivate(ItemStack item, Level level, Player player, Block block, Block target, Direction face, com.nukkitx.math.vector.Vector3f clickPos)
boolean	onClickAir(ItemStack item, Player player, com.nukkitx.math.vector.Vector3f directionVector) Called when a player uses the item on air, for example throwing a projectile.
boolean	onRelease(ItemStack item, Player player, int ticksUsed)
boolean	onUse(ItemStack item, Player player, int ticksUsed)
boolean	useOn(ItemStack item, Block block)
boolean	useOn(ItemStack item, Entity entity)

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemBehavior

public ItemBehavior()

Method Detail

canBeActivated

public boolean canBeActivated(ItemStack item)

canPlaceOn

public boolean canPlaceOn(ItemStack item,
                          Identifier type)

canDestroy

public boolean canDestroy(ItemStack item,
                          Identifier type)

canBePlaced

public final boolean canBePlaced(ItemStack item)

getBlock

public BlockState getBlock(ItemStack item)

getMaxStackSize

public int getMaxStackSize(ItemStack item)

getFuelTime

public final int getFuelTime(ItemStack item)

useOn

public boolean useOn(ItemStack item,
                     Entity entity)

useOn

public boolean useOn(ItemStack item,
                     Block block)

isTool

public boolean isTool(ItemStack item)

getMaxDurability

public int getMaxDurability(ItemStack item)

getTier

public Optional<TierType> getTier(ItemStack item)

getEnchantAbility

public int getEnchantAbility(ItemStack item)

getAttackDamage

public int getAttackDamage(ItemStack item)

getArmorPoints

public int getArmorPoints(ItemStack item)

getToughness

public int getToughness(ItemStack item)

onUse

public boolean onUse(ItemStack item,
                     Player player,
                     int ticksUsed)

onRelease

public boolean onRelease(ItemStack item,
                         Player player,
                         int ticksUsed)

onActivate

public boolean onActivate(ItemStack item,
                          Level level,
                          Player player,
                          Block block,
                          Block target,
                          Direction face,
                          com.nukkitx.math.vector.Vector3f clickPos)

onClickAir

public boolean onClickAir(ItemStack item,
                          Player player,
                          com.nukkitx.math.vector.Vector3f directionVector)

Called when a player uses the item on air, for example throwing a projectile. Returns whether the item was changed, for example count decrease or durability change.

Parameters:

player - player

directionVector - direction

Returns:

item changed