Skip to content

filterContentsMenu⚓︎

This event fires when an item in the contents menu is filtered.

--- @param e filterContentsMenuEventData
local function filterContentsMenuCallback(e)
end
event.register(tes3.event.filterContentsMenu, filterContentsMenuCallback)

Tip

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⚓︎

  • filter (boolean, nil): If true, the item will be displayed in the menu. If false, the item will not be displayed. If left nil, the default behavior is used.
  • item (tes3item): Read-only. The item being filtered.
  • itemData (tes3itemData): Read-only. The item data for the item being filtered.
  • tile (tes3inventoryTile): Read-only. The inventory tile being filtered.

filterBarterMenufilterContentsMenufilterInventory