Package net.neoforged.neoforge.common

Class ItemAbilities

java.lang.Object

net.neoforged.neoforge.common.ItemAbilities

public class ItemAbilities
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final ItemAbility	AXE_DIG	Exposed by axes to allow querying tool behaviours
static final ItemAbility	AXE_SCRAPE	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when an axe wants to scrape oxidization off copper
static final ItemAbility	AXE_STRIP	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when an axe wants to strip a log
static final ItemAbility	AXE_WAX_OFF	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when an axe wants to remove wax out of copper
static final ItemAbility	BRUSH_BRUSH	Exposed by brushes to allow querying tool behaviours for items that can brush Suspicious Blocks.
static final Set<ItemAbility>	DEFAULT_AXE_ACTIONS
static final Set<ItemAbility>	DEFAULT_BRUSH_ACTIONS
static final Set<ItemAbility>	DEFAULT_FIRECHARGE_ACTIONS
static final Set<ItemAbility>	DEFAULT_FISHING_ROD_ACTIONS
static final Set<ItemAbility>	DEFAULT_FLINT_ACTIONS
static final Set<ItemAbility>	DEFAULT_HOE_ACTIONS
static final Set<ItemAbility>	DEFAULT_PICKAXE_ACTIONS
static final Set<ItemAbility>	DEFAULT_SHEARS_ACTIONS
static final Set<ItemAbility>	DEFAULT_SHIELD_ACTIONS
static final Set<ItemAbility>	DEFAULT_SHOVEL_ACTIONS
static final Set<ItemAbility>	DEFAULT_SWORD_ACTIONS
static final Set<ItemAbility>	DEFAULT_TRIDENT_ACTIONS
static final ItemAbility	FIRESTARTER_LIGHT	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when flint and steel or fire charge want to light a campfire/candle/cake.
static final ItemAbility	FISHING_ROD_CAST	This action corresponds to right-clicking the fishing rod to reel it in after earlier casting.
static final ItemAbility	HOE_DIG	Exposed by hoes to allow querying tool behaviours
static final ItemAbility	HOE_TILL	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when a hoe wants to turn dirt into soil
static final ItemAbility	PICKAXE_DIG	Exposed by pickaxes to allow querying tool behaviours
static final ItemAbility	SHEARS_CARVE	This action is exposed by shears and corresponds to a carve action that is triggered with a right click on a block that supports such behaviour.
static final ItemAbility	SHEARS_DIG	Exposed by shears to allow querying tool behaviours
static final ItemAbility	SHEARS_DISARM	This action is exposed by shears and corresponds to a disarm action that is triggered by breaking a block that supports such behaviour.
static final ItemAbility	SHEARS_HARVEST	This action is exposed by shears and corresponds to a harvest action that is triggered with a right click on a block that supports such behaviour.
static final ItemAbility	SHEARS_REMOVE_ARMOR	This action is exposed by shears and corresponds to a harvest action that is triggered with a right click on armored wolves.
static final ItemAbility	SHEARS_TRIM	This action is exposed by shears and corresponds to a trim action that is triggered with a right click on a block that supports such behavior.
static final ItemAbility	SHIELD_BLOCK	An item ability corresponding to the 'block' action of shields.
static final ItemAbility	SHOVEL_DIG	Exposed by shovels to allow querying tool behaviours
static final ItemAbility	SHOVEL_DOUSE	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when a shovel wants to douse a campfire
static final ItemAbility	SHOVEL_FLATTEN	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when a shovel wants to turn dirt into path
static final ItemAbility	SWORD_DIG	Exposed by swords to allow querying tool behaviours
static final ItemAbility	SWORD_SWEEP	Used during player attack to figure out if a sweep attack should be performed
static final ItemAbility	TRIDENT_THROW	Exposed by trident-like items to allow querying tool behaviours for items that can be thrown like Tridents.

Constructor Summary

Constructors

Constructor	Description
ItemAbilities()

Method Summary

Modifier and Type	Method	Description
private static Set<ItemAbility>	of(ItemAbility... actions)

Methods inherited from class java.lang.Object

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

Field Details

AXE_DIG

public static final ItemAbility AXE_DIG

Exposed by axes to allow querying tool behaviours

PICKAXE_DIG

public static final ItemAbility PICKAXE_DIG

Exposed by pickaxes to allow querying tool behaviours

SHOVEL_DIG

public static final ItemAbility SHOVEL_DIG

Exposed by shovels to allow querying tool behaviours

HOE_DIG

public static final ItemAbility HOE_DIG

Exposed by hoes to allow querying tool behaviours

SWORD_DIG

public static final ItemAbility SWORD_DIG

Exposed by swords to allow querying tool behaviours

SHEARS_DIG

public static final ItemAbility SHEARS_DIG

Exposed by shears to allow querying tool behaviours

AXE_STRIP

public static final ItemAbility AXE_STRIP

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when an axe wants to strip a log

AXE_SCRAPE

