Package net.neoforged.neoforge.event.entity.player

Class ItemTooltipEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

net.neoforged.neoforge.event.entity.player.ItemTooltipEvent

public class ItemTooltipEvent
extends PlayerEvent

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.player.PlayerEvent

PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private final Item.TooltipContext	context
private final TooltipFlag	flags
private final ItemStack	itemStack
private final List<Component>	toolTip

Constructor Summary

Constructors

Constructor	Description
ItemTooltipEvent(ItemStack itemStack, @Nullable Player player, List<Component> list, TooltipFlag flags, Item.TooltipContext context)	This event is fired in ItemStack.getTooltipLines(TooltipContext, Player, TooltipFlag), which in turn is called from its respective GUIContainer.

Method Summary

Modifier and Type	Method	Description
Item.TooltipContext	getContext()	The tooltip context.
@Nullable Player	getEntity()	This event is fired with a null player during startup when populating search trees for tooltips.
TooltipFlag	getFlags()	Use to determine if the advanced information on item tooltips is being shown, toggled by F3+H.
ItemStack	getItemStack()	The ItemStack with the tooltip.
List<Component>	getToolTip()	The ItemStack tooltip.

Methods inherited from class java.lang.Object

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

Field Details

flags

private final TooltipFlag flags

itemStack

private final ItemStack itemStack

toolTip

private final List<Component> toolTip

context

private final Item.TooltipContext context

Constructor Details

ItemTooltipEvent

public ItemTooltipEvent(ItemStack itemStack,
 @Nullable
 @Nullable Player player,
 List<Component> list,
 TooltipFlag flags,
 Item.TooltipContext context)

This event is fired in ItemStack.getTooltipLines(TooltipContext, Player, TooltipFlag), which in turn is called from its respective GUIContainer. Tooltips are also gathered with a null player during startup by

invalid reference

Minecraft#createSearchTrees()

.

Method Details

getFlags

public TooltipFlag getFlags()

Use to determine if the advanced information on item tooltips is being shown, toggled by F3+H.

getItemStack

public ItemStack getItemStack()

The ItemStack with the tooltip.

getToolTip

public List<Component> getToolTip()

The ItemStack tooltip.

getEntity

@Nullable
public @Nullable Player getEntity()

This event is fired with a null player during startup when populating search trees for tooltips.

Overrides:

getEntity in class PlayerEvent

getContext

public Item.TooltipContext getContext()

The tooltip context.