Package net.neoforged.neoforge.client.event

Class GatherEffectScreenTooltipsEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.client.event.GatherEffectScreenTooltipsEvent

public class GatherEffectScreenTooltipsEvent
extends net.neoforged.bus.api.Event

This event is called when an EffectRenderingInventoryScreen draws the tooltip lines for a hovered MobEffectInstance. It can be used to modify the tooltip.

This event is only fired on the physical client.

Field Summary

Fields

Modifier and Type	Field	Description
protected final MobEffectInstance	effectInst
protected final EffectRenderingInventoryScreen<?>	screen
protected final List<Component>	tooltip

Constructor Summary

Constructors

Constructor	Description
GatherEffectScreenTooltipsEvent(EffectRenderingInventoryScreen<?> screen, MobEffectInstance effectInst, List<Component> tooltip)

Method Summary

Modifier and Type	Method	Description
MobEffectInstance	getEffectInstance()
EffectRenderingInventoryScreen<?>	getScreen()
List<Component>	getTooltip()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

screen

protected final EffectRenderingInventoryScreen<?> screen

effectInst

protected final MobEffectInstance effectInst

tooltip

protected final List<Component> tooltip

Constructor Details

GatherEffectScreenTooltipsEvent

public GatherEffectScreenTooltipsEvent(EffectRenderingInventoryScreen<?> screen,
 MobEffectInstance effectInst,
 List<Component> tooltip)

Method Details

getScreen

public EffectRenderingInventoryScreen<?> getScreen()

Returns:

The screen which will be rendering the tooltip lines.

getEffectInstance

public MobEffectInstance getEffectInstance()

Returns:

The effect whose tooltip is being drawn.

getTooltip

public List<Component> getTooltip()

Returns:

A mutable list of tooltip lines.