api/modules/aura/FilterTypes

PitBull4_Aura:AnyFilterReferences(reference)

Determine if a filter is referenced by any other filter.

Parameters

reference
the filter name to look for

Return value

true if the filter is referenced by any other filter, false otherwise.

Usage

PitBull4_Aura:AnyFilterReferences("myfilter")


PitBull4_Aura:FilterReferences(filter_name, reference)

Determines if a filter is referenced by another filter.

Parameters

filter_name
the filter to look for a given reference on
reference
the referenced filter to look for

Return value

true or false depending on if filter_name references reference

Usage

PitBull4_Aura:FilterReferences("myfilter","someotherfilter")


PitBull4_Aura:RegisterFilterType(name, display_name, filter_func, config, references)

Registers a new filter type.
Anyone that wants to add a new filter type to the Aura module needs this.

Parameters

name
the name to index the filter type by
display_name
the localized name to display to users
filter_func
a function to actually do the filtering takes the filtername, an aura entry table and the frame as parameters
config
a function to set the options table takes the filtername and a table to put the options into as parameters
references
a function to say which filters the filter references, takes the name of the filter as a reference. Only needed by filters that call other filters.

Return value

nil



Comments

Posts Quoted:
Reply
Clear All Quotes