diff --git a/AckisRecipeList.lua b/AckisRecipeList.lua index 01f443d..4258760 100644 --- a/AckisRecipeList.lua +++ b/AckisRecipeList.lua @@ -558,6 +558,17 @@ end -- Input: Recipe array reference, SpellID of recipe, Skill level of recipe, Item ID of item created, Rarity of recipe, and Specialty of the recipe -- Output: None, array is passed as a reference +--- Adds a tradeskill recipe into the specified recipe database. +-- @name AckisRecipeList:addTradeSkill +-- @usage AckisRecipeList:addTradeSkill(RecipeDB,2329,1,2454,1,2259) +-- @param textdump RecipeDB The database (array) which you wish to add data too. +-- @param SpellID +-- @param SkillLevel +-- @param ItemID +-- @param Rarity +-- @param Profession +-- @param Speciality +-- @return None, array is passed as a reference. function addon:addTradeSkill(RecipeDB, SpellID, SkillLevel, ItemID, Rarity, Profession, Specialty) --[[ @@ -1704,6 +1715,11 @@ do -- Input: None -- Output: None + --- Causes a scan of the tradeskill to be conducted. + -- @name AckisRecipeList:AckisRecipeList_Command + -- @usage AckisRecipeList:AckisRecipeList_Command(true) + -- @param textdump Boolean indicating if we want the output to be a text dump, or if we want to use the ARL GUI. + -- @return A frame with either the text dump, or the ARL frame. function addon:AckisRecipeList_Command(textdump) -- If we don't have a trade skill window open, lets return out of here @@ -1712,7 +1728,6 @@ do return -- Trade type skills else - -- First time a scan has been run, we need to get the player specifc data, specifically faction information, profession information and other pertinant data. if (playerData == nil) then playerData = InitPlayerData() @@ -1760,10 +1775,10 @@ do -- Input: Profession of the database needed -- Output: An indicator if the process was successful - --- API for external addons to initialize the recipe database with a specific profession + --- Initialize the recipe database with a specific profession. -- @name AckisRecipeList:AddRecipeData - -- @usage Used for an external program to load up data regarding a specific profession into the ARL database. - -- @param profession Name of the profession you wish to load data for + -- @usage AckisRecipeList:AddRecipeData(2259) + -- @param profession Spell ID of the profession which you want to populate the database with. -- @return Boolean indicating if the operation was successful. The recipe database will be populated with appropriate data. function addon:AddRecipeData(profession) @@ -1781,9 +1796,9 @@ do -- Input: None -- Output: An indicator if the recipe database was initialized successfully, along with all the reference tables. - --- API for external addons to initialize the recipe database + --- Initialize the recipe database -- @name AckisRecipeList:InitRecipeData - -- @usage Causes ARL to load up all internal databases and provides them to the external application. + -- @usage AckisRecipeList:InitRecipeData() -- @return Boolean indicating if the operation was successful. The recipe database will be populated with appropriate data. -- @return Arrays containing the RecipeList, MobList, TrainerList, VendorList, QuestList, ReputationList, SeasonalList. function addon:InitRecipeData() diff --git a/Docs/Documentation.txt b/Docs/Documentation.txt index e048ac7..a829634 100644 --- a/Docs/Documentation.txt +++ b/Docs/Documentation.txt @@ -1,25 +1,42 @@ -Documentation.txt - -Database and code documentation for Ackis Recipe List. +'''Database and code documentation for Ackis Recipe List.''' ==Localization== -All the localization files are located in the "Locals" sub-directory. Feel free to edit locals in any language, make the enUS more effecient, correct typos, etc. All I would ask is if you do edit something, check in-game first to make sure the change works. - -==Graphical Interface== - -All the graphical interface functions are located in ARLFrame.lua. This file contains all the functions needed for the GUI. If you have enhancements, know how to fix an issue, etc please feel free to contribute. Just leave a detailed commit note. If it's a new feature please run it by me first before adding anything. - +Please see this [http://www.wowace.com/projects/arl/pages/localization/ page] for information on localization within the addon. + +==File Breakdown== +:'''AckisRecipeList.lua''' +::Main code for getting the database, adding entries to it, filtering, etc. +:'''ARLColour.lua''' +::Code for making output colourized. +:'''ARLConfig.lua''' +::All the configuration options for ARL +:'''ARLFrame.lua''' +::All the GUI code +:''Locals'' +::All the localization files +:''RecipeDB'' +::All the recipe database files +:'''ARLDataminer.rb''' +::Dataminer which was used to initially populate the ARL database. + +===Graphical Interface=== +All the graphical interface functions are located in '''ARLFrame.lua'''. This file contains all the functions needed for the GUI. If you have enhancements, know how to fix an issue, etc please feel free to contribute. Just leave a detailed commit note. If it's a new feature please run it by me first before adding anything. + +===Database Functions=== In the RecipeDB is a single file for each profession. Each recipe is inserted into the database via 3 functions. For example: - self:addTradeSkill(RecipeDB, 25610, 120, 20950, 1) - self:addTradeFlags(RecipeDB, 25610, 1,2,3,4,21,22,23,24,25,26,27,28,29,30,36,40,41,47,56,62) - self:addTradeAcquire(RecipeDB, 25610, 2, 4877, 2, 1448) + -- Elixir of Lion's Strength -- 2329 + recipecount = recipecount + 1 + self:addTradeSkill(RecipeDB,2329,1,2454,1,2259) + self:addTradeFlags(RecipeDB,2329,1,2,3,21,22,23,24,25,26,27,28,29,30,36,41,51,52) + self:addTradeAcquire(RecipeDB,2329,8,8) -==addTradeSkill== +The first line is a human readabile comment, which states the recipe name, with the [http://www.wowwiki.com/SpellLink spell ID] of the recipe. -This function adds the main recipe entry, including the following information: -* Spell ID +====addTradeSkill==== +This function adds the main recipe entry. it includes the following information: +* [http://www.wowwiki.com/SpellLink Spell ID] * Skill Level Learnt * Item ID created * Recipe Rarity @@ -28,12 +45,10 @@ From there, internal functions determine the following: * Name of the recipe * Link determining the recipe made -==addTradeFlags== - +====addTradeFlags==== This function adds a series of "flags" about the recipe. This include a fairly exhaustive look at the recipe and the item made, where is can be obtained, etc. The individual flags are documented further down. -==addTradeAcquire== - +====addTradeAcquire==== This function adds entries into the main database with exact instructions on how the recipe can be obtained. The details of these acquire methods are detailed further down. ==SavedVariable Structure==