Package foundry.veil.api.client.tooltip

Interface Tooltippable

All Known Implementing Classes:
TooltipBlockEntityMixin
@Deprecated public interface Tooltippable
Deprecated.
Interface for components that can have a tooltip displayed when hovered over in-world
Since:
1.0.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    addTooltip(String tooltip)
    Deprecated.
    Add a tooltip component to the block entity
    default void
    addTooltip(List<net.minecraft.network.chat.Component> tooltip)
    Deprecated.
    Add a list of tooltip components to the block entity
    default void
    addTooltip(net.minecraft.network.chat.Component tooltip)
    Deprecated.
    Add a tooltip component to the block entity
    default List<VeilUIItemTooltipDataHolder>
    getItems()
    Deprecated.
    Get the items to render in the tooltip and data about them
    default net.minecraft.world.item.ItemStack
    getStack()
    Deprecated.
    The stack for the tooltip to take components from
    default ColorTheme
    getTheme()
    Deprecated.
    Get the theme object for the tooltip from the block entity
    List<net.minecraft.network.chat.Component>
    getTooltip()
    Deprecated.
    Get the tooltip components from the block entity
    default int
    getTooltipHeight()
    Deprecated.
    Increase the tooltip height
    default int
    getTooltipWidth()
    Deprecated.
    Increase the tooltip width
    default int
    getTooltipXOffset()
    Deprecated.
    Get the x offset for the tooltip
    default int
    getTooltipYOffset()
    Deprecated.
    Get the y offset for the tooltip
    default boolean
    getWorldspace()
    Deprecated.
    Whether the tooltip should be rendered in worldspace or not
    default boolean
    isTooltipEnabled()
    Deprecated.
     
    default void
    loadTooltipData(net.minecraft.nbt.CompoundTag tag)
    Deprecated.
     
    default net.minecraft.nbt.CompoundTag
    saveTooltipData()
    Deprecated.
     
    default void
    setBackgroundColor(int color)
    Deprecated.
    Set the background color of the theme
    default void
    setBottomBorderColor(int color)
    Deprecated.
    Set the bottom border color of the theme
    default void
    setTheme(ColorTheme theme)
    Deprecated.
    Set the theme object for the tooltip from the block entity
    default void
    setTooltip(List<net.minecraft.network.chat.Component> tooltip)
    Deprecated.
    Set the tooltip components for the block entity
    default void
    setTopBorderColor(int color)
    Deprecated.
    Set the top border color of the theme

  • Method Details

    • getTooltip

      List<net.minecraft.network.chat.Component> getTooltip()
      Deprecated.
      Get the tooltip components from the block entity
      Returns:
      the tooltip components

    • isTooltipEnabled

      default boolean isTooltipEnabled()
      Deprecated.

    • saveTooltipData

      default net.minecraft.nbt.CompoundTag saveTooltipData()
      Deprecated.

    • loadTooltipData

      default void loadTooltipData(net.minecraft.nbt.CompoundTag tag)
      Deprecated.

    • setTooltip

      default void setTooltip(List<net.minecraft.network.chat.Component> tooltip)
      Deprecated.
      Set the tooltip components for the block entity
      Parameters:
      tooltip - the tooltip components to set

    • addTooltip

      default void addTooltip(net.minecraft.network.chat.Component tooltip)
      Deprecated.
      Add a tooltip component to the block entity
      Parameters:
      tooltip -

    • addTooltip

      default void addTooltip(List<net.minecraft.network.chat.Component> tooltip)
      Deprecated.
      Add a list of tooltip components to the block entity
      Parameters:
      tooltip -

    • addTooltip

      default void addTooltip(String tooltip)
      Deprecated.
      Add a tooltip component to the block entity
      Parameters:
      tooltip -

    • getTheme

      default ColorTheme getTheme()
      Deprecated.
      Get the theme object for the tooltip from the block entity
      Returns:
      the theme object
      See Also:

    • setTheme

      default void setTheme(ColorTheme theme)
      Deprecated.
      Set the theme object for the tooltip from the block entity
      Parameters:
      theme - the theme object to set

    • setBackgroundColor

      default void setBackgroundColor(int color)
      Deprecated.
      Set the background color of the theme
      Parameters:
      color - the color to set

    • setTopBorderColor

      default void setTopBorderColor(int color)
      Deprecated.
      Set the top border color of the theme
      Parameters:
      color -

    • setBottomBorderColor

      default void setBottomBorderColor(int color)
      Deprecated.
      Set the bottom border color of the theme
      Parameters:
      color -

    • getWorldspace

      default boolean getWorldspace()
      Deprecated.
      Whether the tooltip should be rendered in worldspace or not
      Returns:
      true if the tooltip should be rendered in worldspace, false if it should be rendered in screenspace

    • getStack

      default net.minecraft.world.item.ItemStack getStack()
      Deprecated.
      The stack for the tooltip to take components from
      Returns:
      the stack

    • getTooltipWidth

      default int getTooltipWidth()
      Deprecated.
      Increase the tooltip width
      Returns:
      the bonus width

    • getTooltipHeight

      default int getTooltipHeight()
      Deprecated.
      Increase the tooltip height
      Returns:
      the bonus height

    • getTooltipXOffset

      default int getTooltipXOffset()
      Deprecated.
      Get the x offset for the tooltip
      Returns:

    • getTooltipYOffset

      default int getTooltipYOffset()
      Deprecated.
      Get the y offset for the tooltip
      Returns:

    • getItems

      default List<VeilUIItemTooltipDataHolder> getItems()
      Deprecated.
      Get the items to render in the tooltip and data about them
      Returns:
      the items