ItemTooltipEvent

Link to itemtooltipevent

This event is fired whenever a tooltip is calculated.

Note: the player may not always be present, make sure you check if it is null before trying to use it

The event is not cancelable.

The event does not have a result.

Importare la Classe

Link to importare-la-classe

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
Copy
import crafttweaker.api.event.entity.player.ItemTooltipEvent;

Extending PlayerEvent

Link to extending-playerevent

ItemTooltipEvent extends PlayerEvent. That means all methods available in PlayerEvent are also available in ItemTooltipEvent

Name: getFlags

Gets the extra tooltip flags, such as if advanced tooltips should be displayed.

Returns: The tooltip flags
Return Type: TooltipFlag

ZenScript
Copy
// ItemTooltipEvent.getFlags() as TooltipFlag

event.getFlags();

Name: getItemStack

Gets the ItemStack that the tooltip is for.

Returns: The ItemStack that the tooltip is for.
Return Type: ItemStack

ZenScript
Copy
// ItemTooltipEvent.getItemStack() as ItemStack

event.getItemStack();

Name: getPlayer

Gets the player that is viewing the tooltip.

Note: The player can be null

Returns: The player htat is viewing the tooltip.
Return Type: Player?

ZenScript
Copy
// ItemTooltipEvent.getPlayer() as Player?

event.getPlayer();

Name: getToolTip

Gets the list of Components that make up the tooltip.

Returns: The list of Component that make up the tooltip.
Return Type: stdlib.List<Component>

ZenScript
Copy
// ItemTooltipEvent.getToolTip() as stdlib.List<Component>

event.getToolTip();
NomeTipoHa GetterHa SetterDescrizione
Nome
flags
Tipo
TooltipFlag
Ha Getter
Ha Setter
no
Descrizione
Gets the extra tooltip flags, such as if advanced tooltips should be displayed.
Nome
itemStack
Tipo
ItemStack
Ha Getter
Ha Setter
no
Descrizione
Gets the ItemStack that the tooltip is for.
Nome
player
Tipo
Player?
Ha Getter
Ha Setter
no
Descrizione
Gets the player that is viewing the tooltip.

Note: The player can be null
Nome
tooltip
Tipo
stdlib.List<Component>
Ha Getter
Ha Setter
no
Descrizione
Gets the list of Components that make up the tooltip.