API

r8

Source

Markup: *

**Collectinator** provides an interface for scanning companions and moutns to find what is missing. \\There are a set of functions which allow you make use of the Collectinator database outside of Collectinator. Collectinator supports all mounts/pets currently in World of Warcraft 3.2. \\ == CheckForKnownCompanions(DB) Scans the database and the local list of companions and flags which ones you know === Parameters ; DB : Companion database which we are parsing. === Return value Companion DB is updated by reference. === Usage <<code lua>> Collectinator:CheckForKnownCompanions(DB) <</code>> \\ == Collectinator:AddCompanion(DB, CompanionType, SpellID, ItemID, Rarity, Game) Adds a companion into the database. === Parameters ; DB : The database (array) which you wish to add data too. ; CompanionType : Type of entry added to the database. ; SpellID : The [http://www.wowwiki.com/SpellLink Spell ID] of the item being entered to the database. ; ItemID : The [http://www.wowwiki.com/ItemLink Item ID] of the item, or nil ; Rarity : The rarity of the item. ; Game : Game version item was found in, for example, Original, BC, or Wrath. === Return value None, array is passed as a reference. === Usage <<code lua>> Collectinator:AddCompanion(DB) <</code>> \\ == Collectinator:AddCompanionFlags(DB, SpellID, ...) Adds filtering flags to a specific entry. === Parameters ; DB : The database (array) which you wish to add flags too. ; SpellID : The [http://www.wowwiki.com/SpellLink Spell ID] of the item being entered to the database. ; ... : A listing of filtering flags. See [[database-documentation]] for a listing of filtering flags. === Return value None, array is passed as a reference. === Usage <<code lua>> Collectinator:AddCompanionFlags(DB) <</code>> \\ == Collectinator:ClearExclusionList() Clears the exclusion list of all entries. === Return value The exclusion list is cleared. === Usage <<code lua>> Collectinator:ClearExclusionList() <</code>> \\ == Collectinator:MarkExclusions(DB, scantype) Marks all exclusions in the item database to not be displayed === Parameters ; DB : Reference to the entire database. ; scantype : What type of scan occured: CRITTER, MOUNT, etc === Return value All entries which are to be excluded in the database have their display flag marked to false. === Usage <<code lua>> Collectinator:MarkExclusions(CompanionDB, "CRITTER") <</code>> \\ == Collectinator:Scan(textdump, autoupdatescan, scantype) Causes a scan of the companions to be conducted. === Parameters ; textdump : Boolean indicating if we want the output to be a text dump, or if we want to use the GUI. ; autoupdatescan : Boolean, true if we're triggering this from an event (aka we learned a new pet), false otherwise. ; scantype : CRITTER for pets, MOUNT for mounts === Return value A frame with either the text dump, or the GUI frame. === Usage <<code lua>> Collectinator:Scan(true) <</code>> \\ == Collectinator:ToggleExclude(SpellID) Removes or adds a item to the exclusion list. === Parameters ; SpellID : The [http://www.wowwiki.com/SpellLink Spell ID] in the database which we want to exclude === Return value The specified [http://www.wowwiki.com/SpellLink Spell ID] is excluded from the database. === Usage <<code lua>> Collectinator:ToggleExclude <</code>> \\ == Collectinator:ViewExclusionList() Prints all the ID's in the exclusion list out into chat. === Return value All the entries in the exclusion list are printed out into chat. === Usage <<code lua>> Collectinator:ViewExclusionList() <</code>> \\ == GetIDFromLink(SpellLink) Gets a spell ID from a spell link. === Parameters ; SpellLink : The [http://www.wowwiki.com/SpellLink SpellLink] which you wish to get the Spell ID from. === Return value The spell ID of the passed [http://www.wowwiki.com/SpellLink SpellLink]. === Usage <<code lua>> Collectinator:GetIDFromLink(SpellLink) <</code>> \\ == addon:AddTitle(title_id, title_type, era) Title DB functions 0 - prefix 1 - suffix 2 - comma-led suffix === Parameters ; title_id ; title_type ; era \\ == addon:COMPANION_LEARNED() Event handling functions When we learn a new pet, we want to automatically scan the companions and update our saved variables \\ == addon:GetFactionLevels(RepTable) Scans all reputations to get reputation levels to determine if the player can learn a reputation item === Parameters ; RepTable \\ == addon:OnInitialize() Initialization functions Registers the slash commands, options, and database \\ == playerData ; total_str : Total number of items in the scan. ; known_str : Total number of items known in the scan. ; total_filtered_str : Total number of items filtered during the scan. ; known_filtered_str : Total number of items known filtered during the scan. ; unknown_excluide_str : Total number of items unknown excluded during the scan. ; known_excluide_str : Total number of items known excluded during the scan. ; playerFaction : Players faction ; playerClass : Players class \\
Markup Type: *

The type of markup for this entry. Click here for details.