public static final ItemAbility AXE_SCRAPE

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when an axe wants to scrape oxidization off copper

AXE_WAX_OFF

public static final ItemAbility AXE_WAX_OFF

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when an axe wants to remove wax out of copper

SHOVEL_FLATTEN

public static final ItemAbility SHOVEL_FLATTEN

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when a shovel wants to turn dirt into path

SHOVEL_DOUSE

public static final ItemAbility SHOVEL_DOUSE

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when a shovel wants to douse a campfire

SWORD_SWEEP

public static final ItemAbility SWORD_SWEEP

Used during player attack to figure out if a sweep attack should be performed

See Also:

• IItemExtension.getSweepHitBox(net.minecraft.world.item.ItemStack, net.minecraft.world.entity.player.Player, net.minecraft.world.entity.Entity)

SHEARS_HARVEST

public static final ItemAbility SHEARS_HARVEST

This action is exposed by shears and corresponds to a harvest action that is triggered with a right click on a block that supports such behaviour. Example: Right click with shears on a beehive with honey level 5 to harvest it.

See Also:

• CommonHooks.tryDispenseShearsHarvestBlock(BlockSource, ItemStack, ServerLevel, BlockPos)

SHEARS_REMOVE_ARMOR

public static final ItemAbility SHEARS_REMOVE_ARMOR

This action is exposed by shears and corresponds to a harvest action that is triggered with a right click on armored wolves.

SHEARS_CARVE

public static final ItemAbility SHEARS_CARVE

This action is exposed by shears and corresponds to a carve action that is triggered with a right click on a block that supports such behaviour. Example: Right click with shears on a pumpkin to carve it.

SHEARS_DISARM

public static final ItemAbility SHEARS_DISARM

This action is exposed by shears and corresponds to a disarm action that is triggered by breaking a block that supports such behaviour. Example: Breaking a trip wire with shears to disarm it.

SHEARS_TRIM

public static final ItemAbility SHEARS_TRIM

This action is exposed by shears and corresponds to a trim action that is triggered with a right click on a block that supports such behavior. Example: Right click with shears on a growing plant to stop it from growing.

HOE_TILL

public static final ItemAbility HOE_TILL

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when a hoe wants to turn dirt into soil

SHIELD_BLOCK

public static final ItemAbility SHIELD_BLOCK

An item ability corresponding to the 'block' action of shields. Items should expose this item ability in order to enable damage blocking when the item is being "used".

FISHING_ROD_CAST

public static final ItemAbility FISHING_ROD_CAST

This action corresponds to right-clicking the fishing rod to reel it in after earlier casting. Needed for modded fishing rods so that the FishingHook entity can properly function.

TRIDENT_THROW

public static final ItemAbility TRIDENT_THROW

Exposed by trident-like items to allow querying tool behaviours for items that can be thrown like Tridents.

BRUSH_BRUSH

public static final ItemAbility BRUSH_BRUSH

Exposed by brushes to allow querying tool behaviours for items that can brush Suspicious Blocks.

FIRESTARTER_LIGHT

public static final ItemAbility FIRESTARTER_LIGHT

Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ItemAbility, boolean) when flint and steel or fire charge want to light a campfire/candle/cake. Note that dispensers with flint and steel will also use this but will have no player.

DEFAULT_AXE_ACTIONS

public static final Set<ItemAbility> DEFAULT_AXE_ACTIONS

DEFAULT_HOE_ACTIONS

public static final Set<ItemAbility> DEFAULT_HOE_ACTIONS

DEFAULT_SHOVEL_ACTIONS

public static final Set<ItemAbility> DEFAULT_SHOVEL_ACTIONS

DEFAULT_PICKAXE_ACTIONS

public static final Set<ItemAbility> DEFAULT_PICKAXE_ACTIONS

DEFAULT_SWORD_ACTIONS

public static final Set<ItemAbility> DEFAULT_SWORD_ACTIONS

DEFAULT_SHEARS_ACTIONS

public static final Set<ItemAbility> DEFAULT_SHEARS_ACTIONS

DEFAULT_SHIELD_ACTIONS

public static final Set<ItemAbility> DEFAULT_SHIELD_ACTIONS

DEFAULT_FISHING_ROD_ACTIONS

public static final Set<ItemAbility> DEFAULT_FISHING_ROD_ACTIONS

DEFAULT_TRIDENT_ACTIONS

public static final Set<ItemAbility> DEFAULT_TRIDENT_ACTIONS

DEFAULT_BRUSH_ACTIONS

public static final Set<ItemAbility> DEFAULT_BRUSH_ACTIONS

DEFAULT_FLINT_ACTIONS

public static final Set<ItemAbility> DEFAULT_FLINT_ACTIONS

DEFAULT_FIRECHARGE_ACTIONS

public static final Set<ItemAbility> DEFAULT_FIRECHARGE_ACTIONS

Constructor Details

ItemAbilities

public ItemAbilities()

Method Details

of

private static Set<ItemAbility> of(ItemAbility... actions)