MCItemTooltipEvent

This class was added by a mod with mod-id crafttweaker. So you need to have this mod installed if you want to use this feature.

Importing the class

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.

crafttweaker.api.event.entity.player.MCItemTooltipEvent

Constructors

new crafttweaker.api.event.entity.player.MCItemTooltipEvent(handler as function.Consumer<crafttweaker.api.event.entity.player.MCItemTooltipEvent>);

Methods

getEntityPlayer

This event is fired with a null player during startup when populating search trees for tooltips.

Returns crafttweaker.api.entity.player.MCPlayerEntity

myMCItemTooltipEvent.getEntityPlayer();

getItemStack

The ItemStack with the tooltip.

Returns crafttweaker.api.item.IItemStack

myMCItemTooltipEvent.getItemStack();

getPlayer

Returns: Player

Returns crafttweaker.api.entity.player.MCPlayerEntity

myMCItemTooltipEvent.getPlayer();

hasResult

Determines if this event expects a significant result value. Note: Events with the HasResult annotation will have this method automatically added to return true.

Returns boolean

myMCItemTooltipEvent.hasResult();

isCancelable

Determine if this function is cancelable at all. Returns: If access to setCanceled should be allowed Note: Events with the Cancelable annotation will have this method automatically added to return true.

Returns boolean

myMCItemTooltipEvent.isCancelable();

isCanceled

Determine if this event is canceled and should stop executing. Returns: The current canceled state

Returns boolean

myMCItemTooltipEvent.isCanceled();

setCanceled

myMCItemTooltipEvent.setCanceled(cancel as boolean);