Package net.minecraft.item

Class BrushItem

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.BrushItem

All Implemented Interfaces:

ItemConvertible, ToggleableFeature

public class BrushItem
extends Item

Mappings:

Namespace	Name
official	cdx
intermediary	net/minecraft/class_8162
named	net/minecraft/item/BrushItem

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	BrushItem.DustParticlesOffset

Nested classes/interfaces inherited from class net.minecraft.item.Item

Item.Settings

Field Summary

Fields

Modifier and Type	Field	Description
static final int	field_42682
private static final int	field_42683

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, DEFAULT_MAX_USE_TIME, ITEM_BAR_STEPS

Fields inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

FEATURE_ENABLED_REGISTRY_KEYS

Constructor Summary

Constructors

Constructor	Description
BrushItem(Item.Settings settings)

Method Summary

Modifier and Type	Method	Description
void	addDustParticles(World world, BlockHitResult hitResult, BlockState state, Vec3d userRotation)
int	getMaxUseTime(ItemStack stack)	Returns the maximum use (right-click) time of this item, in ticks.
UseAction	getUseAction(ItemStack stack)	Returns the use action the item should perform.
void	usageTick(World world, LivingEntity user, ItemStack stack, int remainingUseTicks)	Called on both the server and the client every tick while an entity uses the item.
ActionResult	useOnBlock(ItemUsageContext context)	Called when an item is used on a block.

Methods inherited from class net.minecraft.item.Item

appendTooltip, asItem, byRawId, canBeNested, canMine, canRepair, damage, finishUsing, fromBlock, getAttributeModifiers, getDefaultStack, getDrinkSound, getEatSound, getEnchantability, getFoodComponent, getItemBarColor, getItemBarStep, getMaxCount, getMaxDamage, getMiningSpeedMultiplier, getName, getName, getOrCreateTranslationKey, getRarity, getRawId, getRecipeRemainder, getRegistryEntry, getRequiredFeatures, getTooltipData, getTranslationKey, getTranslationKey, hasGlint, hasRecipeRemainder, inventoryTick, isDamageable, isEnchantable, isFireproof, isFood, isItemBarVisible, isNbtSynced, isNetworkSynced, isSuitableFor, isUsedOnRelease, onClicked, onCraft, onItemEntityDestroyed, onStackClicked, onStoppedUsing, postHit, postMine, postProcessNbt, raycast, toString, use, useOnEntity

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.resource.featuretoggle.ToggleableFeature

isEnabled

Field Details

field_42682

public static final int field_42682

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	a	Lcdx;a:I
intermediary	field_42682	Lnet/minecraft/class_8162;field_42682:I
named	field_42682	Lnet/minecraft/item/BrushItem;field_42682:I

field_42683

private static final int field_42683

See Also:

• Constant Field Values

Mappings:

Namespace	Name	Mixin selector
official	b	Lcdx;b:I
intermediary	field_42683	Lnet/minecraft/class_8162;field_42683:I
named	field_42683	Lnet/minecraft/item/BrushItem;field_42683:I

Constructor Details

BrushItem

public BrushItem(Item.Settings settings)

Mappings:

Namespace	Name	Mixin selector
official	<init>	Lcfq;<init>(Lcfq$a;)V
intermediary	<init>	Lnet/minecraft/class_1792;<init>(Lnet/minecraft/class_1792$class_1793;)V
named	<init>	Lnet/minecraft/item/Item;<init>(Lnet/minecraft/item/Item$Settings;)V

Method Details

useOnBlock

public ActionResult useOnBlock(ItemUsageContext context)

Called when an item is used on a block.

This method is called on both the logical client and logical server, so take caution when using this method. The logical side can be checked using context.getWorld().isClient().

Overrides:

useOnBlock in class Item

Parameters:

context - the usage context

Returns:

an action result that specifies if using the item on a block was successful.

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfq;a(Lcie;)Lbdy;
intermediary	method_7884	Lnet/minecraft/class_1792;method_7884(Lnet/minecraft/class_1838;)Lnet/minecraft/class_1269;
named	useOnBlock	Lnet/minecraft/item/Item;useOnBlock(Lnet/minecraft/item/ItemUsageContext;)Lnet/minecraft/util/ActionResult;

getUseAction

public UseAction getUseAction(ItemStack stack)

Returns the use action the item should perform.

Overrides:

getUseAction in class Item

Returns:

the use action the item should perform

Mappings:

Namespace	Name	Mixin selector
official	c	Lcfq;c(Lcfv;)Lchn;
intermediary	method_7853	Lnet/minecraft/class_1792;method_7853(Lnet/minecraft/class_1799;)Lnet/minecraft/class_1839;
named	getUseAction	Lnet/minecraft/item/Item;getUseAction(Lnet/minecraft/item/ItemStack;)Lnet/minecraft/util/UseAction;

getMaxUseTime

public int getMaxUseTime(ItemStack stack)

Returns the maximum use (right-click) time of this item, in ticks. Once a player has used an item for said number of ticks, they stop using it, and Item.finishUsing(net.minecraft.item.ItemStack, net.minecraft.world.World, net.minecraft.entity.LivingEntity) is called.

Overrides:

getMaxUseTime in class Item

Returns:

the maximum use (right-click) time of this item, in ticks

Mappings:

Namespace	Name	Mixin selector
official	b	Lcfq;b(Lcfv;)I
intermediary	method_7881	Lnet/minecraft/class_1792;method_7881(Lnet/minecraft/class_1799;)I
named	getMaxUseTime	Lnet/minecraft/item/Item;getMaxUseTime(Lnet/minecraft/item/ItemStack;)I

usageTick

public void usageTick(World world,
 LivingEntity user,
 ItemStack stack,
 int remainingUseTicks)

Called on both the server and the client every tick while an entity uses the item. Currently used by CrossbowItem to charge the crossbow. If this is overridden, Item.getMaxUseTime(net.minecraft.item.ItemStack) should also be overridden to return a positive value.

Overrides:

usageTick in class Item

Parameters:

remainingUseTicks - how long it's left until the entity finishes using the item, in ticks

See Also:

• Item.finishUsing(net.minecraft.item.ItemStack, net.minecraft.world.World, net.minecraft.entity.LivingEntity)
• Item.use(net.minecraft.world.World, net.minecraft.entity.player.PlayerEntity, net.minecraft.util.Hand)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcfq;a(Lcmi;Lbfx;Lcfv;I)V
intermediary	method_7852	Lnet/minecraft/class_1792;method_7852(Lnet/minecraft/class_1937;Lnet/minecraft/class_1309;Lnet/minecraft/class_1799;I)V
named	usageTick	Lnet/minecraft/item/Item;usageTick(Lnet/minecraft/world/World;Lnet/minecraft/entity/LivingEntity;Lnet/minecraft/item/ItemStack;I)V

addDustParticles

public void addDustParticles(World world,
 BlockHitResult hitResult,
 BlockState state,
 Vec3d userRotation)

Mappings:

Namespace	Name	Mixin selector
official	a	Lcdx;a(Lcmi;Leda;Ldbq;Lede;)V
intermediary	method_49184	Lnet/minecraft/class_8162;method_49184(Lnet/minecraft/class_1937;Lnet/minecraft/class_3965;Lnet/minecraft/class_2680;Lnet/minecraft/class_243;)V
named	addDustParticles	Lnet/minecraft/item/BrushItem;addDustParticles(Lnet/minecraft/world/World;Lnet/minecraft/util/hit/BlockHitResult;Lnet/minecraft/block/BlockState;Lnet/minecraft/util/math/Vec3d;)V