Package net.neoforged.neoforge.event

Class AddAttributeTooltipsEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.AddAttributeTooltipsEvent

public class AddAttributeTooltipsEvent
extends net.neoforged.bus.api.Event

This event is fired after attribute tooltip lines have been added to an item stack's tooltip in AttributeUtil.addAttributeTooltips(net.minecraft.world.item.ItemStack, java.util.function.Consumer<net.minecraft.network.chat.Component>, net.minecraft.world.item.component.TooltipDisplay, net.neoforged.neoforge.common.util.AttributeTooltipContext).

It can be used to add additional tooltip lines adjacent to the attribute lines without having to manually locate the inject point.

This event may be fired on both the logical client and logical server.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AttributeTooltipContext	ctx
protected final net.minecraft.world.item.ItemStack	stack
protected final Consumer<net.minecraft.network.chat.Component>	tooltip

Constructor Summary

Constructors

Constructor	Description
AddAttributeTooltipsEvent(net.minecraft.world.item.ItemStack stack, Consumer<net.minecraft.network.chat.Component> tooltip, AttributeTooltipContext ctx)

Method Summary

Modifier and Type	Method	Description
void	addTooltipLines(net.minecraft.network.chat.Component... comps)	Adds one or more Components to the tooltip.
AttributeTooltipContext	getContext()	The current tooltip context.
net.minecraft.world.item.ItemStack	getStack()	The ItemStack with the tooltip.
boolean	shouldShow()	Checks if the attribute tooltips should be shown on the current item stack.

Methods inherited from class java.lang.Object

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

Field Details

stack

protected final net.minecraft.world.item.ItemStack stack

tooltip

protected final Consumer<net.minecraft.network.chat.Component> tooltip

ctx

protected final AttributeTooltipContext ctx

Constructor Details

AddAttributeTooltipsEvent

public AddAttributeTooltipsEvent(net.minecraft.world.item.ItemStack stack,
 Consumer<net.minecraft.network.chat.Component> tooltip,
 AttributeTooltipContext ctx)

Method Details

getContext

public AttributeTooltipContext getContext()

The current tooltip context.

getStack

public net.minecraft.world.item.ItemStack getStack()

The ItemStack with the tooltip.

addTooltipLines

public void addTooltipLines(net.minecraft.network.chat.Component... comps)

Adds one or more Components to the tooltip.

shouldShow

public boolean shouldShow()

Checks if the attribute tooltips should be shown on the current item stack.

This event is fired even if the component would prevent the normal tooltip lines from showing.