Package net.neoforged.neoforge.client.event

Class RegisterClientTooltipComponentFactoriesEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.RegisterClientTooltipComponentFactoriesEvent
All Implemented Interfaces:
net.neoforged.fml.event.IModBusEvent
public class RegisterClientTooltipComponentFactoriesEvent extends net.neoforged.bus.api.Event implements net.neoforged.fml.event.IModBusEvent
Allows users to register custom ClientTooltipComponent factories for their TooltipComponent types.

This event is not cancellable, and does not

invalid reference 
have a result
.

This event is fired on the mod-specific event bus, only on the logical client.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Map<Class<? extends net.minecraft.world.inventory.tooltip.TooltipComponent>,Function<net.minecraft.world.inventory.tooltip.TooltipComponent,net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent>>
    factories
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    RegisterClientTooltipComponentFactoriesEvent(Map<Class<? extends net.minecraft.world.inventory.tooltip.TooltipComponent>,Function<net.minecraft.world.inventory.tooltip.TooltipComponent,net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent>> factories)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends net.minecraft.world.inventory.tooltip.TooltipComponent>
    void
    register(Class<T> type, Function<? super T,? extends net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> factory)
    Registers a ClientTooltipComponent factory for a TooltipComponent.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • factories

      private final Map<Class<? extends net.minecraft.world.inventory.tooltip.TooltipComponent>,Function<net.minecraft.world.inventory.tooltip.TooltipComponent,net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent>> factories

  • Constructor Details

    • RegisterClientTooltipComponentFactoriesEvent

      @Internal public RegisterClientTooltipComponentFactoriesEvent(Map<Class<? extends net.minecraft.world.inventory.tooltip.TooltipComponent>,Function<net.minecraft.world.inventory.tooltip.TooltipComponent,net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent>> factories)

  • Method Details

    • register

      public <T extends net.minecraft.world.inventory.tooltip.TooltipComponent> void register(Class<T> type, Function<? super T,? extends net.minecraft.client.gui.screens.inventory.tooltip.ClientTooltipComponent> factory)
      Registers a ClientTooltipComponent factory for a TooltipComponent.