2 local OptionHouse
= LibStub("OptionHouse-1.1")
5 local myfaction
= UnitFactionGroup("player")
7 TourGuide
= DongleStub("Dongle-1.0"):New("TourGuide")
8 if tekDebug
then TourGuide
:EnableDebug(10, tekDebug
:GetFrame("TourGuide")) end
10 TourGuide
.guidelist
= {}
11 TourGuide
.nextzones
= {}
14 TourGuide
.icons
= setmetatable({
15 ACCEPT
= "Interface\\GossipFrame\\AvailableQuestIcon",
16 COMPLETE
= "Interface\\Icons\\Ability_DualWield",
17 TURNIN
= "Interface\\GossipFrame\\ActiveQuestIcon",
18 RUN
= "Interface\\Icons\\Ability_Tracking",
19 MAP
= "Interface\\Icons\\Ability_Spy",
20 FLY
= "Interface\\Icons\\Ability_Druid_FlightForm",
21 TRAIN
= "Interface\\GossipFrame\\trainerGossipIcon",
22 SETHEARTH
= "Interface\\Icons\\Spell_Holy_ElunesGrace",
23 HEARTH
= "Interface\\Icons\\INV_Misc_Rune_01",
24 NOTE
= "Interface\\Icons\\INV_Misc_Note_01",
25 GRIND
= "Interface\\Icons\\INV_Stone_GrindingStone_05",
26 USE
= "Interface\\Icons\\INV_Misc_Bag_08",
27 BUY
= "Interface\\Icons\\INV_Misc_Coin_01",
28 BOAT
= "Interface\\Icons\\Spell_Frost_SummonWaterElemental",
29 GETFLIGHTPOINT
= "Interface\\Icons\\Spell_Nature_GiftoftheWaterSpirit",
30 }, {__index
= function() return "Interface\\Icons\\INV_Misc_QuestionMark" end})
51 function TourGuide
:Initialize()
52 self
.db
= self
:InitializeDB("TourGuideAlphaDB", {
58 self
.turnedin
= self
.db
.char
.turnedin
59 self
.cachedturnins
= self
.db
.char
.cachedturnins
61 self
.db
.char
.currentguide
= self
.db
.char
.currentguide
or self
.guidelist
[1]
62 self
:LoadGuide(self
.db
.char
.currentguide
)
63 self
:PositionStatusFrame()
67 function TourGuide
:Enable()
68 local _
, title
= GetAddOnInfo("TourGuide")
69 local author
, version
= GetAddOnMetadata("TourGuide", "Author"), GetAddOnMetadata("TourGuide", "Version")
70 local oh
= OptionHouse
:RegisterAddOn("Tour Guide", title
, author
, version
)
71 oh
:RegisterCategory("Guides", TourGuide
, "CreateGuidesPanel")
72 oh
:RegisterCategory("Objectives", TourGuide
, "CreateObjectivePanel")
74 for _
,event
in pairs(self
.TrackEvents
) do self
:RegisterEvent(event
) end
75 self
:RegisterEvent("QUEST_COMPLETE", "UpdateStatusFrame")
76 self
:RegisterEvent("QUEST_DETAIL", "UpdateStatusFrame")
77 self
.TrackEvents
= nil
78 self
:UpdateStatusFrame()
82 function TourGuide
:RegisterGuide(name
, nextzone
, faction
, sequencefunc
)
83 if faction
~= myfaction
then return end
84 self
.guides
[name
] = sequencefunc
85 self
.nextzones
[name
] = nextzone
86 table.insert(self
.guidelist
, name
)
90 function TourGuide
:LoadGuide(name
)
91 if not name
then return end
93 self
.db
.char
.currentguide
= name
94 if not self
.guides
[name
] then self
.db
.char
.currentguide
= self
.guidelist
[1] end
95 self
:DebugF(1, "Loading guide: %s", name
)
96 self
:ParseObjectives(self
.guides
[self
.db
.char
.currentguide
]())
100 function TourGuide
:LoadNextGuide()
101 local name
= self
.nextzones
[self
.db
.char
.currentguide
]
102 if not name
then return end
104 for i
,quest
in ipairs(self
.quests
) do self
.turnedin
[quest
] = nil end -- Clean out old completed objectives, to avoid conflicts
107 self
:UpdateGuidesPanel()
112 function TourGuide
:GetQuestLogIndexByName(name
)
113 name
= name
or self
.quests
[self
.current
]
114 name
= name
:gsub("%s%(Part %d+%)", "")
115 for i
=1,GetNumQuestLogEntries() do
116 if GetQuestLogTitle(i
) == name
then return i
end
120 function TourGuide
:GetQuestDetails(name
)
121 if not name
then return end
123 local i
= self
:GetQuestLogIndexByName(name
)
124 local complete
= i
and select(7, GetQuestLogTitle(i
)) == 1
129 function TourGuide
:FindBagSlot(itemid
)
131 for slot
=1,GetContainerNumSlots(bag
) do
132 local item
= GetContainerItemLink(bag
, slot
)
133 if item
and string.find(item
, "item:"..itemid
) then return bag
, slot
end
139 function TourGuide
:GetObjectiveInfo(i
)
140 i
= i
or self
.current
141 if not self
.actions
[i
] then return end
143 return self
.actions
[i
], self
.quests
[i
]:gsub("@.*@", ""), self
.quests
[i
] -- Action, display name, full name
147 function TourGuide
:GetObjectiveStatus(i
)
148 i
= i
or self
.current
149 if not self
.actions
[i
] then return end
151 return self
.turnedin
[self
.quests
[i]]
, self
:GetQuestDetails(self
.quests
[i
]) -- turnedin, logi, complete
155 function TourGuide
:GetObjectiveTag(tag, i
)
156 self
:Debug(11, "GetObjectiveTag", tag, i
)
157 i
= i
or self
.current
158 if tag == "LV" then return self
.levels
[i
]
159 elseif tag == "N" then return self
.notes
[i
]
160 elseif tag == "U" then return self
.useitems
[i
]
161 elseif tag == "O" then return self
.optional
[i
]
162 elseif tag == "L" then
163 local _
, _
, lootitem
, lootqty
= string.find(self
.lootitems
[i
] or "", "(%d+)%s?(%d*)")
164 lootqty
= tonumber(lootqty
) or 1
166 return lootitem
, lootqty
171 local myclass
= UnitClass("player")
172 local titlematches
= {"For", "A", "The", "Or", "In", "Then", "From", "To"}
173 local function ParseQuests(...)
174 local accepts
, turnins
, completes
= {}, {}, {}
176 local actions
, notes
, quests
, useitems
, optionals
, lootitems
, levels
= {}, {}, {}, {}, {}, {}, {}
179 for j
=1,select("#", ...) do
180 local text
= select(j
, ...)
181 local _
, _
, class
= text
:find("|C|([^|]+)|")
183 if text
~= "" and (not class
or class
== myclass
) then
184 local _
, _
, action
, quest
= text
:find("^(%a) ([^|]*)")
185 assert(actiontypes
[action
], "Unknown action: "..text
)
187 if not (action
== "A" or action
=="C" or action
=="T") then
188 quest
= quest
.."@"..uniqueid
.."@"
189 uniqueid
= uniqueid
+ 1
192 actions
[i
], quests
[i
] = actiontypes
[action
], quest
194 local _
, _
, note
= string.find(text
, "|N|([^|]+)|")
195 if note
then notes
[i
] = note
end
197 local _
, _
, level
= string.find(text
, "|LV|(%d+)|")
198 if level
then levels
[i
] = tonumber(level
) end
200 local _
, _
, useitem
= string.find(text
, "|U|(%d+)|")
201 if useitem
then useitems
[i
] = useitem
end
203 local _
, _
, lootitem
= string.find(text
, "|L|(%d+%s?%d*)|")
204 if lootitem
then lootitems
[i
] = lootitem
end
206 if string.find(text
, "|O|") then optionals
[i
] = true end
211 if action
== "A" then accepts
[quest
] = true
212 elseif action
== "T" then turnins
[quest
] = true
213 elseif action
== "C" then completes
[quest
] = true end
215 if action
== "A" or action
== "C" or action
== "T" then
216 -- Catch bad Title Case
217 for _
,word
in pairs(titlematches
) do
218 if quest
:find("[^:]%s"..word
.."%s") or quest
:find("[^:]%s"..word
.."$") or quest
:find("[^:]%s"..word
.."@") then
219 TourGuide
:DebugF(1, "%s %s -- Contains bad title case", action
, quest
)
223 local _
, _
, comment
= string.find(text
, "(|.|[^|]+)$")
224 if comment
then TourGuide
:Debug(1, "Unclosed comment: ".. comment
) end
229 for quest
in pairs(accepts
) do if not turnins
[quest
] then TourGuide
:DebugF(1, "Quest has no 'turnin' objective: %s", quest
) end end
230 for quest
in pairs(turnins
) do if not accepts
[quest
] then TourGuide
:DebugF(1, "Quest has no 'accept' objective: %s", quest
) end end
231 for quest
in pairs(completes
) do if not accepts
[quest
] and not turnins
[quest
] then TourGuide
:DebugF(1, "Quest has no 'accept' and 'turnin' objectives: %s", quest
) end end
233 return actions
, notes
, quests
, useitems
, optionals
, lootitems
, levels
237 function TourGuide
:ParseObjectives(text
)
238 self
.actions
, self
.notes
, self
.quests
, self
.useitems
, self
.optional
, self
.lootitems
, self
.levels
= ParseQuests(string.split("\n", text
))
242 function TourGuide
:SetTurnedIn(i
, value
, noupdate
)
248 if value
then value
= true else value
= nil end -- Cleanup to minimize savedvar data
250 self
.turnedin
[self
.quests
[i]]
= value
251 self
:DebugF(1, "Set turned in %q = %s", self
.quests
[i
], tostring(value
))
252 if not noupdate
then self
:UpdateStatusFrame()
253 else self
.updatedelay
= true end
257 function TourGuide
:CompleteQuest(name
, noupdate
)
258 local i
= self
.current
261 action
, quest
= self
:GetObjectiveInfo(i
)
262 if action
== "TURNIN" and not self
:GetObjectiveStatus(i
) and name
== quest
:gsub("%s%(Part %d+%)", "") then
263 self
:DebugF(1, "Saving quest turnin %q", quest
)
264 return self
:SetTurnedIn(i
, true, noupdate
)
268 self
:DebugF(1, "Quest %q not found!", name
)