Package net.minecraft.item

Class OnAStickItem<T extends Entity & ItemSteerable>

java.lang.Object

net.minecraft.item.Item

net.minecraft.item.OnAStickItem<T>

All Implemented Interfaces:

ItemConvertible, ToggleableFeature

public class OnAStickItem<T extends Entity & ItemSteerable>
extends Item

Mappings:

Namespace	Name
named	net/minecraft/item/OnAStickItem
intermediary	net/minecraft/class_1758
official	ctz

Nested Class Summary

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

Item.Settings, Item.TooltipContext

Field Summary

Fields

Modifier and Type	Field	Description
private final int	damagePerUse
private final EntityType<T>	target

Fields inherited from class net.minecraft.item.Item

ATTACK_DAMAGE_MODIFIER_ID, ATTACK_SPEED_MODIFIER_ID, BLOCK_ITEMS, DEFAULT_MAX_COUNT, ITEM_BAR_STEPS, MAX_MAX_COUNT

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

FEATURE_ENABLED_REGISTRY_KEYS

Constructor Summary

Constructors

Constructor	Description
OnAStickItem(Item.Settings settings, EntityType<T> target, int damagePerUse)

Method Summary

Modifier and Type	Method	Description
TypedActionResult<ItemStack>	use(World world, PlayerEntity user, Hand hand)	Called when the player uses (or starts using) the item.

Methods inherited from class net.minecraft.item.Item

appendTooltip, asItem, byRawId, canBeNested, canMine, canRepair, finishUsing, fromBlock, getAttributeModifiers, getBonusAttackDamage, getBreakSound, getComponents, getDefaultStack, getDrinkSound, getEatSound, getEnchantability, getItemBarColor, getItemBarStep, getMaxCount, getMaxUseTime, getMiningSpeed, getName, getName, getOrCreateTranslationKey, getRawId, getRecipeRemainder, getRegistryEntry, getRequiredFeatures, getTooltipData, getTranslationKey, getTranslationKey, getUseAction, hasGlint, hasRecipeRemainder, inventoryTick, isCorrectForDrops, isEnchantable, isItemBarVisible, isNetworkSynced, isUsedOnRelease, onClicked, onCraft, onCraftByPlayer, onItemEntityDestroyed, onStackClicked, onStoppedUsing, postHit, postMine, postProcessComponents, raycast, toString, usageTick, useOnBlock, 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

target

private final EntityType<T extends Entity & ItemSteerable> target

Mappings:

Namespace	Name	Mixin selector
named	target	Lnet/minecraft/item/OnAStickItem;target:Lnet/minecraft/entity/EntityType;
intermediary	field_23253	Lnet/minecraft/class_1758;field_23253:Lnet/minecraft/class_1299;
official	a	Lctz;a:Lbtb;

damagePerUse

private final int damagePerUse

Mappings:

Namespace	Name	Mixin selector
named	damagePerUse	Lnet/minecraft/item/OnAStickItem;damagePerUse:I
intermediary	field_23743	Lnet/minecraft/class_1758;field_23743:I
official	b	Lctz;b:I

Constructor Details

OnAStickItem

public OnAStickItem(Item.Settings settings,
 EntityType<T> target,
 int damagePerUse)

Mappings:

Namespace	Name	Mixin selector
named	<init>	Lnet/minecraft/item/OnAStickItem;<init>(Lnet/minecraft/item/Item$Settings;Lnet/minecraft/entity/EntityType;I)V
intermediary	<init>	Lnet/minecraft/class_1758;<init>(Lnet/minecraft/class_1792$class_1793;Lnet/minecraft/class_1299;I)V
official	<init>	Lctz;<init>(Lcul$a;Lbtb;I)V

Method Details

use

public TypedActionResult<ItemStack> use(World world,
 PlayerEntity user,
 Hand hand)

Called when the player uses (or starts using) the item. The use action, by default, is bound to the right mouse button. This method checks the player's hunger when the item is a food, and will pass in all other cases by default.

If the item can be used for multiple ticks, then this will only be called when the player starts using it. After that, Item.usageTick(net.minecraft.world.World, net.minecraft.entity.LivingEntity, net.minecraft.item.ItemStack, int) is called every tick until the player finishes using the item.

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

Overrides:

use in class Item

Parameters:

world - the world the item was used in

user - the player who used the item

hand - the hand used

Returns:

a typed action result that specifies whether using the item was successful. The action result contains the new item stack that the player's hand will be set to.

Mappings:

Namespace	Name	Mixin selector
named	use	Lnet/minecraft/item/Item;use(Lnet/minecraft/world/World;Lnet/minecraft/entity/player/PlayerEntity;Lnet/minecraft/util/Hand;)Lnet/minecraft/util/TypedActionResult;
intermediary	method_7836	Lnet/minecraft/class_1792;method_7836(Lnet/minecraft/class_1937;Lnet/minecraft/class_1657;Lnet/minecraft/class_1268;)Lnet/minecraft/class_1271;
official	a	Lcul;a(Ldbz;Lcmy;Lbqu;)Lbqw;