java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.entity.player.ItemTooltipEvent

public class ItemTooltipEvent extends PlayerEvent

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.player.PlayerEvent
PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, 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.minecraftforge.event.entity.living.LivingEvent
LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent
EntityEvent.CanUpdate, EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event
net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result
Field Summary

Fields

Modifier and Type

Field

Description

private final TooltipFlag

flags

private final ItemStack

itemStack

private final List<Component>

toolTip
Constructor Summary

Constructors

Constructor

Description

ItemTooltipEvent(ItemStack itemStack, Player entityPlayer, List<Component> list, TooltipFlag flags)

This event is fired in ItemStack.getTooltipLines(Player, TooltipFlag), which in turn is called from it's respective GUIContainer.
Method Summary

Modifier and Type

Method

Description

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.

Player

getPlayer()

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

List<Component>

getToolTip()

The ItemStack tooltip.

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent
getEntityLiving

Methods inherited from class net.minecraftforge.event.entity.EntityEvent
getEntity

Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getParentListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

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
  
  @Nonnull private final ItemStack itemStack
- toolTip
  
  private final List<Component> toolTip
Constructor Details
- ItemTooltipEvent
  
  public ItemTooltipEvent(@Nonnull ItemStack itemStack, @Nullable Player entityPlayer, List<Component> list, TooltipFlag flags)
  
  This event is fired in ItemStack.getTooltipLines(Player, TooltipFlag), which in turn is called from it's respective GUIContainer. Tooltips are also gathered with a null entityPlayer during startup by 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
  
  @Nonnull public ItemStack getItemStack()
  
  The ItemStack with the tooltip.
- getToolTip
  
  public List<Component> getToolTip()
  
  The ItemStack tooltip.
- getPlayer
  
  @Nullable public Player getPlayer()
  
  This event is fired with a null player during startup when populating search trees for tooltips.
  
  Overrides:
  
  getPlayer in class PlayerEvent
  
  Returns:
  
  Player

Class ItemTooltipEvent

Nested Class Summary

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

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

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

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

Field Summary

Constructor Summary

Method Summary

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent

Methods inherited from class net.minecraftforge.event.entity.EntityEvent

Methods inherited from class net.minecraftforge.eventbus.api.Event

Methods inherited from class java.lang.Object

Field Details

flags

itemStack

toolTip

Constructor Details

ItemTooltipEvent

Method Details

getFlags

getItemStack

getToolTip

getPlayer