Package net.minecraft.world.item

Class BrushItem

java.lang.Object

net.minecraft.world.item.Item

net.minecraft.world.item.BrushItem

All Implemented Interfaces:

FeatureElement, ItemLike, IItemExtension

public class BrushItem
extends Item

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final record	BrushItem.DustParticlesDelta

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

Item.Properties, Item.TooltipContext

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ANIMATION_DURATION
private static final int	USE_DURATION

Fields inherited from class net.minecraft.world.item.Item

ABSOLUTE_MAX_STACK_SIZE, BASE_ATTACK_DAMAGE_ID, BASE_ATTACK_SPEED_ID, BY_BLOCK, canRepair, DEFAULT_MAX_STACK_SIZE, MAX_BAR_WIDTH

Fields inherited from interface net.minecraft.world.flag.FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
BrushItem(Item.Properties pProperties)

Method Summary

Modifier and Type	Method	Description
private HitResult	calculateHitResult(Player pPlayer)
boolean	canPerformAction(ItemStack stack, ItemAbility itemAbility)	Queries if an item can perform the given action.
UseAnim	getUseAnimation(ItemStack pStack)	Returns the action that specifies what animation to play when the item is being used.
int	getUseDuration(ItemStack pStack, LivingEntity pEntity)
void	onUseTick(Level pLevel, LivingEntity pLivingEntity, ItemStack pStack, int pRemainingUseDuration)	Called as the item is being used by an entity.
private void	spawnDustParticles(Level pLevel, BlockHitResult pHitResult, BlockState pState, Vec3 pPos, HumanoidArm pArm)
InteractionResult	useOn(UseOnContext pContext)	Called when this item is used when targeting a Block

Methods inherited from class net.minecraft.world.item.Item

appendHoverText, asItem, builtInRegistryHolder, byBlock, byId, canAttackBlock, canFitInsideContainerItems, components, finishUsingItem, getAttackDamageBonus, getBarColor, getBarWidth, getBreakingSound, getCraftingRemainingItem, getDefaultAttributeModifiers, getDefaultInstance, getDefaultMaxStackSize, getDescription, getDescriptionId, getDescriptionId, getDestroySpeed, getDrinkingSound, getEatingSound, getEnchantmentValue, getId, getName, getOrCreateDescriptionId, getPlayerPOVHitResult, getTooltipImage, hasCraftingRemainingItem, hurtEnemy, initializeClient, interactLivingEntity, inventoryTick, isBarVisible, isComplex, isCorrectToolForDrops, isEnchantable, isFoil, isRepairable, isValidRepairItem, mineBlock, modifyDefaultComponentsFrom, onCraftedBy, onCraftedPostProcess, onDestroyed, overrideOtherStackedOnMe, overrideStackedOnOther, postHurtEnemy, releaseUsing, requiredFeatures, toString, use, useOnRelease, verifyComponentsAfterLoad

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.world.flag.FeatureElement

isEnabled

Methods inherited from interface net.neoforged.neoforge.common.extensions.IItemExtension

applyEnchantments, canBeHurtBy, canContinueUsing, canDisableShield, canElytraFly, canEquip, canGrindstoneRepair, canWalkOnPowderedSnow, createEntity, damageItem, doesSneakBypassUse, elytraFlightTick, getAllEnchantments, getArmorTexture, getBurnTime, getCraftingRemainingItem, getCreatorModId, getDamage, getDefaultAttributeModifiers, getEnchantmentLevel, getEnchantmentValue, getEntityLifespan, getEquipmentSlot, getFoodProperties, getHighlightTip, getMaxDamage, getMaxStackSize, getSweepHitBox, getXpRepairRatio, hasCraftingRemainingItem, hasCustomEntity, isBookEnchantable, isDamageable, isDamaged, isEnderMask, isNotReplaceableByPickAction, isPiglinCurrency, isPrimaryItemFor, makesPiglinsNeutral, onAnimalArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, onEntitySwing, onEntitySwing, onItemUseFirst, onLeftClickEntity, onStopUsing, setDamage, shouldCauseBlockBreakReset, shouldCauseReequipAnimation, supportsEnchantment

Field Details

ANIMATION_DURATION

public static final int ANIMATION_DURATION

See Also:

• Constant Field Values

USE_DURATION

private static final int USE_DURATION

See Also:

• Constant Field Values

Constructor Details

BrushItem

public BrushItem(Item.Properties pProperties)

Method Details

useOn

public InteractionResult useOn(UseOnContext pContext)

Called when this item is used when targeting a Block

Overrides:

useOn in class Item

getUseAnimation

public UseAnim getUseAnimation(ItemStack pStack)

Returns the action that specifies what animation to play when the item is being used.

Overrides:

getUseAnimation in class Item

getUseDuration

public int getUseDuration(ItemStack pStack,
 LivingEntity pEntity)

Overrides:

getUseDuration in class Item

onUseTick

public void onUseTick(Level pLevel,
 LivingEntity pLivingEntity,
 ItemStack pStack,
 int pRemainingUseDuration)

Called as the item is being used by an entity.

Overrides:

onUseTick in class Item

calculateHitResult

private HitResult calculateHitResult(Player pPlayer)

spawnDustParticles

private void spawnDustParticles(Level pLevel,
 BlockHitResult pHitResult,
 BlockState pState,
 Vec3 pPos,
 HumanoidArm pArm)

canPerformAction

public boolean canPerformAction(ItemStack stack,
 ItemAbility itemAbility)

Description copied from interface: IItemExtension

Queries if an item can perform the given action. See ItemAbilities for a description of each stock action

Parameters:

stack - The stack being used

itemAbility - The action being queried

Returns:

True if the stack can perform the action