Bagnon and Bagnonium allow you to create custom rules for filtering items.

Rules are managed through a shared API in BagBrother, registering a rules in one addon is exactly the same as on the other. In the remainder of this page, please consider BagBrother to correspond to either Bagnon and Bagnonium.

To register a rule, besides picking a title and an icon, all you need is to write a function:

BagBrother.Rules:Register {
  id = 'MyRule',
  title = 'My Rule',
  icon = 'SomeIcon.jpg',
  filter = function(frame, bag, slot, family, info)
     -- your logic goes here
  end
}

Whenever a rule is selected, its filter function is called once per item slot in that frame, to ask whether it should be shown or hidden. Here are a few examples of simple filter functions:

function(frame, bag, slot, family, info)
     return true -- shows all slots
end

function(frame, bag, slot, family, info)
     return false -- hides all slots
end

function(frame, bag, slot, family, info)
     return bag == 0 -- shows backpack only
end

function(frame, bag, slot, family, info)
     return slot == 1 -- shows the first slot of each bag
end

As described, the filter function is called, for each slot, with 5 arguments:

Rules:Register has three mandatory proprieties:

Notice that filter is not mandatory. This is because there are alternate proprieties for implementing the filtering function, which mimic user-made rules. Here is the full list of optional parameters: