net.minecraftforge.event.entity.player

Class ItemTooltipEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.entity.EntityEvent

net.minecraftforge.event.entity.living.LivingEvent

net.minecraftforge.event.entity.player.PlayerEvent

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.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.Visibility

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

LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent

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

EntityEvent.CanUpdate, EntityEvent.EnteringChunk, EntityEvent.EntityConstructing, EntityEvent.EyeHeight

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 and Description
private ITooltipFlag	flags
private ItemStack	itemStack
private java.util.List<ITextComponent>	toolTip

Constructor Summary

Constructors

Constructor and Description
ItemTooltipEvent(ItemStack itemStack, PlayerEntity entityPlayer, java.util.List<ITextComponent> list, ITooltipFlag flags) This event is fired in ItemStack#getTooltip(EntityPlayer, ITooltipFlag), which in turn is called from it's respective GUIContainer.

Method Summary

Modifier and Type	Method and Description
ITooltipFlag	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.
PlayerEntity	getPlayer() This event is fired with a null player during startup when populating search trees for tooltips.
java.util.List<ITextComponent>	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 Detail

flags

private final ITooltipFlag flags

itemStack

@Nonnull
private final ItemStack itemStack

toolTip

private final java.util.List<ITextComponent> toolTip

Constructor Detail

ItemTooltipEvent

public ItemTooltipEvent(@Nonnull
                        ItemStack itemStack,
                        @Nullable
                        PlayerEntity entityPlayer,
                        java.util.List<ITextComponent> list,
                        ITooltipFlag flags)

This event is fired in ItemStack#getTooltip(EntityPlayer, ITooltipFlag), which in turn is called from it's respective GUIContainer. Tooltips are also gathered with a null entityPlayer during startup by Minecraft.populateSearchTreeManager().

Method Detail

getFlags

public ITooltipFlag 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 java.util.List<ITextComponent> getToolTip()

The ItemStack tooltip.

getPlayer

@Nullable
public PlayerEntity getPlayer()

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

Overrides:

getPlayer in class PlayerEvent

Returns:

Player