keith
/
ForgePatch
1
0
Fork 0
Code Issues Pull Requests Projects Releases 2 Wiki Activity

Update docs for ItemTooltipEvent

This commit is contained in:
mezz 2018-03-21 20:11:17 -07:00
parent cf43250584
commit f9a2695662
2 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/java/net/minecraftforge/event/ForgeEventFactory.java
View File

@ -317,7 +317,7 @@ public class ForgeEventFactory
return event.getDropChance();
}
public static ItemTooltipEvent onItemTooltip(ItemStack itemStack, EntityPlayer entityPlayer, List<String> toolTip, ITooltipFlag flags)
public static ItemTooltipEvent onItemTooltip(ItemStack itemStack, @Nullable EntityPlayer entityPlayer, List<String> toolTip, ITooltipFlag flags)
{
ItemTooltipEvent event = new ItemTooltipEvent(itemStack, entityPlayer, toolTip, flags);
MinecraftForge.EVENT_BUS.post(event);

17
src/main/java/net/minecraftforge/event/entity/player/ItemTooltipEvent.java
View File

@ -21,11 +21,13 @@ package net.minecraftforge.event.entity.player;
import java.util.List;
import net.minecraft.client.Minecraft;
import net.minecraft.client.util.ITooltipFlag;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.item.ItemStack;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
public class ItemTooltipEvent extends PlayerEvent
{
@ -35,9 +37,10 @@ public class ItemTooltipEvent extends PlayerEvent
private final List<String> toolTip;
/**
* This event is fired in {@link ItemStack#getTooltip(EntityPlayer, boolean)}, which in turn is called from it's respective GUIContainer.
* This event is fired in {@link 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 {@link Minecraft#populateSearchTreeManager()}.
*/
public ItemTooltipEvent(@Nonnull ItemStack itemStack, EntityPlayer entityPlayer, List<String> toolTip, ITooltipFlag flags)
public ItemTooltipEvent(@Nonnull ItemStack itemStack, @Nullable EntityPlayer entityPlayer, List<String> toolTip, ITooltipFlag flags)
{
super(entityPlayer);
this.itemStack = itemStack;
@ -69,4 +72,14 @@ public class ItemTooltipEvent extends PlayerEvent
{
return toolTip;
}
/**
* This event is fired with a null player during startup when populating search trees for tooltips.
*/
@Override
@Nullable
public EntityPlayer getEntityPlayer()
{
return super.getEntityPlayer();
}
}