Package net.neoforged.neoforge.common

Class ToolActions

java.lang.Object

net.neoforged.neoforge.common.ToolActions

public class ToolActions
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final ToolAction	AXE_DIG	Exposed by axes to allow querying tool behaviours
static final ToolAction	AXE_SCRAPE	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ToolAction, boolean) when an axe wants to scrape oxidization off copper
static final ToolAction	AXE_STRIP	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ToolAction, boolean) when an axe wants to strip a log
static final ToolAction	AXE_WAX_OFF	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ToolAction, boolean) when an axe wants to remove wax out of copper
static final ToolAction	BRUSH_BRUSH	Exposed by brushes to allow querying tool behaviours for items that can brush Suspicious Blocks.
static final Set<ToolAction>	DEFAULT_AXE_ACTIONS
static final Set<ToolAction>	DEFAULT_BRUSH_ACTIONS
static final Set<ToolAction>	DEFAULT_FISHING_ROD_ACTIONS
static final Set<ToolAction>	DEFAULT_HOE_ACTIONS
static final Set<ToolAction>	DEFAULT_PICKAXE_ACTIONS
static final Set<ToolAction>	DEFAULT_SHEARS_ACTIONS
static final Set<ToolAction>	DEFAULT_SHIELD_ACTIONS
static final Set<ToolAction>	DEFAULT_SHOVEL_ACTIONS
static final Set<ToolAction>	DEFAULT_SWORD_ACTIONS
static final Set<ToolAction>	DEFAULT_TRIDENT_ACTIONS
static final ToolAction	FISHING_ROD_CAST	This action corresponds to right-clicking the fishing rod to reel it in after earlier casting.
static final ToolAction	HOE_DIG	Exposed by hoes to allow querying tool behaviours
static final ToolAction	HOE_TILL	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ToolAction, boolean) when a hoe wants to turn dirt into soil
static final ToolAction	PICKAXE_DIG	Exposed by pickaxes to allow querying tool behaviours
static final ToolAction	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 ToolAction	SHEARS_DIG	Exposed by shears to allow querying tool behaviours
static final ToolAction	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 ToolAction	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 ToolAction	SHIELD_BLOCK	A tool action corresponding to the 'block' action of shields.
static final ToolAction	SHOVEL_DIG	Exposed by shovels to allow querying tool behaviours
static final ToolAction	SHOVEL_FLATTEN	Passed onto IBlockExtension.getToolModifiedState(net.minecraft.world.level.block.state.BlockState, net.minecraft.world.item.context.UseOnContext, net.neoforged.neoforge.common.ToolAction, boolean) when a shovel wants to turn dirt into path
static final ToolAction	SWORD_DIG	Exposed by swords to allow querying tool behaviours
static final ToolAction	SWORD_SWEEP	Used during player attack to figure out if a sweep attack should be performed
static final ToolAction	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
ToolActions()

Method Summary

Modifier and Type	Method	Description
private static Set<ToolAction>	of(ToolAction... 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 ToolAction AXE_DIG

Exposed by axes to allow querying tool behaviours

PICKAXE_DIG

public static final ToolAction PICKAXE_DIG

Exposed by pickaxes to allow querying tool behaviours

SHOVEL_DIG

public static final ToolAction SHOVEL_DIG

Exposed by shovels to allow querying tool behaviours

HOE_DIG

public static final ToolAction HOE_DIG

Exposed by hoes to allow querying tool behaviours

SWORD_DIG

public static final ToolAction SWORD_DIG

Exposed by swords to allow querying tool behaviours

SHEARS_DIG

public static final ToolAction SHEARS_DIG

Exposed by shears to allow querying tool behaviours

AXE_STRIP

public static final ToolAction AXE_STRIP

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

AXE_SCRAPE

public static final ToolAction AXE_SCRAPE

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

AXE_WAX_OFF

public static final ToolAction AXE_WAX_OFF

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

SHOVEL_FLATTEN

public static final ToolAction SHOVEL_FLATTEN

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

SWORD_SWEEP

public static final ToolAction 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 ToolAction 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

SHEARS_CARVE

public static final ToolAction 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 o a pumpkin to carve it

SHEARS_DISARM

public static final ToolAction 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.

HOE_TILL

public static final ToolAction HOE_TILL

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

SHIELD_BLOCK

public static final ToolAction SHIELD_BLOCK

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

FISHING_ROD_CAST

public static final ToolAction 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 ToolAction 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 ToolAction BRUSH_BRUSH

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

DEFAULT_AXE_ACTIONS

public static final Set<ToolAction> DEFAULT_AXE_ACTIONS

DEFAULT_HOE_ACTIONS

public static final Set<ToolAction> DEFAULT_HOE_ACTIONS

DEFAULT_SHOVEL_ACTIONS

public static final Set<ToolAction> DEFAULT_SHOVEL_ACTIONS

DEFAULT_PICKAXE_ACTIONS

public static final Set<ToolAction> DEFAULT_PICKAXE_ACTIONS

DEFAULT_SWORD_ACTIONS

public static final Set<ToolAction> DEFAULT_SWORD_ACTIONS

DEFAULT_SHEARS_ACTIONS

public static final Set<ToolAction> DEFAULT_SHEARS_ACTIONS

DEFAULT_SHIELD_ACTIONS

public static final Set<ToolAction> DEFAULT_SHIELD_ACTIONS

DEFAULT_FISHING_ROD_ACTIONS

public static final Set<ToolAction> DEFAULT_FISHING_ROD_ACTIONS

DEFAULT_TRIDENT_ACTIONS

public static final Set<ToolAction> DEFAULT_TRIDENT_ACTIONS

DEFAULT_BRUSH_ACTIONS

public static final Set<ToolAction> DEFAULT_BRUSH_ACTIONS

Constructor Details

ToolActions

public ToolActions()

Method Details

of

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