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
private static final record	BrushItem.DustParticlesDelta

Nested classes/interfaces inherited from class 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 Item

ABSOLUTE_MAX_STACK_SIZE, APPROXIMATELY_INFINITE_USE_DURATION, BASE_ATTACK_DAMAGE_ID, BASE_ATTACK_SPEED_ID, BY_BLOCK, canCombineRepair, CODEC, CODEC_WITH_BOUND_COMPONENTS, DEFAULT_MAX_STACK_SIZE, descriptionId, MAX_BAR_WIDTH, STREAM_CODEC

Fields inherited from interface FeatureElement

FILTERED_REGISTRIES

Constructor Summary

Constructors

Constructor	Description
BrushItem(Item.Properties properties)

Method Summary

Modifier and Type	Method	Description
private HitResult	calculateHitResult(Player player)
boolean	canPerformAction(ItemInstance stack, ItemAbility itemAbility)	Queries if an item can perform the given action.
ItemUseAnimation	getUseAnimation(ItemStack itemStack)
int	getUseDuration(ItemStack itemStack, LivingEntity user)
void	onUseTick(Level level, LivingEntity livingEntity, ItemStack itemStack, int ticksRemaining)	Called as the item is being used by an entity.
private void	spawnDustParticles(Level level, BlockHitResult hitResult, BlockState state, Vec3 viewVector, HumanoidArm brushingArm)
InteractionResult	useOn(UseOnContext context)	Called when this item is used when targeting a Block

Methods inherited from class Item

appendHoverText, asItem, builtInRegistryHolder, byBlock, byId, canDestroyBlock, canFitInsideContainerItems, components, computeDefaultResource, finishUsingItem, getAttackDamageBonus, getBarColor, getBarWidth, getCraftingRemainder, getDefaultInstance, getDefaultMaxStackSize, getDescriptionId, getDestroySpeed, getId, getItemDamageSource, getName, getPlayerPOVHitResult, getTooltipImage, hurtEnemy, interactLivingEntity, inventoryTick, isBarVisible, isCombineRepairable, isCorrectToolForDrops, isFoil, mineBlock, onCraftedBy, onCraftedPostProcess, onDestroyed, overrideOtherStackedOnMe, overrideStackedOnOther, postHurtEnemy, releaseUsing, requiredFeatures, resetDefaultResource, shouldPrintOpWarning, toString, use, useOnRelease

Methods inherited from class Object

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

Methods inherited from interface FeatureElement

isEnabled

Methods inherited from interface IItemExtension

applyEnchantments, canBeHurtBy, canContinueUsing, canEquip, canFitInsideContainerItems, canGrindstoneRepair, canWalkOnPowderedSnow, createEntity, damageItem, doesSneakBypassUse, getAllEnchantments, getBurnTime, getCraftingRemainder, getCreatorModId, getDamage, getDefaultAttributeModifiers, getEnchantmentLevel, getEntityLifespan, getEquipmentSlot, getHighlightTip, getMaxDamage, getMaxStackSize, getSweepHitBox, getXpRepairRatio, hasCustomEntity, isDamageable, isDamaged, isGazeDisguise, isNotReplaceableByPickAction, isPiglinCurrency, isPrimaryItemFor, makesPiglinsNeutral, onAnimalArmorTick, onDestroyed, onDroppedByPlayer, onEntityItemUpdate, 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 properties)

Method Details

useOn

public InteractionResult useOn(UseOnContext context)

Description copied from class: Item

Called when this item is used when targeting a Block

Overrides:

useOn in class Item

getUseAnimation

public ItemUseAnimation getUseAnimation(ItemStack itemStack)

Overrides:

getUseAnimation in class Item

getUseDuration

public int getUseDuration(ItemStack itemStack,
 LivingEntity user)

Overrides:

getUseDuration in class Item

onUseTick

public void onUseTick(Level level,
 LivingEntity livingEntity,
 ItemStack itemStack,
 int ticksRemaining)

Description copied from class: Item

Called as the item is being used by an entity.

Overrides:

onUseTick in class Item

calculateHitResult

private HitResult calculateHitResult(Player player)

spawnDustParticles

private void spawnDustParticles(Level level,
 BlockHitResult hitResult,
 BlockState state,
 Vec3 viewVector,
 HumanoidArm brushingArm)

canPerformAction

public boolean canPerformAction(ItemInstance 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