codechicken.nei.guihook

Interface IContainerTooltipHandler

All Known Implementing Classes:

GuiCraftingRecipe, GuiRecipe, GuiUsageRecipe, LayoutManager, TemplateRecipeHandler.RecipeTransferRectHandler

public interface IContainerTooltipHandler

If this interface is implemented by a GuiContainer then it will be the first handler delegated to but handleItmeDisplayName will not be called

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	handleItemDisplayName(net.minecraft.client.gui.inventory.GuiContainer gui, ItemStack itemstack, java.util.List<java.lang.String> currenttip) Use this for modifying the multiline display name of an item which may not necessarily be under the mouse.
java.util.List<java.lang.String>	handleItemTooltip(net.minecraft.client.gui.inventory.GuiContainer gui, ItemStack itemstack, int mousex, int mousey, java.util.List<java.lang.String> currenttip) Use this for modifying the tooltips of items that are under the mouse.
java.util.List<java.lang.String>	handleTooltip(net.minecraft.client.gui.inventory.GuiContainer gui, int mousex, int mousey, java.util.List<java.lang.String> currenttip) Use this to add tooltips for other objects.

Method Detail

handleTooltip

java.util.List<java.lang.String> handleTooltip(net.minecraft.client.gui.inventory.GuiContainer gui,
                                               int mousex,
                                               int mousey,
                                               java.util.List<java.lang.String> currenttip)

Use this to add tooltips for other objects. If the current tip has lines in it after this call, the item tootip will not be handled. GuiContainerManager.shouldShowTooltip is not enforced here. It is recommended that you make this check yourself

Parameters:

gui - An instance of the currentscreen

mousex - The x position of the mouse in pixels from left

mousey - The y position of the mouse in pixels from top

currenttip - A list of strings, representing each line of the current tooltip as modified by other handlers

Returns:

The modified list. NOTE: Do not return null

handleItemDisplayName

java.util.List<java.lang.String> handleItemDisplayName(net.minecraft.client.gui.inventory.GuiContainer gui,
                                                       ItemStack itemstack,
                                                       java.util.List<java.lang.String> currenttip)

Use this for modifying the multiline display name of an item which may not necessarily be under the mouse. GuiContainerManager.shouldShowTooltip is enforced here.

Parameters:

gui - An instance of the currentscreen. If only general information about the item is wanted (Eg. potion effects) then this may be null.

itemstack - The ItemStack under the mouse

currenttip - A list of strings, representing each line of the current tooltip as modified by other handlers

Returns:

The modified list. NOTE: Do not return null

handleItemTooltip

java.util.List<java.lang.String> handleItemTooltip(net.minecraft.client.gui.inventory.GuiContainer gui,
                                                   ItemStack itemstack,
                                                   int mousex,
                                                   int mousey,
                                                   java.util.List<java.lang.String> currenttip)

Use this for modifying the tooltips of items that are under the mouse. GuiContainerManager.shouldShowTooltip is enforced here.

Parameters:

gui - An instance of the currentscreen

itemstack - The ItemStack under the mouse

currenttip - A list of strings, representing each line of the current tooltip as modified by other handlers

Returns:

The modified list. NOTE: Do not return null