2 local OptionHouse
= DongleStub("OptionHouse-1.0")
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
.TrackEvents
= nil
76 self
:UpdateStatusFrame()
80 function TourGuide
:RegisterGuide(name
, nextzone
, faction
, sequencefunc
)
81 if faction
~= myfaction
then return end
82 self
.guides
[name
] = sequencefunc
83 self
.nextzones
[name
] = nextzone
84 table.insert(self
.guidelist
, name
)
88 function TourGuide
:LoadGuide(name
)
89 if not name
then return end
91 self
.db
.char
.currentguide
= name
92 if not self
.guides
[name
] then self
.db
.char
.currentguide
= self
.guidelist
[1] end
93 self
:DebugF(1, "Loading guide: %s", name
)
94 self
:ParseObjectives(self
.guides
[self
.db
.char
.currentguide
]())
98 function TourGuide
:LoadNextGuide()
99 local name
= self
.nextzones
[self
.db
.char
.currentguide
]
100 if not name
then return end
102 for i
,quest
in ipairs(self
.quests
) do self
.turnedin
[quest
] = nil end -- Clean out old completed objectives, to avoid conflicts
105 self
:UpdateGuidesPanel()
110 function TourGuide
:GetQuestLogIndexByName(name
)
111 name
= name
or self
.quests
[self
.current
]
112 name
= name
:gsub("%s%(Part %d+%)", "")
113 for i
=1,GetNumQuestLogEntries() do
114 if GetQuestLogTitle(i
) == name
then return i
end
118 function TourGuide
:GetQuestDetails(name
)
119 if not name
then return end
121 local i
= self
:GetQuestLogIndexByName(name
)
122 local complete
= i
and select(7, GetQuestLogTitle(i
)) == 1
127 function TourGuide
:FindBagSlot(itemid
)
129 for slot
=1,GetContainerNumSlots(bag
) do
130 local item
= GetContainerItemLink(bag
, slot
)
131 if item
and string.find(item
, "item:"..itemid
) then return bag
, slot
end
137 function TourGuide
:GetCurrentObjectiveInfo()
138 return self
:GetObjectiveInfo(self
.current
)
142 function TourGuide
:GetObjectiveInfo(i
)
143 local action
, quest
, note
= self
.actions
[i
], self
.quests
[i
], self
.notes
[i
]
144 if not action
then return end
146 local logi
, complete
= self
:GetQuestDetails(quest
)
147 local hasitem
= action
== "ITEM" and self
.questitems
[i
] and self
:FindBagSlot(self
.questitems
[i
])
149 return action
, quest
:gsub("@.*@", ""), note
, logi
, complete
, hasitem
, self
.turnedin
[quest
], quest
, self
.useitems
[i
], self
.optional
[i
]
153 local myclass
= UnitClass("player")
154 local titlematches
= {"For", "A", "The", "Or", "In", "Then", "From", "To"}
155 local function ParseQuests(...)
156 local accepts
, turnins
, completes
= {}, {}, {}
158 local actions
, notes
, quests
, items
, useitems
, optionals
= {}, {}, {}, {}, {}, {}
161 for j
=1,select("#", ...) do
162 local text
= select(j
, ...)
163 local _
, _
, class
= text
:find("|C|([^|]+)|")
165 if text
~= "" and (not class
or class
== myclass
) then
166 local _
, _
, action
, quest
= text
:find("^(%a) ([^|]*)")
167 assert(actiontypes
[action
], "Unknown action: "..text
)
169 if not (action
== "I" or action
== "A" or action
=="C" or action
=="T") then
170 quest
= quest
.."@"..uniqueid
.."@"
171 uniqueid
= uniqueid
+ 1
174 actions
[i
], quests
[i
] = actiontypes
[action
], quest
176 local _
, _
, note
= string.find(text
, "|N|([^|]+)|")
177 if note
then notes
[i
] = note
end
179 local _
, _
, item
= string.find(text
, "|I|(%d+)|")
180 if item
then items
[i
] = item
end
182 local _
, _
, useitem
= string.find(text
, "|U|(%d+)|")
183 if useitem
then useitems
[i
] = useitem
end
185 if string.find(text
, "|O|") then optionals
[i
] = true end
190 if action
== "A" then accepts
[quest
] = true
191 elseif action
== "T" then turnins
[quest
] = true
192 elseif action
== "C" then completes
[quest
] = true end
194 if action
== "A" or action
== "C" or action
== "T" then
195 -- Catch bad Title Case
196 for _
,word
in pairs(titlematches
) do
197 if quest
:find("[^:]%s"..word
.."%s") or quest
:find("[^:]%s"..word
.."$") or quest
:find("[^:]%s"..word
.."@") then
198 TourGuide
:DebugF(1, "%s %s -- Contains bad title case", action
, quest
)
202 local _
, _
, comment
= string.find(text
, "(|.|[^|]+)$")
203 if comment
then TourGuide
:Debug(1, "Unclosed comment: ".. comment
) end
208 for quest
in pairs(accepts
) do if not turnins
[quest
] then TourGuide
:DebugF(1, "Quest has no 'turnin' objective: %s", quest
) end end
209 for quest
in pairs(turnins
) do if not accepts
[quest
] then TourGuide
:DebugF(1, "Quest has no 'accept' objective: %s", quest
) end end
210 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
212 return actions
, notes
, quests
, items
, useitems
, optionals
216 function TourGuide
:ParseObjectives(text
)
217 self
.actions
, self
.notes
, self
.quests
, self
.questitems
, self
.useitems
, self
.optional
= ParseQuests(string.split("\n", text
))
221 function TourGuide
:SetTurnedIn(i
, value
)
227 if value
then value
= true else value
= nil end -- Cleanup to minimize savedvar data
229 self
.turnedin
[self
.quests
[i]]
= value
230 self
:DebugF(1, "Set turned in %q = %s", self
.quests
[i
], tostring(value
))
231 self
:UpdateStatusFrame()
235 function TourGuide
:CompleteQuest(name
)
236 local i
= self
.current
238 action
, quest
, note
, logi
, complete
, hasitem
, turnedin
, fullquestname
= self
:GetObjectiveInfo(i
)
239 if action
== "TURNIN" and not turnedin
and name
== quest
:gsub("%s%(Part %d+%)", "") then
240 self
:DebugF(1, "Saving early quest turnin %q", quest
)
241 return self
:SetTurnedIn(i
, true)
245 self
:DebugF(1, "Quest %q not found!", name
)