Skip to content

Tooltips

Tooltips --- popup cards with item information that appear when hovering the cursor over an inventory slot. The system is optional and only works if TooltipManager is present in the scene.

How It Works

flowchart TD
    A["Hovered cursor\nover slot"] --> B{"Slot\nnot empty?"}
    B -->|No| Z["Show\nnothing"]
    B -->|Yes| C["Wait for delay"]
    C --> D["Create tooltip\nfrom prefab"]
    D --> E["Fill in:\nicon + name +\ndescription"]
    E --> F["Position\naccounting for\nscreen edges"]

The system automatically adapts the tooltip position: if the card does not fit on the right --- it shows on the left, if it does not fit below --- it shows above. The cursor is never overlapped by the card.

Setup

  1. Add TooltipManager to the scene. Assign the Canvas and tooltip prefab.
  2. Configure parameters in the inspector:
    • Show Delay --- delay before appearing (default 0.5 sec).
    • Offset --- offset from the cursor.
    • Anchor --- anchor to the cursor or to a slot corner.
  3. Make sure that the slots have a SlotInputAdapter component --- it generates hover events.

Standard Tooltip

The built-in DefaultTooltipView shows:

  • Icon of the item (IItemAdapter.Icon)
  • Name (IItemAdapter.DisplayName)
  • Description (if the item implements IDescribable)
  • Fade animation for appearing and disappearing (configurable)

IDescribable here is an optional adapter extension for UI. The core inventory does not depend on it. See Optional Interfaces for details.

By default, the package now uses regular UnityEngine.UI.Text components instead of TMP. This keeps the core setup simpler and avoids a hard dependency on TextMeshPro.

If you prefer TMP, the UI classes are intentionally easy to swap: search the codebase for Replace to TMP Support and replace the corresponding Text fields with TMP_Text / TextMeshProUGUI in your project-specific fork.

Custom Tooltip

Create your own class by inheriting from BaseTooltipView:

using UnityEngine.UI;

public class RPGTooltipView : BaseTooltipView
{
    [SerializeField] private Text _nameText;
    [SerializeField] private Text _statsText;
    [SerializeField] private Image _rarityBorder;

    public override void SetContent(IItemAdapter item)
    {
        _nameText.text = item.DisplayName;

        if (item is IDescribable describable)
            _statsText.text = describable.Description;

        if (item is IFilterable filterable)
            _rarityBorder.color = GetRarityColor(filterable.Rarity);
    }
}

If needed, this example can be switched to TMP in exactly the same places by following the Replace to TMP Support markers in the built-in UI views.

Assign your prefab in TooltipManager instead of the default one.

Positioning

Mode Description
Cursor Tooltip follows the cursor (updated every frame), but still avoids overlapping the hovered slot
SlotPivot Tooltip is anchored to a normalized point inside the hovered slot (Pivot: 0,0 = bottom-left; 1,1 = top-right)

In all modes, adaptive flipping works: if the card goes beyond the screen boundaries or overlaps the hovered slot, it automatically chooses a better side.

Class Reference

Class Role
TooltipManager Manages the tooltip lifecycle
BaseTooltipView Base class for the view (inherit for custom ones)
DefaultTooltipView Standard implementation: icon + name + description
IDescribable Example of an optional adapter interface for UI descriptions