Package net.neoforged.neoforge.event

Class AnvilUpdateEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.AnvilUpdateEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class AnvilUpdateEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

This event is fired when an anvil's left input is not empty, and any of the inputs (left, right, or name) are changed.

It is fired after the vanilla result has been computed, and allows for modification (or overriding) of the result.

This event is fired on both the logical server and logical client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AnvilUpdateEvent.VanillaResult	A record packing all the vanilla result data.

Field Summary

Fields

Modifier and Type	Field	Description
private final ItemStack	left
private int	materialCost
private final @Nullable String	name
private ItemStack	output
private final Player	player
private final ItemStack	right
private final AnvilUpdateEvent.VanillaResult	vanillaResult
private int	xpCost

Constructor Summary

Constructors

Constructor	Description
AnvilUpdateEvent(ItemStack left, ItemStack right, @Nullable String name, ItemStack result, int xpCost, int materialCost, Player player)

Method Summary

Modifier and Type	Method	Description
ItemStack	getLeft()	Returns a copy of the item in the left input slot.
int	getMaterialCost()	Returns the material cost of the anvil operation, defaulting to the vanilla cost.
@Nullable String	getName()	This is the name as sent by the client.
ItemStack	getOutput()	Returns a mutable reference to the current output stack, defaulting to the vanilla output.
Player	getPlayer()
ItemStack	getRight()	Returns a copy of the item in the right input slot.
AnvilUpdateEvent.VanillaResult	getVanillaResult()	Returns a view of the vanilla result for the given anvil inputs.
int	getXpCost()	Returns the level cost of the anvil operation, defaulting to the vanilla cost.
void	setCanceled(boolean canceled)	Cancels the event, preventing any further handling.
void	setMaterialCost(int materialCost)	Sets the material cost (how many right inputs are consumed).
void	setOutput(ItemStack output)	Sets the output to the given item stack.
void	setXpCost(int xpCost)	Sets the level cost of the anvil operation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled

Field Details

left

private final ItemStack left

right

private final ItemStack right

name

@Nullable
private final @Nullable String name

vanillaResult

private final AnvilUpdateEvent.VanillaResult vanillaResult

player

private final Player player

output

private ItemStack output

xpCost

private int xpCost

materialCost

private int materialCost

Constructor Details

AnvilUpdateEvent

public AnvilUpdateEvent(ItemStack left,
 ItemStack right,
 @Nullable
 @Nullable String name,
 ItemStack result,
 int xpCost,
 int materialCost,
 Player player)

Method Details

getLeft

public ItemStack getLeft()

Returns a copy of the item in the left input slot.

Returns:

a copy of the item in the left input slot

getRight

public ItemStack getRight()

Returns a copy of the item in the right input slot.

Returns:

a copy of the item in the right input slot

getName

@Nullable
public @Nullable String getName()

This is the name as sent by the client. It may be null if none has been sent. If empty, it indicates the user wishes to clear the custom name from the item.

The server is unable to change the name field, as there is no S2C packet for it.

Returns:

The name that the output item should be set to, if applicable.

getVanillaResult

public AnvilUpdateEvent.VanillaResult getVanillaResult()

Returns a view of the vanilla result for the given anvil inputs.

Returns:

a view of the vanilla result for the given anvil inputs

getOutput

public ItemStack getOutput()

Returns a mutable reference to the current output stack, defaulting to the vanilla output.

If this event is cancelled, this output is ignored.

Returns:

The item that will be set in the output slot.

setOutput

public void setOutput(ItemStack output)

Sets the output to the given item stack.

Parameters:

output - The stack to change the output to.

getXpCost

public int getXpCost()

Returns the level cost of the anvil operation, defaulting to the vanilla cost.

If this event is cancelled, the level cost is ignored.

Returns:

The level cost of the anvil operation.

setXpCost

public void setXpCost(int xpCost)

Sets the level cost of the anvil operation.

Parameters:

cost - The new level cost.

getMaterialCost

public int getMaterialCost()

Returns the material cost of the anvil operation, defaulting to the vanilla cost.

The material cost is how many units of the right input stack are consumed.

Returns:

The material cost of the anvil operation.

setMaterialCost

public void setMaterialCost(int materialCost)

Sets the material cost (how many right inputs are consumed).

A material cost of zero consumes the entire stack (due to vanilla behavior).

A material cost higher than the count of the right stack consumes the entire stack.

The material cost being higher than the right item count does not prevent the output from being available.

Parameters:

materialCost - The new material cost.

getPlayer

public Player getPlayer()

Returns:

The player using this anvil container.

setCanceled

public void setCanceled(boolean canceled)

Cancels the event, preventing any further handling.

When the event is cancelled, the outputs set by this event are ignored, and the anvil will produce no output.

Specified by:

setCanceled in interface net.neoforged.bus.api.ICancellableEvent