Doc update
ackis [01-15-09 - 18:58]
diff --git a/Docs/Documentation.txt b/Docs/Documentation.txt
index b201857..f4d86c5 100644
--- a/Docs/Documentation.txt
+++ b/Docs/Documentation.txt
@@ -156,113 +156,117 @@ addon.db.profile---->
==Filter Flags==
A recipe can be flagged with many (or even all) of the below flags. They are defined as follows:
-* Obtain:
-**1 = Alliance faction
-**2 = Horde faction
-**3 = Trainer
-**4 = Vendor
-**5 = Instance
-**6 = Raid
-**7 = Seasonal
-**8 = Quest
-**9 = PVP
-**10 = World Drop
-**11 = Mob drop
-**12 = Discovery
-*Class:
-**21 = Deathknight
-**22 = Druid
-**23 = Hunter
-**24 = Mage
-**25 = Paladin
-**26 = Priest
-**27 = Shaman
-**28 = Rogue
-**29 = Warlock
-**30 = Warrior
-*Type of crafted item:
-**36 = Item BoE
-**37 = Item BoP
-**38 = Item BoA
-**40 = Recipe BoE
-**41 = Recipe BoP
-**42 = Recipe BoA
-*Item Type:
-**51 = Physical DPS (melee/hunters)
-**52 = Tanking
-**53 = Healing
-**54 = Caster DPS
-*Armor Type:
-**56 = Cloth
-**57 = Leather
-**58 = Mail
-**59 = Plate
-**60 = Cloak
-**61 = Trinket
-**62 = Ring
-**63 = Necklace
-**64 = Shield
-*Weapon Type:
-**66 = 1H
-**67 = 2H
-**68 = Axe
-**69 = Sword
-**70 = Mace
-**71 = Polearm
-**72 = Dagger
-**73 = Staff
-**74 = Wand
-**75 = Thrown
-**76 = Bow
-**77 = Crossbow
-**78 = Ammo
-**79 = Fist
-*Reputation
-**Original WoW (96-100):
-***96 = Argent Dawn
-***97 = Cenarion Circle
-***98 = Thorium Brotherhood
-***99 = Timbermaw Hold
-***100 = Zandalar Tribe
-**Burning Crusade (101-114):
-***101 = The Aldor
-***102 = Ashtongue Deathsworn
-***103 = Cenarion Expedition
-***104 = Hellfire Factions (Thrallmar/Honor Hold)
-***105 = Consortium
-***106 = Keepers of Time
-***107 = Lower City
-***108 = Nagrand Factions (Maghar/Kureni)
-***109 = Scale of the Sands
-***110 = The Scryer
-***111 = Sha'tar
-***112 = Shattered Sun
-***113 = Sporeggar
-***114 = Violeteye
-**LK (115-131):
-***115 = Argent Crusade
-***116 = Frenzyheart Tribe
-***117 = Knights of the Ebon Blade
-***118 = Kirin Tor
-***119 = The Sons of Hodir
-***120 = The Kalu'ak
-***121 = The Oracles
-***122 = The Wyrmrest Accord
-***123 = The Silver Convenant
-***124 = The Sunreavers
-***125 = Explorer's League
-***126 = Valiance Expedition
-***127 = The Hand of Vengeance
-***128 = The Taunka
-***129 = Warsong Offensive
-***130 = Horde Expedition
-***131 = Alliance Vanguard
-
-
-==Item Acquire methods (and associated database values)==
- Defined below is the specification for the arguments passed back into
- addTradeAcquire. Each Acquire Type passes in different parameters
- depending on how the recipe is acquired:
+===Obtain===
+*1 = Alliance faction
+*2 = Horde faction
+*3 = Trainer
+*4 = Vendor
+*5 = Instance
+*6 = Raid
+*7 = Seasonal
+*8 = Quest
+*9 = PVP
+*10 = World Drop
+*11 = Mob drop
+*12 = Discovery
+*13-20 = Reserved for future use
+===Class===
+*21 = Deathknight
+*22 = Druid
+*23 = Hunter
+*24 = Mage
+*25 = Paladin
+*26 = Priest
+*27 = Shaman
+*28 = Rogue
+*29 = Warlock
+*30 = Warrior
+*31-35 = Reserved for future use
+===Crafted Properties===
+*36 = Item BoE
+*37 = Item BoP
+*38 = Item BoA
+*40 = Recipe BoE
+*41 = Recipe BoP
+*42 = Recipe BoA
+*43-50 = Reserved for future use
+===Item Type===
+*51 = Physical DPS (melee/hunters)
+*52 = Tanking
+*53 = Healing
+*54 = Caster DPS
+*55 = Reserved for future use
+====Armor Type====
+*56 = Cloth
+*57 = Leather
+*58 = Mail
+*59 = Plate
+*60 = Cloak
+*61 = Trinket
+*62 = Ring
+*63 = Necklace
+*64 = Shield
+*65 = Reserved for future use
+====Weapon Type====
+*66 = 1H
+*67 = 2H
+*68 = Axe
+*69 = Sword
+*70 = Mace
+*71 = Polearm
+*72 = Dagger
+*73 = Staff
+*74 = Wand
+*75 = Thrown
+*76 = Bow
+*77 = Crossbow
+*78 = Ammo
+*79 = Fist
+*80-95 = Reserved for future use
+===Reputation===
+====Original====
+*96 = Argent Dawn
+*97 = Cenarion Circle
+*98 = Thorium Brotherhood
+*99 = Timbermaw Hold
+*100 = Zandalar Tribe
+====Burning Crusade====
+*101 = The Aldor
+*102 = Ashtongue Deathsworn
+*103 = Cenarion Expedition
+*104 = Hellfire Factions (Thrallmar/Honor Hold)
+*105 = Consortium
+*106 = Keepers of Time
+*107 = Lower City
+*108 = Nagrand Factions (Maghar/Kureni)
+*109 = Scale of the Sands
+*110 = The Scryer
+*111 = Sha'tar
+*112 = Shattered Sun
+*113 = Sporeggar
+*114 = Violeteye
+====Wrath of the Lich King====
+*115 = Argent Crusade
+*116 = Frenzyheart Tribe
+*117 = Knights of the Ebon Blade
+*118 = Kirin Tor
+*119 = The Sons of Hodir
+*120 = The Kalu'ak
+*121 = The Oracles
+*122 = The Wyrmrest Accord
+*123 = The Silver Convenant
+*124 = The Sunreavers
+*125 = Explorer's League
+*126 = Valiance Expedition
+*127 = The Hand of Vengeance
+*128 = The Taunka
+*129 = Warsong Offensive
+*130 = Horde Expedition
+*131 = Alliance Vanguard
+
+
+==Acquire Flags==
+Defined below is the specification for the arguments passed back into addTradeAcquire. Each Acquire Type passes in different parameters depending on how the recipe is acquired:
Acquire Type = 1 ( Trainer )
ID - Index into TrainerList
@@ -283,23 +287,16 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
Acquire Type = 8 ( Custom )
ID - Custom string
-
- ** - Reputation Level :
- 0 = Neutral
- 1 = Friendly
- 2 = Honored
- 3 = Revered
- 4 = Exalted
-
-
-
-
-
-
+== Reputation Level==
+:0 = Neutral
+:1 = Friendly
+:2 = Honored
+:3 = Revered
+:4 = Exalted
==Table Structures==
- Recipe Array Structure:
+===Recipe Array Structure===
SpellID = {
Level - Skill level at which you can learn the recipe
ItemID - ID of the item created by the recipe (if it exists)
@@ -313,7 +310,7 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
Speciality - Profession speciality (if it exists)
}
- Rarity colours:
+===Rarity colours===
0 - poor #919191
1 - common #ffffff
2 - uncommon #00A900
@@ -322,6 +319,7 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
5 - legendary #FA9900
6 - artifact #e5cc80
+===Mob DB===
self:addLookupList(MobDB, 590, L["Defias Looter"], BZONE["Westfall"], 38.52, 55.94)
MobList
ID = {
@@ -331,6 +329,7 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
Coordy - Y coordinate
}
+===Quest DB===
self:addLookupList(QuestDB, 2859, L["Wild Leather Leggings"], BZONE["Feralas"], 47.97, 67.15, 2)
QuestList
ID = {
@@ -341,18 +340,21 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
Faction - Faction **
}
+===Reputation DB===
self:addLookupList(RepDB, 54, BFAC["Gnomeregan Exiles"]) -- Acquire Flag:
ReputationList
ID = {
Name -- translated faction
}
+===Seasonal DB===
self:addLookupList(SeasonDB, 3, L["Darkmoon Faire"])
SeasonList
ID = {
Name -- Translated Seasonal Event name
}
+===Trainer DB===
self:addLookupList(TrainerDB, 16583, L["Rohok"], BZONE["Hellfire Peninsula"], 54.62, 40.62, 2)
TrainerList
ID = {
@@ -363,6 +365,7 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
Faction -- Faction ID **
}
+===Vendor DB===
self:addLookupList(VendorDB, 13433, L["Wulmort Jinglepocket"], BZONE[""], 0, 0, 0)
VendorList
ID = {
@@ -372,10 +375,10 @@ A recipe can be flagged with many (or even all) of the below flags. They are def
Coordy -- Vendor Y coordinate
Faction -- Vendor Faction ID **
- **
- 1 - Horde
- 2 - Alliance
- 3 - Neutral
+==Faction ID===
+:1 - Horde
+:2 - Alliance
+:3 - Neutral