Skip to content


The uiObjectTooltip event triggers when a new tooltip is displayed for all in-world objects and items, and inventory tiles in all dialogues. The tooltip will be already be built. Tooltips for inventory tiles are built on mouseover, while tooltips for in-world objects are rebuilt every frame.

--- @param e uiObjectTooltipEventData
local function uiObjectTooltipCallback(e)
event.register(tes3.event.uiObjectTooltip, uiObjectTooltipCallback)


An event can be claimed by setting e.claim to true, or by returning false from the callback. Claiming the event prevents any lower priority callbacks from being called.

Event Data⚓︎

  • count (number): Read-only. The number of items in the stack.
  • itemData (tes3itemData): Read-only. The item data of object, if any.
  • object (tes3physicalObject): Read-only. The object being examined.
  • reference (tes3reference): Read-only. The reference being examined. Only valid for in-world objects. For inventory tiles it will always be nil.
  • tooltip (tes3uiElement): Read-only. The newly created tooltip element. Due to timeouts and target changes, it may be destroyed at any time.