# 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.

## 导入类

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
import crafttweaker.api.event.entity.player.ItemTooltipEvent;
```


## Extending PlayerEvent

ItemTooltipEvent extends [PlayerEvent](/forge/api/event/entity/player/PlayerEvent). That means all methods available in [PlayerEvent](/forge/api/event/entity/player/PlayerEvent) are also available in ItemTooltipEvent

## 使用方式

:::group{name=getFlags}

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

Returns: The tooltip flags  
Return Type: [TooltipFlag](/vanilla/api/item/TooltipFlag)

```zenscript
// ItemTooltipEvent.getFlags() as TooltipFlag

event.getFlags();
```

:::

:::group{name=getItemStack}

Gets the ItemStack that the tooltip is for.

Returns: The ItemStack that the tooltip is for.  
Return Type: [IItemStack](/vanilla/api/item/IItemStack)

```zenscript
// ItemTooltipEvent.getItemStack() as IItemStack

event.getItemStack();
```

:::

:::group{name=getPlayer}

Gets the player that is viewing the tooltip.

 Note: The player can be null

Returns: The player that is viewing the tooltip.  
Return Type: [Player](/vanilla/api/entity/type/player/Player)?

```zenscript
// ItemTooltipEvent.getPlayer() as Player?

event.getPlayer();
```

:::

:::group{name=getToolTip}

Gets the list of [Component](/vanilla/api/text/Component)s that make up the tooltip.

Returns: The list of [Component](/vanilla/api/text/Component) that make up the tooltip.  
Return Type: stdlib.List&lt;[Component](/vanilla/api/text/Component)&gt;

```zenscript
// ItemTooltipEvent.getToolTip() as stdlib.List<Component>

event.getToolTip();
```

:::


## 参数

| 名称     | 类型                                                                      | 可获得  | 可设置   | 描述                                                                                                    |
| ------ | ----------------------------------------------------------------------- | ---- | ----- | ----------------------------------------------------------------------------------------------------- |
| flags  | [TooltipFlag](/vanilla/api/item/TooltipFlag)                            | true | false | Gets the extra tooltip flags, such as if advanced tooltips should be displayed.                       |
| 物品应用   | [IItemstack](/vanilla/api/item/IItemStack)                              | true | false | Gets the ItemStack that the tooltip is for.                                                           |
| player | [Player](/vanilla/api/entity/type/player/Player)?                       | true | false | Gets the player that is viewing the tooltip. <br />  <br />  Note: The player can be null |
| 工具提示   | stdlib.List&lt;[Component](/vanilla/api/text/Component)&gt; | true | false | Gets the list of [Component](/vanilla/api/text/Component)s that make up the tooltip.                  |



名称	类型	可获得	可设置	描述
名称 flags	类型 TooltipFlag	可获得 true	可设置 false	描述 Gets the extra tooltip flags, such as if advanced tooltips should be displayed.
名称物品应用	类型 IItemstack	可获得 true	可设置 false	描述 Gets the ItemStack that the tooltip is for.
名称 player	类型 Player?	可获得 true	可设置 false	描述 Gets the player that is viewing the tooltip. Note: The player can be null
名称工具提示	类型 stdlib.List<Component>	可获得 true	可设置 false	描述 Gets the list of Components that make up the tooltip.