Package mcp.mobius.waila.api

Interface ITooltip

@ClientOnly
@NonExtendable
public interface ITooltip

The tooltip object that Waila will show.

Method Summary

Modifier and Type	Method	Description
ITooltipLine	addLine()	Add a new line to the tooltip.
default void	addLine(ITooltipComponent component)	Add a new line to the tooltip.
default void	addLine(Component component)	Add a new line to the tooltip.
ITooltipLine	getLine(int index)	Returns the line on this index.
@Nullable ITooltipLine	getLine(ResourceLocation tag)	Returns the line with specified tag, if any.
int	getLineCount()
ITooltipLine	setLine(ResourceLocation tag)	Replace the line that has the tag with a new line.
default void	setLine(ResourceLocation tag, ITooltipComponent component)	Replace the line that has the tag with a new line.
default void	setLine(ResourceLocation tag, Component component)	Replace the line that has the tag with a new line.

Method Details

getLineCount

int getLineCount()

getLine

ITooltipLine getLine(int index)

Returns the line on this index.

Note: position dependant, you can't access head tooltip in appendBody. To access all tooltip, use IEventListener.onHandleTooltip(mcp.mobius.waila.api.ITooltip, mcp.mobius.waila.api.ICommonAccessor, mcp.mobius.waila.api.IPluginConfig).

addLine

ITooltipLine addLine()

Add a new line to the tooltip.

setLine

ITooltipLine setLine(ResourceLocation tag)

Replace the line that has the tag with a new line.

See Also:

• WailaConstants

getLine

@Nullable
@Nullable ITooltipLine getLine(ResourceLocation tag)

Returns the line with specified tag, if any.

See Also:

• WailaConstants

addLine

default void addLine(Component component)

Add a new line to the tooltip.

addLine

default void addLine(ITooltipComponent component)

Add a new line to the tooltip.

setLine

default void setLine(ResourceLocation tag,
 Component component)

Replace the line that has the tag with a new line.

See Also:

• WailaConstants

setLine

default void setLine(ResourceLocation tag,
 ITooltipComponent component)

Replace the line that has the tag with a new line.

See Also:

• WailaConstants