Package net.neoforged.neoforge.common.extensions

Interface TooltipFlagExtension

All Known Subinterfaces:
TooltipFlag
All Known Implementing Classes:
ClientTooltipFlag, TooltipFlag.Default
public interface TooltipFlagExtension
Extension methods for TooltipFlag

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    hasAltDown()
    Returns the state of the Alt key (as reported by Screen) on the client, or false on the server.
    default boolean
    hasControlDown()
    Returns the state of the Control key (as reported by Screen) on the client, or false on the server.
    default boolean
    hasShiftDown()
    Returns the state of the Shift key (as reported by Screen) on the client, or false on the server.
    default boolean
    shouldDisplayAllInformation()
    Returns if the tooltip should provide all information that it may show under varying circumstances.

  • Method Details

    • hasControlDown

      default boolean hasControlDown()
      Returns the state of the Control key (as reported by Screen) on the client, or false on the server.
      Returns:
      the state of the Control key (as reported by Screen) on the client, or false on the server

    • hasShiftDown

      default boolean hasShiftDown()
      Returns the state of the Shift key (as reported by Screen) on the client, or false on the server.
      Returns:
      the state of the Shift key (as reported by Screen) on the client, or false on the server

    • hasAltDown

      default boolean hasAltDown()
      Returns the state of the Alt key (as reported by Screen) on the client, or false on the server.
      Returns:
      the state of the Alt key (as reported by Screen) on the client, or false on the server

    • shouldDisplayAllInformation

      default boolean shouldDisplayAllInformation()
      Returns if the tooltip should provide all information that it may show under varying circumstances. For example, some mods hide extra information by requiring a player to hold a key down (like SHIFT). These mods can choose to provide this extra information to recipe viewers unconditionally, so that the tooltip can be fully indexed and searched.
      Returns:
      if the tooltip should provide all information that it may show under varying circumstances