ItemTooltipEvent

Version:

Home Commands Examples Getting Started With Scripts Global Keywords

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.forge.api.event.item.ItemTooltipEvent;

Description

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

Extends

ItemTooltipEvent extends PlayerEvent.

Listening to the event

This event can be listened to like so:

events.register<crafttweaker.forge.api.event.item.ItemTooltipEvent>(event => {
    println("ItemTooltipEvent ran!");
});

Members

Cancels the event. Same as setCanceled(true)

// ItemTooltipEvent.cancel();
event.cancel();

// ItemTooltipEvent.cancelable as bool
event.cancelable

Return Type: bool

// ItemTooltipEvent.cancelable() as bool;
event.cancelable();

Return Type: bool

// ItemTooltipEvent.canceled as bool
event.canceled

Return Type: bool

// ItemTooltipEvent.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel: bool Type: bool

// ItemTooltipEvent.canceled() as bool;
event.canceled();

Return Type: bool

// ItemTooltipEvent.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel: bool Type: bool

// ItemTooltipEvent.entity as Player
event.entity

Return Type: Player

// ItemTooltipEvent.entity as LivingEntity
event.entity

Return Type: LivingEntity

// ItemTooltipEvent.entity as Entity
event.entity

Return Type: Entity

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

// ItemTooltipEvent.flags as TooltipFlag
event.flags

Return Type: TooltipFlag

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

Returns: The tooltip flags

// ItemTooltipEvent.flags() as TooltipFlag;
event.flags();

Return Type: TooltipFlag

// ItemTooltipEvent.hasResult as bool
event.hasResult

Return Type: bool

// ItemTooltipEvent.hasResult() as bool;
event.hasResult();

Return Type: bool

Gets the ItemStack that the tooltip is for.

// ItemTooltipEvent.itemStack as IItemStack
event.itemStack

Return Type: IItemStack

Gets the ItemStack that the tooltip is for.

Returns: The ItemStack that the tooltip is for.

// ItemTooltipEvent.itemStack() as IItemStack;
event.itemStack();

Return Type: IItemStack

Gets the player that is viewing the tooltip.

Note: The player can be null

// ItemTooltipEvent.player as Player
event.player

Return Type: Player

Gets the player that is viewing the tooltip.

Note: The player can be null

Returns: The player that is viewing the tooltip.

// ItemTooltipEvent.player() as Player;
event.player();

Return Type: Player

// ItemTooltipEvent.result as EventResult
event.result

Return Type: EventResult

// ItemTooltipEvent.result = (result as EventResult);
event.result = myResult;

Parameters:

result: EventResult Type: EventResult

// ItemTooltipEvent.result() as EventResult;
event.result();

Return Type: EventResult

// ItemTooltipEvent.result(result as EventResult);
event.result(myResult);

Parameters:

result: EventResult Type: EventResult

sets the event's result to allow

// ItemTooltipEvent.setAllow();
event.setAllow();

sets the event's result to default

// ItemTooltipEvent.setDefault();
event.setDefault();

sets the event's result to deny

// ItemTooltipEvent.setDeny();
event.setDeny();

Gets the list of Components that make up the tooltip.

// ItemTooltipEvent.tooltip as List<Component>
event.tooltip

Return Type: List<Component>

Gets the list of Components that make up the tooltip.

Returns: The list of Component that make up the tooltip.

// ItemTooltipEvent.tooltip() as List<Component>;
event.tooltip();

Return Type: List<Component>