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

AnvilUpdateEvent is fired whenever the input stacks (left or right) or the name in an anvil changed.
It is called from AnvilMenu.createResult().
If the event is canceled, vanilla behavior will not run, and the output will be set to ItemStack.EMPTY.
If the event is not canceled, but the output is not empty, it will set the output and not run vanilla behavior.
if the output is empty, and the event is not canceled, vanilla behavior will execute.

Field Summary

Fields

Modifier and Type	Field	Description
private long	cost
private final ItemStack	left
private int	materialCost
private final String	name
private ItemStack	output
private final Player	player
private final ItemStack	right

Constructor Summary

Constructors

Constructor	Description
AnvilUpdateEvent(ItemStack left, ItemStack right, String name, long cost, Player player)

Method Summary

Modifier and Type	Method	Description
long	getCost()	This is the level cost of this anvil operation.
ItemStack	getLeft()
int	getMaterialCost()	The material cost is how many units of the right input stack are consumed.
@Nullable String	getName()	This is the name as sent by the client.
ItemStack	getOutput()	This is the output as determined by the event, not by the vanilla behavior between these two items.
Player	getPlayer()
ItemStack	getRight()
void	setCost(long cost)	Changes the level cost of this operation.
void	setMaterialCost(int materialCost)	Sets how many right inputs are consumed.
void	setOutput(ItemStack output)	Sets the output slot to a specific itemstack.

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, setCanceled

Field Details

left

private final ItemStack left

right

private final ItemStack right

name

private final String name

output

private ItemStack output

cost

private long cost

materialCost

private int materialCost

player

private final Player player

Constructor Details

AnvilUpdateEvent

public AnvilUpdateEvent(ItemStack left,
 ItemStack right,
 String name,
 long cost,
 Player player)

Method Details

getLeft

public ItemStack getLeft()

Returns:

The item in the left input (leftmost) anvil slot.

getRight

public ItemStack getRight()

Returns:

The item in the right input (center) anvil 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.

Returns:

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

getOutput

public ItemStack getOutput()

This is the output as determined by the event, not by the vanilla behavior between these two items.
If you are the first receiver of this event, it is guaranteed to be empty.
It will only be non-empty if changed by an event handler.
If this event is cancelled, this output stack is discarded.

Returns:

The item to set in the output (rightmost) anvil slot.

setOutput

public void setOutput(ItemStack output)

Sets the output slot to a specific itemstack.

Parameters:

output - The stack to change the output to.

getCost

public long getCost()

This is the level cost of this anvil operation.
When unchanged, it is guaranteed to be left.getRepairCost() + right.getRepairCost().

Returns:

The level cost of this anvil operation.

setCost

public void setCost(long cost)

Changes the level cost of this operation.
The level cost does prevent the output from being available.
That is, a player without enough experience may not take the output.

Values will be clamped to the range 0 - MAX_INT.

Parameters:

cost - The new level cost.

getMaterialCost

public int getMaterialCost()

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

Returns:

The material cost of this anvil operation.

setMaterialCost

public void setMaterialCost(int materialCost)

Sets how many right inputs are consumed.
A material cost of zero consumes the entire stack.
A material cost higher than the count of the right stack consumes the entire stack.
The material cost 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.