help.lua

   1 QuestHelper_File["help.lua"] = "Development Version"
   2 QuestHelper_Loadtime["help.lua"] = GetTime()
   3
   4 local QuestHelper_Version = QuestHelper_File["help.lua"]
   5
   6 function QuestHelper:scaleString(val)
   7   return self:HighlightText(math.floor(val*100+0.5).."%")
   8 end
   9
  10 function QuestHelper:genericSetScale(varname, name, mn, mx, input, onchange, ...)
  11   if input == "" then
  12     self:TextOut(string.format("Current %s scale is %s.", name, self:scaleString(QuestHelper_Pref[varname])))
  13   else
  14     local scale = tonumber(input)
  15
  16     if not scale then
  17       local x = string.match(input or "", "^%s*([%d%.]+)%s*%%%s*$")
  18       scale = tonumber(x) or 0
  19       if not scale then
  20         self:TextOut("I don't know how to interpret your input.")
  21         return
  22       end
  23       scale = scale * 0.01
  24     end
  25
  26     if scale < mn then
  27       self:TextOut(string.format("I won't accept a scale less than %s.", self:scaleString(mn)))
  28     elseif scale > mx then
  29       self:TextOut(string.format("I won't accept a scale more than %s.", self:scaleString(mx)))
  30     else
  31       QuestHelper_Pref[varname] = scale
  32       self:TextOut(string.format("Set %s scale set to %s.", name, self:scaleString(scale)))
  33       if onchange then
  34         onchange(...)
  35       end
  36     end
  37   end
  38 end
  39
  40 function QuestHelper:TrackerScale(scale)
  41   QuestHelper:genericSetScale("track_scale", "tracker scale", .5, 2, scale,
  42                               function() QuestHelper.tracker:SetScale(QuestHelper_Pref.track_scale) end)
  43 end
  44
  45 function QuestHelper:SetLocale(loc)
  46   if not loc or loc == "" then
  47     self:TextOut(QHText("LOCALE_LIST_BEGIN"))
  48     for loc, tbl in pairs(QuestHelper_Translations) do
  49       self:TextOut(string.format("  %s%s %s", self:HighlightText(loc),
  50                                               loc == QuestHelper_Pref.locale and " *" or "  ",
  51                                               tbl.LOCALE_NAME or "???"))
  52     end
  53   else
  54     for l, tbl in pairs(QuestHelper_Translations) do
  55       if string.find(string.lower(l), "^"..string.lower(loc)) or
  56          string.find(string.lower(tbl.LOCALE_NAME or ""), "^"..string.lower(loc)) then
  57         QuestHelper_Pref.locale = l
  58         QHFormatSetLocale(l)
  59         self:SetLocaleFonts()
  60         self:TextOut(QHFormat("LOCALE_CHANGED", l))
  61         return
  62       end
  63     end
  64
  65     self:TextOut(QHFormat("LOCALE_UNKNOWN", tostring(loc) or "UNKNOWN"))
  66   end
  67 end
  68
  69 function QuestHelper:ToggleMetric()
  70   QuestHelper_Pref.metric = not QuestHelper_Pref.metric
  71
  72   if QuestHelper_Pref.metric then
  73     self:TextOut("Distances are now in metres.")
  74   else
  75     self:TextOut("Distances are now in yards.")
  76   end
  77 end
  78
  79 function QuestHelper:ToggleHide()
  80   QuestHelper_Pref.hide = not QuestHelper_Pref.hide
  81
  82   -- Desaturate the button texture if QuestHelper is disabled.
  83   if self.MapButton then
  84     -- This should always be true, but just in case...
  85     self.MapButton:GetNormalTexture():SetDesaturated(QuestHelper_Pref.hide)
  86   end
  87
  88   if QuestHelper_Pref.hide then
  89     if QuestHelper_Pref.track then
  90       self:HideTracker()
  91     end
  92
  93     self.map_overlay:Hide()
  94     self:TextOut("QuestHelper is now |cffff0000hidden|r.")
  95   else
  96     if QuestHelper_Pref.track then
  97       self:ShowTracker()
  98     end
  99
 100     self.map_overlay:Show()
 101     self.minimap_marker:Show()
 102     self:TextOut("QuestHelper is now |cff00ff00shown|r.")
 103
 104     QH_Timeslice_Bonus(20)        -- Let the corutine do some overtime...
 105   end
 106 end
 107
 108 function QuestHelper:ToggleShare()
 109   QuestHelper_Pref.share = not QuestHelper_Pref.share
 110   if QuestHelper_Pref.share then
 111     if QuestHelper_Pref.solo then
 112       self:TextOut("Objective sharing will been |cff00ff00enabled|r when you disable solo mode.")
 113     else
 114       self:TextOut("Objective sharing has been |cff00ff00enabled|r.")
 115       self:SetShare(true)
 116     end
 117   else
 118     self:TextOut("Objective sharing has been |cffff0000disabled|r.")
 119     if QuestHelper_Pref.solo then
 120       self:TextOut("Objective sharing won't be reenabled when you disable solo mode.")
 121     else
 122       self:SetShare(false)
 123     end
 124   end
 125 end
 126
 127 function QuestHelper:ToggleFlightTimes()
 128   QuestHelper_Pref.flight_time = not QuestHelper_Pref.flight_time
 129   if QuestHelper_Pref.flight_time then
 130     self:TextOut("The flight timer has been |cff00ff00enabled|r.")
 131   else
 132     self:TextOut("The flight timer has been |cffff0000disabled|r.")
 133   end
 134 end
 135
 136 function QuestHelper:ToggleTravelTimes()
 137   QuestHelper_Pref.travel_time = not QuestHelper_Pref.travel_time
 138   if QuestHelper_Pref.travel_time then
 139     self:TextOut("The travel timer has been |cff00ff00enabled|r.")
 140   else
 141     self:TextOut("The travel timer has been |cffff0000disabled|r.")
 142   end
 143 end
 144
 145 function QuestHelper:ToggleTrack()
 146   QuestHelper_Pref.track = not QuestHelper_Pref.track
 147   if QuestHelper_Pref.track then
 148     self:ShowTracker()
 149     self:TextOut("The quest tracker has been |cff00ff00enabled|r.")
 150   else
 151     self:HideTracker()
 152     self:TextOut("The quest tracker has been |cffff0000disabled|r.")
 153   end
 154 end
 155
 156 function QuestHelper:ToggleBlizzMap()
 157   QuestHelper_Pref.blizzmap = not QuestHelper_Pref.blizzmap
 158   if QuestHelper_Pref.blizzmap then
 159     self:TextOut("The Blizzard quest points have been |cff00ff00enabled|r.")
 160   else
 161     self:TextOut("The Blizzard quest points have been |cffff0000disabled|r.")
 162   end
 163
 164   if UpdateQuestMapPOI then UpdateQuestMapPOI() end
 165 end
 166
 167 if UpdateQuestMapPOI then
 168   local uqmp_def = UpdateQuestMapPOI
 169   function UpdateQuestMapPOI(...)
 170     if QuestHelper_Pref.blizzmap then
 171       return uqmp_def(...)
 172     else
 173       for i = 1, #QUEST_MAP_POI do
 174         QUEST_MAP_POI[i]:Hide()
 175       end
 176     end
 177   end
 178 end
 179
 180 function QuestHelper:ToggleTrackLevel()
 181   QuestHelper_Pref.track_level = not QuestHelper_Pref.track_level
 182   if QuestHelper_Pref.track_level then
 183     self:TextOut("Display of levels in the quest tracker has been |cff00ff00enabled|r.")
 184   else
 185     self:TextOut("Display of levels in the quest tracker has been |cffff0000disabled|r.")
 186   end
 187   QH_UpdateQuests(true)
 188   QH_Tracker_Rescan()
 189 end
 190
 191 function QuestHelper:ToggleTrackQColour()
 192   QuestHelper_Pref.track_qcolour = not QuestHelper_Pref.track_qcolour
 193   if QuestHelper_Pref.track_qcolour then
 194     self:TextOut("Colour for quest difficulty in quest tracker has been |cff00ff00enabled|r.")
 195   else
 196     self:TextOut("Colour for quest difficulty in quest tracker has been |cffff0000disabled|r.")
 197   end
 198   QH_UpdateQuests(true)
 199   QH_Tracker_Rescan()
 200 end
 201
 202 function QuestHelper:ToggleTrackOColour()
 203   QuestHelper_Pref.track_ocolour = not QuestHelper_Pref.track_ocolour
 204   if QuestHelper_Pref.track_ocolour then
 205     self:TextOut("Colour for objective progress in quest tracker has been |cff00ff00enabled|r.")
 206   else
 207     self:TextOut("Colour for objective progress in quest tracker has been |cffff0000disabled|r.")
 208   end
 209   QH_UpdateQuests(true)
 210   QH_Tracker_Rescan()
 211 end
 212
 213 function QuestHelper:ToggleTooltip()
 214   QuestHelper_Pref.tooltip = not QuestHelper_Pref.tooltip
 215   if QuestHelper_Pref.tooltip then
 216     self:TextOut("Objective tooltip information has been |cff00ff00enabled|r.")
 217   else
 218     self:TextOut("Objective tooltip information has been |cffff0000disabled|r.")
 219   end
 220 end
 221
 222 function QuestHelper:Purgewarning()
 223   QuestHelper:TextOut("I would consider this a tragic loss, and would appreciate it if you sent me your saved data before going through with it.")
 224   QuestHelper:TextOut("Enter "..self:HighlightText("/qh nag verbose").." to check and see if you're destroying anything important.")
 225   QuestHelper:TextOut("Enter "..self:HighlightText("/qh submit").." for instructions on how to submit your collected data.")
 226   QuestHelper:TextOut("See the "..self:HighlightText("How You Can Help").." section on the project website for instructions.")
 227 end
 228
 229 function QuestHelper:Purge(code, force, noreload)
 230   if code == self.purge_code or force then
 231     QuestHelper_Quests = nil
 232     QuestHelper_Objectives = nil
 233     QuestHelper_FlightInstructors = nil
 234     QuestHelper_FlightRoutes = nil
 235     QuestHelper_Locale = nil
 236     QuestHelper_UID = nil
 237     QuestHelper_Version = nil
 238     QuestHelper_SaveVersion = nil
 239
 240     QuestHelper_SaveDate = nil
 241     QuestHelper_SeenRealms = nil
 242
 243     QuestHelper_Collector = nil
 244     QuestHelper_Collector_Version = nil
 245
 246     QuestHelper_Errors = nil -- sigh
 247
 248     if not noreload then ReloadUI() end
 249   else
 250     if not self.purge_code then self.purge_code = self:CreateUID(8) end
 251     QuestHelper:TextOut("THIS COMMAND WILL DELETE ALL YOUR COLLECTED DATA")
 252     QuestHelper:Purgewarning()
 253     QuestHelper:TextOut("If you're sure you want to go through with this, enter: "..self:HighlightText("/qh purge "..self.purge_code))
 254   end
 255 end
 256
 257 function QuestHelper:HardReset(code)
 258   if code == self.purge_code then
 259     self:ResetTrackerPosition() -- do this before we kill off the prefs, since it touches a pref
 260     QH_Arrow_Reset()
 261     QuestHelper_Pref = nil
 262     QuestHelper_ErrorList = nil -- BIZAM
 263     QuestHelper_KnownFlightRoutes = nil
 264     QuestHelper_Home = nil
 265     QuestHelper_CharVersion = nil
 266     self:Purge(nil, true)
 267   else
 268     if not self.purge_code then self.purge_code = self:CreateUID(8) end
 269     QuestHelper:TextOut("THIS COMMAND WILL DELETE ALL YOUR COLLECTED DATA AND RESET ALL YOUR PREFERENCES")
 270     QuestHelper:Purgewarning()
 271     QuestHelper:TextOut("If you're sure you want to go through with this, enter: "..self:HighlightText("/qh hardreset "..self.purge_code))
 272   end
 273 end
 274
 275 function QuestHelper:ToggleSolo()
 276   QuestHelper_Pref.solo = not QuestHelper_Pref.solo
 277   if QuestHelper_Pref.solo then
 278     if QuestHelper_Pref.share then
 279       self:SetShare(false)
 280       self:TextOut("Objective sharing has been temporarly |cffff0000disabled|r.")
 281     end
 282     self:TextOut("Solo mode has been |cff00ff00enabled|r.")
 283   else
 284     self:TextOut("Solo mode has been |cffff0000disabled|r.")
 285     if QuestHelper_Pref.share then
 286       self:SetShare(true)
 287       self:TextOut("Objective sharing has been re|cff00ff00enabled|r.")
 288     end
 289   end
 290 end
 291
 292 function QuestHelper:ToggleAnts()
 293   if QuestHelper_Pref.show_ants then
 294     QuestHelper_Pref.show_ants = false
 295     self:TextOut("Ant trails have been |cffff0000disabled|r.")
 296   else
 297     QuestHelper_Pref.show_ants = true
 298     self:TextOut("Ant trails have been |cff00ff00enabled|r.")
 299   end
 300 end
 301
 302 function QuestHelper:SetZones()
 303   if QuestHelper_Pref.zones == "next" then
 304     QuestHelper_Pref.zones = "none"
 305     self:TextOut("Next zone display has been |cffff0000disabled|r.")
 306   else
 307     QuestHelper_Pref.zones = "next"
 308     self:TextOut("Next zone display has been |cff00ff00enabled|r.")
 309   end
 310 end
 311
 312 function QuestHelper:LevelOffset(offset)
 313   local level = tonumber(offset)
 314   if level then
 315     if level > 0 then
 316       self:TextOut("Allowing quests up to "..self:HighlightText(level).." level"..(level==1 and " " or "s ")..self:HighlightText("above").." you.")
 317     elseif level < 0 then
 318       self:TextOut("Only allowing quests "..self:HighlightText(-level).." level"..(level==-1 and " " or "s ")..self:HighlightText("below").." you.")
 319     else
 320       self:TextOut("Only allowing quests "..self:HighlightText("at or below").." your current level.")
 321     end
 322
 323     if not QuestHelper_Pref.filter_level then
 324       self:TextOut("Note: This won't have any effect until you turn the level filter on.")
 325     end
 326
 327     if QuestHelper_Pref.level ~= level then
 328       QuestHelper_Pref.level = level
 329       QH_Route_Filter_Rescan("filter_quest_level")
 330     end
 331   elseif offset == "" then
 332     if QuestHelper_Pref.level <= 0 then
 333       self:TextOut("Level offset is currently set to "..self:HighlightText(QuestHelper_Pref.level)..".")
 334     else
 335       self:TextOut("Level offset is currently set to "..self:HighlightText("+"..QuestHelper_Pref.level)..".")
 336     end
 337
 338     if self.party_levels then for n, l in ipairs(self.party_levels) do
 339       self:TextOut("Your effective level in a "..self:HighlightText(n).." player quest is "..self:HighlightText(string.format("%.1f", l))..".")
 340     end end
 341
 342     if QuestHelper_Pref.solo then
 343       self:TextOut("Peers aren't considered in your effective level, because you're playing solo.")
 344     end
 345   else
 346     self:TextOut("Expected a level offset.")
 347   end
 348 end
 349
 350 function QuestHelper:GroupOffset(offset)
 351   local group = tonumber(offset)
 352   if offset == "instance" then group = 5 end
 353   if offset == "raid" then group = 10 end
 354   if group == 0 then group = 1 end
 355   if group then
 356     self:TextOut("Allowing quests requiring at most "..self:HighlightText(group).." player"..(group==1 and " " or "s ")..".")
 357
 358     if not QuestHelper_Pref.filter_group then
 359       self:TextOut("Note: This won't have any effect until you turn the group filter on.")
 360     end
 361
 362     QuestHelper_Pref.filter_group_param = group
 363     QH_Route_Filter_Rescan("filter_quest_level")
 364   elseif offset == "" then
 365     self:TextOut("Group cutoff is currently set to "..self:HighlightText(QuestHelper_Pref.filter_group_param)..".")
 366   else
 367     self:TextOut("Expected a player count.")
 368   end
 369 end
 370
 371 function QuestHelper:Filter(input)
 372   input = string.upper(input)
 373   if input == "ZONE" then
 374     QuestHelper_Pref.filter_zone = not QuestHelper_Pref.filter_zone
 375     self:TextOut("Filter "..self:HighlightText("zone").." set to "..self:HighlightText(QuestHelper_Pref.filter_zone and "active" or "inactive")..".")
 376     QH_Route_Filter_Rescan("filter_zone")
 377   elseif input == "DONE" then
 378     QuestHelper_Pref.filter_done = not QuestHelper_Pref.filter_done
 379     self:TextOut("Filter "..self:HighlightText("done").." set to "..self:HighlightText(QuestHelper_Pref.filter_done and "active" or "inactive")..".")
 380     QH_Route_Filter_Rescan("filter_quest_done")
 381   elseif input == "LEVEL" then
 382     QuestHelper_Pref.filter_level = not QuestHelper_Pref.filter_level
 383     self:TextOut("Filter "..self:HighlightText("level").." set to "..self:HighlightText(QuestHelper_Pref.filter_level and "active" or "inactive")..".")
 384     QH_Route_Filter_Rescan("filter_quest_level")
 385   elseif input == "GROUP" then
 386     QuestHelper_Pref.filter_group = not QuestHelper_Pref.filter_group
 387     self:TextOut("Filter "..self:HighlightText("group").." set to "..self:HighlightText(QuestHelper_Pref.filter_group and "active" or "inactive")..".")
 388     QH_Route_Filter_Rescan("filter_quest_group")
 389   elseif input == "BLOCKED" or input == "BLOCK" then
 390     QuestHelper_Pref.filter_blocked = not QuestHelper_Pref.filter_blocked
 391     self:TextOut("Filter "..self:HighlightText("blocked").." set to "..self:HighlightText(QuestHelper_Pref.filter_blocked and "active" or "inactive")..".")
 392     QH_Route_Filter_Rescan("filter_blocked")
 393   elseif input == "WATCHED" or input == "WATCH" then
 394     QuestHelper_Pref.filter_watched = not QuestHelper_Pref.filter_watched
 395     self:TextOut("Filter "..self:HighlightText("watched").." set to "..self:HighlightText(QuestHelper_Pref.filter_watched and "active" or "inactive")..".")
 396     QH_Route_Filter_Rescan("filter_quest_watched")
 397   elseif input == "WINTERGRASP" or input == "WG" then
 398     QuestHelper_Pref.filter_wintergrasp = not QuestHelper_Pref.filter_wintergrasp
 399     self:TextOut("Filter "..self:HighlightText("wintergrasp").." set to "..self:HighlightText(QuestHelper_Pref.filter_wintergrasp and "active" or "inactive")..".")
 400     QH_Route_Filter_Rescan("filter_quest_wintergrasp")
 401   elseif input == "" then
 402     self:TextOut("Filter "..self:HighlightText("zone")..": "..self:HighlightText(QuestHelper_Pref.filter_zone and "active" or "inactive"))
 403     self:TextOut("Filter "..self:HighlightText("level")..": "..self:HighlightText(QuestHelper_Pref.filter_level and "active" or "inactive"))
 404     self:TextOut("Filter "..self:HighlightText("group")..": "..self:HighlightText(QuestHelper_Pref.filter_group and "active" or "inactive"))
 405     self:TextOut("Filter "..self:HighlightText("done")..": "..self:HighlightText(QuestHelper_Pref.filter_done and "active" or "inactive"))
 406     self:TextOut("Filter "..self:HighlightText("blocked")..": "..self:HighlightText(QuestHelper_Pref.filter_blocked and "active" or "inactive"))
 407     self:TextOut("Filter "..self:HighlightText("watched")..": "..self:HighlightText(QuestHelper_Pref.filter_watched and "active" or "inactive"))
 408     self:TextOut("Filter "..self:HighlightText("wintergrasp")..": "..self:HighlightText(QuestHelper_Pref.filter_wintergrasp and "active" or "inactive"))
 409   else
 410     self:TextOut("Don't know what you want filtered, expect "..self:HighlightText("zone")..", "..self:HighlightText("done")..", "..self:HighlightText("level")..", "..self:HighlightText("group")..", "..self:HighlightText("blocked")..", "..self:HighlightText("watched")..", or "..self:HighlightText("wintergrasp")..".")
 411   end
 412 end
 413
 414 function QuestHelper:ToggleArrow(text)
 415   if text == "reset" then QH_Arrow_Reset() return end
 416
 417   QuestHelper_Pref.arrow = not QuestHelper_Pref.arrow
 418   if QuestHelper_Pref.arrow then
 419     QH_Arrow_Show()
 420     self:TextOut(QHFormat("SETTINGS_ARROWLINK_ON", QHText("SETTINGS_ARROWLINK_ARROW")))
 421   else
 422     self:TextOut(QHFormat("SETTINGS_ARROWLINK_OFF", QHText("SETTINGS_ARROWLINK_ARROW")))
 423   end
 424 end
 425
 426 function QuestHelper:ToggleCartWP()
 427   QuestHelper_Pref.cart_wp_new = not QuestHelper_Pref.cart_wp_new
 428   if QuestHelper_Pref.cart_wp_new then
 429     self:EnableCartographer()
 430     if Cartographer_Waypoints then
 431       if Waypoint and Waypoint.prototype then
 432         self:TextOut("Would use "..self:HighlightText("Cartographer Waypoints").." to show objectives, but another mod is interfering with it.")
 433       else
 434         self:TextOut(QHFormat("SETTINGS_ARROWLINK_ON", QHText("SETTINGS_ARROWLINK_CART")))
 435       end
 436     else
 437       self:TextOut("Would use "..self:HighlightText("Cartographer Waypoints").." to show objectives, except it doesn't seem to be present.")
 438     end
 439   else
 440     self:DisableCartographer()
 441     self:TextOut(QHFormat("SETTINGS_ARROWLINK_OFF", QHText("SETTINGS_ARROWLINK_CART")))
 442   end
 443 end
 444
 445 function QuestHelper:ToggleTomTomWP()
 446   QuestHelper_Pref.tomtom_wp_new = not QuestHelper_Pref.tomtom_wp_new
 447   if QuestHelper_Pref.tomtom_wp_new then
 448     self:EnableTomTom()
 449     if TomTom then
 450       self:TextOut(QHFormat("SETTINGS_ARROWLINK_ON", QHText("SETTINGS_ARROWLINK_TOMTOM")))
 451     else
 452       self:TextOut("Would use "..self:HighlightText("TomTom").." to show objectives, except it doesn't seem to be present.")
 453     end
 454   else
 455     self:DisableTomTom()
 456     self:TextOut(QHFormat("SETTINGS_ARROWLINK_OFF", QHText("SETTINGS_ARROWLINK_TOMTOM")))
 457   end
 458 end
 459
 460 function QuestHelper:PrintVersion()
 461   self:TextOut("Version: "..self:HighlightText(GetAddOnMetadata("QuestHelper", "Version") or "Unknown"))
 462 end
 463
 464 local function RecycleStatusString(fmt, usedcount, freetable, usedtable)
 465   local freetablecount = QuestHelper:TableSize(freetable)
 466   if usedtable then
 467     local usedtablecount = QuestHelper:TableSize(usedtable)
 468     return string.format(fmt, QuestHelper:ProgressString(string.format("%d/%d", usedtablecount, usedtablecount+freetablecount), ((usedtablecount+freetablecount == 0) and 1) or (1-usedtablecount/(usedtablecount+freetablecount)))) .. string.format(" (%d \"leaked\")", usedcount - usedtablecount)
 469   else
 470     return string.format(fmt, QuestHelper:ProgressString(string.format("%d/%d", usedcount, usedcount+freetablecount), ((usedcount+freetablecount == 0) and 1) or (1-usedcount/(usedcount+freetablecount))))
 471   end
 472 end
 473
 474 function QuestHelper:Top(cmd)
 475   if cmd and string.find(cmd, "all") then
 476     cmd = cmd .. " collected recycle clear boot usage"
 477   end
 478
 479   if cmd and string.find(cmd, "boot") then
 480     local bootv = {}
 481     for k, v in pairs(QuestHelper_Loadtime) do
 482       table.insert(bootv, {time = v, file = k})
 483     end
 484     table.sort(bootv, function (a, b) return a.time < b.time end)
 485
 486     if string.find(cmd, "sort") then
 487       local boott = {}
 488       for i = 1, #bootv - 1 do
 489         table.insert(boott, {time = bootv[i + 1].time - bootv[i].time, file = bootv[i].file})
 490       end
 491       table.sort(boott, function(a, b) return a.time < b.time end)
 492
 493       for _, v in pairs(boott) do
 494         QuestHelper:TextOut(string.format("%s: %f", v.file, v.time))
 495       end
 496       QuestHelper:TextOut(string.format("%s: shrug", bootv[#bootv].file))
 497     else
 498       for i = 1, #bootv do
 499         QuestHelper:TextOut(string.format("%f: %s", bootv[i].time - bootv[1].time, bootv[i].file))
 500       end
 501     end
 502   end
 503
 504   local pre_ttf
 505   local pre_db
 506   if cmd and string.find(cmd, "collected") then
 507     pre_ttf = self:DumpTableTypeFrequencies(true)
 508     pre_db = DB_DumpItems()
 509   end
 510
 511   if cmd and string.find(cmd, "recycle") then
 512     self:DumpTableTypeFrequencies()
 513     self:TextOut(RecycleStatusString("Using %s lua tables.", self.used_tables, self.free_tables, self.recycle_tabletyping))
 514     self:TextOut(RecycleStatusString("Using %s texture objects.", self.used_textures, self.free_textures))
 515     self:TextOut(RecycleStatusString("Using %s font objects.", self.used_text, self.free_text))
 516     self:TextOut(RecycleStatusString("Using %s frame objects.", self.used_frames, self.free_frames))
 517   end
 518
 519   if cmd and string.find(cmd, "usage") then
 520     self:DumpTableTypeFrequencies()
 521   end
 522
 523   if cmd and string.find(cmd, "cache") then
 524     self:DumpCacheData()
 525   end
 526
 527   if cmd and string.find(cmd, "perf") then
 528     QH_Timeslice_DumpPerf()
 529   end
 530
 531   local uncd = 0
 532   for k, v in pairs(QuestHelper_Collector) do
 533     if not v.compressed then uncd = uncd + 1 end
 534   end
 535   uncd = uncd - 1
 536   local uncs = ""
 537   if uncd > 0 then
 538     uncs = string.format(" (%d uncompressed IDs)", uncd)
 539   end
 540
 541   UpdateAddOnMemoryUsage()
 542   local pre_gc = GetAddOnMemoryUsage("QuestHelper")
 543
 544   collectgarbage("collect")
 545
 546   UpdateAddOnMemoryUsage()
 547   local post_gc = GetAddOnMemoryUsage("QuestHelper")
 548
 549   if cmd and string.find(cmd, "collected") then
 550     local post_ttf = self:DumpTableTypeFrequencies(true)
 551
 552     local union = {}
 553     for k, v in pairs(pre_ttf) do union[k] = (pre_ttf[k] or 0) - (post_ttf[k] or 0) end
 554     for k, v in pairs(post_ttf) do union[k] = (pre_ttf[k] or 0) - (post_ttf[k] or 0) end
 555
 556     local sorted = {}
 557     for k, v in pairs(union) do
 558       table.insert(sorted, {k = k, d = v})
 559     end
 560
 561     table.sort(sorted, function(a, b) return a.d < b.d end)
 562     for _, v in pairs(sorted) do
 563       if v.d > 0 then
 564         QuestHelper:TextOut(string.format("%d: %s", v.d, v.k))
 565       end
 566     end
 567
 568     local post_db = DB_DumpItems()
 569
 570     local st = {}
 571     for k, v in pairs(pre_db) do
 572       if not post_db[k] then
 573         table.insert(st, k)
 574       end
 575     end
 576     table.sort(st)
 577
 578     for _, v in ipairs(st) do
 579       QuestHelper:TextOut("DB: " .. v)
 580     end
 581   end
 582
 583   self:TextOut(string.format("QuestHelper is using %dkb (pre-collect %dkb) of RAM (%s/%s/%s/%s)%s", post_gc, pre_gc, QuestHelper_local_version, QuestHelper_toc_version, GetBuildInfo(), GetLocale(), uncs))
 584
 585   if cmd and string.find(cmd, "clear") then
 586     local cleared = QH_ClearPathcache()
 587
 588     collectgarbage("collect")
 589     UpdateAddOnMemoryUsage()
 590     local new_post_gc = GetAddOnMemoryUsage("QuestHelper")
 591     self:TextOut(string.format("QuestHelper is using %dkb/%dkb/%dkb (%d pathcache cleared) of RAM (%s/%s/%s/%s)%s", pre_gc, post_gc, new_post_gc, cleared, QuestHelper_local_version, QuestHelper_toc_version, GetBuildInfo(), GetLocale(), uncs))
 592
 593     local cleared = QuestHelper:RecycleClear()
 594
 595     collectgarbage("collect")
 596     UpdateAddOnMemoryUsage()
 597     local new_post_gc_2 = GetAddOnMemoryUsage("QuestHelper")
 598     self:TextOut(string.format("QuestHelper is using %dkb/%dkb/%dkb/%dkb (%d recycle cleared) of RAM (%s/%s/%s/%s)%s", pre_gc, post_gc, new_post_gc, new_post_gc_2, cleared, QuestHelper_local_version, QuestHelper_toc_version, GetBuildInfo(), GetLocale(), uncs))
 599   end
 600 end
 601
 602 function QuestHelper:ToggleMapButton()
 603   QuestHelper_Pref.map_button = not QuestHelper_Pref.map_button
 604
 605   if QuestHelper_Pref.map_button then
 606     QuestHelper:InitMapButton()
 607     self:TextOut("Map button has been |cff00ff00enabled|r.")
 608   else
 609     QuestHelper:HideMapButton()
 610     self:TextOut("Map button has been |cffff0000disabled|r.  Use '/qh button' to restore it.")
 611   end
 612 end
 613
 614 function QuestHelper:ChangeLog()
 615   self:ShowText(QuestHelper_ChangeLog, string.format("QuestHelper %s ChangeLog", QuestHelper_Version))
 616 end
 617
 618 function QuestHelper:Submit()
 619   self:ShowText([[
 620 |TInterface\AddOns\QuestHelper\Art\Upload.tga:100:300|t
 621 Your data can't be submitted automatically, since AddOns can't interact with anything outside of World of Warcraft.
 622
 623 To do this would require me to create some third party software, and I don't want to include such software with QuestHelper, because that's the kind of thing that ill intended people are likely to tamper with.
 624
 625 World of Warcraft stores QuestHelper's data in a file named |cff40bbffQuestHelper.lua|r.
 626
 627 To find this file, first find the the directory you installed World of Warcraft to. In Windows, this defaults to |cff40bbffC:\Program Files\World of Warcraft|r, and on Mac, I believe this is |cff40bbff/Applications/World of Warcraft|r.
 628
 629 If you're using Windows Vista, Windows might protect the Program Files directory from changes, and redirect Warcraft's saved data to |cff40bbffC:\Users\|cffff8000USER|cff40bbff\AppData\Local\VirtualStore\Program Files\World of Warcraft|r, or possibly |cff40bbffC:\Users\Public\Games\World of Warcraft|r.
 630
 631 In that directory, the needed file is in |cff40bbffWTF/Account/|cffff8000ACCOUNT|cff40bbff/SavedVariables|r, replacing ACCOUNT with the name of your account, and in that directory, you should find |cff40bbffQuestHelper.lua|r.
 632
 633 There are other directories with the names of the realms where your characters are stored, |cffffff00but don't enter them|r. They contain information specific to your characters, such as the flight points they know about, and don't contain the quest information I want.
 634
 635 After you find |cff40bbffQuestHelper.lua|r, you can email it to me here: |cff40bbffqhaddon@gmail.com|r
 636 ]], "How To Submit Your Data")
 637 end
 638
 639 function QuestHelper:ShowError(params)
 640   if params and params == "full" then
 641     QuestHelper_ErrorCatcher_GenerateReport()
 642   end
 643   QuestHelper_ErrorCatcher_ReportError()
 644 end
 645
 646 local commands
 647
 648 function QuestHelper:Help(argument)
 649   local text = ""
 650   local argument = argument and argument:upper() or ""
 651
 652   for i1, cat in ipairs(commands) do
 653     text = string.format("%s|cffffff00%s|r\n\n", text, cat[1])
 654     for i, data in ipairs(cat[2]) do
 655       if data[1]:find(argument, 1, true) then
 656         text = string.format("%s    |cffff8000%s|r   %s\n", text, data[1], data[2])
 657
 658         if #data[3] > 0 then
 659           text = string.format("%s\n      %s\n", text, #data[3] == 1 and "Example:" or "Examples:")
 660           for i, pair in ipairs(data[3]) do
 661             text = string.format("%s        |cff40bbff%s|r\n          %s\n", text, pair[1], pair[2])
 662           end
 663         end
 664
 665         text = text .. "\n"
 666       end
 667     end
 668     text = text .. "\n\n"
 669   end
 670
 671   self:ShowText(text == "" and ("No commands containing '"..argument.."'") or text, "QuestHelper Slash Commands")
 672 end
 673
 674 function QuestHelper:Donate(argument)
 675   local text = ""
 676   local argument = argument and argument:upper() or ""
 677
 678   for i1, cat in ipairs(commands) do
 679     text = string.format("%s|cffffff00%s|r\n\n", text, cat[1])
 680     for i, data in ipairs(cat[2]) do
 681       if data[1]:find(argument, 1, true) then
 682         text = string.format("%s    |cffff8000%s|r   %s\n", text, data[1], data[2])
 683
 684         if #data[3] > 0 then
 685           text = string.format("%s\n      %s\n", text, #data[3] == 1 and "Example:" or "Examples:")
 686           for i, pair in ipairs(data[3]) do
 687             text = string.format("%s        |cff40bbff%s|r\n          %s\n", text, pair[1], pair[2])
 688           end
 689         end
 690
 691         text = text .. "\n"
 692       end
 693     end
 694     text = text .. "\n\n"
 695   end
 696
 697   self:ShowText([[
 698 QuestHelper currently survives on |cffff8000your donations|r. I'm trying to make this into a full-time job so I can add more features and fix bugs, and I can't do that without paying the bills.
 699
 700 There's a lot of stuff I plan to add if I can get enough donations to live off. Some of the most-requested features include:
 701
 702   |cff40bbffReduced memory and CPU usage for smoother gameplay|r
 703
 704   |cff40bbffFlying mount support for both Northrend and Outland|r
 705
 706   |cff40bbffBetter support for Northrend "phased" quests|r
 707
 708   |cff40bbffAchievementHelper, built right into QuestHelper|r
 709
 710   |cff40bbffPaths that lead you around obstacles instead of through them|r
 711
 712 I can't guarantee these will show up soon, as there's a lot of work involved in them, but every donation - no matter how small - helps!
 713
 714 To donate, open up your web browser and go to |cffff8000http://www.quest-helper.com/donate|r. Enter however much you feel comfortable donating, then bask in the knowledge that you're supporting QuestHelper.
 715
 716 Thanks!]], "Please Donate!", 500, 20, 10)
 717 end
 718
 719 commands =
 720  {
 721   { "Common commands", {
 722     {"HIDDEN",
 723      "Compiles a list of objectives that QuestHelper is hiding from you. Depending on the reason, you can also unhide the objective.",
 724      {}, QH_Hidden_Menu},
 725
 726     {"HIDE",
 727      "Hides QuestHelper's modifications to the minimap and world map, and pauses routing calculations.",
 728       {}, QuestHelper.ToggleHide, QuestHelper},
 729
 730     {"ARROW",
 731      "Toggles Questhelper's built-in directional arrow.",
 732       {{"/qh arrow reset", "Reset location to the center of the screen."}},
 733       QuestHelper.ToggleArrow, QuestHelper},
 734
 735     {"METRIC",
 736      "Toggles distance units between metres and yards.",
 737      {}, QuestHelper.ToggleMetric, QuestHelper},
 738
 739     {"CARTWP",
 740      "Toggles displaying the current objective using Cartographer Waypoints (must be installed separately).",
 741       {}, QuestHelper.ToggleCartWP, QuestHelper},
 742
 743     {"TOMTOM",
 744      "Toggles displaying the current objective using TomTom (must be installed separately).",
 745       {}, QuestHelper.ToggleTomTomWP, QuestHelper},
 746
 747     {"FIND",
 748      "Search for an item, location, or npc.",
 749      {{"/qh find item rune of teleport", "Finds a reagent vendor."},
 750       {"/qh find npc bragok", "Finds the Ratchet flight point."},
 751       {"/qh find loc stormwind 50 60", "Finds the Stormwind auction house."},
 752       {"/qh find loc 50 50", "Finds the center of the zone you're in."},
 753       {"/qh find something", "Searches for something in all categories."},
 754       {"/qh find", "Lists objectives you manually created so that you can remove them."}}, QuestHelper.PerformSearch, QuestHelper},
 755
 756     {"SOLO",
 757      "Toggles solo mode. When enabled, assumes your party members don't exist. Objective sharing with party members will also be disabled.",
 758       {}, QuestHelper.ToggleSolo, QuestHelper},
 759   }},
 760
 761   { "Objective filtering", {
 762     {"FILTER",
 763      "Automatically ignores/unignores objectives based on criteria.",
 764      {
 765       {"/qh filter level", "Toggle showing objectives that are probably too hard, by considering the levels of you and your party members, and the offset set by the level command."},
 766       {"/qh filter group", "Toggle showing objectives that require groups. Automatically disables while grouped."},
 767
 768       {"/qh filter zone", "Toggle showing objectives outside the current zone."},
 769       {"/qh filter done", "Toggle showing objectives for uncompleted quests."},
 770
 771       {"/qh filter blocked", "Toggle showing blocked objectives, such as quest turn-ins for incomplete quests."},
 772       {"/qh filter watched", "Toggle limiting to objectives watched in the Quest Log"},
 773
 774       {"/qh filter wintergrasp", "Toggle ignoring of PvP Wintergrasp quest objectives while not in Wintergrasp"},
 775       }, QuestHelper.Filter, QuestHelper},
 776
 777     {"LEVEL",
 778      "Adjusts the level offset used by the level filter. Naturally, the level filter must be turned on to have an effect.",
 779      {{"/qh level", "See information related to the level filter."},
 780       {"/qh level 0", "Only allow objectives at or below your current level."},
 781       {"/qh level +2", "Allow objectives up to two levels above your current level."},
 782       {"/qh level -1", "Only allow objectives below your current level."}}, QuestHelper.LevelOffset, QuestHelper},
 783
 784     {"GROUP",
 785      "Adjusts the player cutoff used by the group filter. Naturally, the group filter must be turned on to have an effect.",
 786      {{"/qh group", "See information related to the group filter."},
 787       {"/qh group 0", "Only allow objectives that can be done solo."},
 788       {"/qh group 2", "Allow objectives that require, at most, two groupmembers."},
 789       {"/qh group 5", "Allow objectives that require, at most, five groupmembers."},
 790       {"/qh group instance", "Equivalent to /qh group 5."},
 791       {"/qh group raid", "Equivalent to /qh group 10. All raid quests are currently assumed to be 10-person raids."},
 792     }, QuestHelper.GroupOffset, QuestHelper},
 793
 794     {"SCALE",
 795      "Scales the map icons used by QuestHelper. Will accept values between 50% and 300%.",
 796      {{"/qh scale 1", "Uses the default icon size."},
 797       {"/qh scale 2", "Makes icons twice their default size."},
 798       {"/qh scale 80%", "Makes icons slightly smaller than their default size."}},
 799       QuestHelper.genericSetScale, QuestHelper, "scale", "icon scale", .5, 3},
 800
 801     {"SHARE",
 802      "Toggles objective sharing between QuestHelper users.",
 803       {}, QuestHelper.ToggleShare, QuestHelper},
 804   }},
 805
 806   { "Interface", {
 807     --[[{"BLIZZMAP",
 808      "Toggles the visibility of Blizzard's built-in map points.",
 809      {}, QuestHelper.ToggleBlizzMap, QuestHelper},]]
 810
 811     {"TRACK",
 812      "Toggles the visibility of the QuestHelper's replacement quest tracker.",
 813       {}, QuestHelper.ToggleTrack, QuestHelper},
 814
 815     {"TSCALE",
 816      "Scales the quest tracker provided by QuestHelper. Will accept values between 50% and 300%.",
 817      {},
 818      QuestHelper.TrackerScale, QuestHelper},
 819
 820     {"TRESET",
 821      "Reset's the position of the quest tracker provided by QuestHelper, in cause you move it somewhere inaccessable.",
 822      {{"/qh treset center", "Resets to the center of the screen, instead of a more normal quest tracker location."}}, QuestHelper.ResetTrackerPosition, QuestHelper},
 823
 824     {"TLEVEL",
 825      "Toggles display of levels in the quest tracker provided by QuestHelper.",
 826      {}, QuestHelper.ToggleTrackLevel, QuestHelper},
 827
 828     {"TQCOL",
 829      "Toggles display of colours for the difficulty level of quests in the quest tracker provided by QuestHelper.",
 830      {}, QuestHelper.ToggleTrackQColour, QuestHelper},
 831
 832     {"TOCOL",
 833      "Toggles display of colours for objective progress in the quest tracker provided by QuestHelper.",
 834      {}, QuestHelper.ToggleTrackOColour, QuestHelper},
 835
 836     {"TOOLTIP",
 837      "Toggles appending information about tracked items and NPCs to their tooltips.",
 838       {}, QuestHelper.ToggleTooltip, QuestHelper},
 839
 840     {"FTIME",
 841      "Toggles display of flight time estimates.", {}, QuestHelper.ToggleFlightTimes, QuestHelper},
 842
 843     {"TRAVELTIME",
 844      "Toggles display of travel time estimates.", {}, QuestHelper.ToggleTravelTimes, QuestHelper},
 845
 846     {"ANTS",
 847      "Toggles the display of trails on the world map on and off.",
 848       {}, QuestHelper.ToggleAnts, QuestHelper},
 849
 850     {"ZONES",
 851       "Changes the display of the quest objective zones on the main map.",
 852       {}, QuestHelper.SetZones, QuestHelper},
 853
 854     {"MINIOPACITY",
 855      "Set the opacity of icons on the minimap.",
 856       {}, QuestHelper.genericSetScale, QuestHelper, "mini_opacity", "minimap icon opacity", .1, 1.0},
 857
 858     {"LOCALE",
 859      "Select the locale to use for displayed messages.",
 860       {}, QuestHelper.SetLocale, QuestHelper},
 861
 862     {"BUTTON",
 863      "Toggles the display of QuestHelper's button on the world map.",
 864      {}, QuestHelper.ToggleMapButton, QuestHelper},
 865
 866     {"SETTINGS",
 867      "Opens the Settings menu at the current cursor location. Note that not all settings can be changed through the menu.",
 868      {}, QuestHelper.DoSettingsMenu, QuestHelper},
 869   }},
 870
 871   { "Data collection", {
 872     {"SUBMIT",
 873      "Displays instructions for submitting your collected data.",
 874      {}, QuestHelper.Submit, QuestHelper},
 875
 876      --[[
 877     {"NAG",
 878      "Tells you if you have anything that's missing from the static database. It can only check quests from your own faction, as the quests of your opposing faction are ommitted to save memory.",
 879        {{"/qh nag verbose", "Prints the specific changes that were found."}}, QuestHelper.Nag, QuestHelper},]]
 880
 881     {"PURGE",
 882      "Deletes all QuestHelper's collected data.", {}, QuestHelper.Purge, QuestHelper},
 883
 884     {"HARDRESET",
 885      "Deletes all QuestHelper's collected data and resets QuestHelper preferences.", {}, QuestHelper.HardReset, QuestHelper},
 886   }},
 887
 888   { "Performance and debug", {
 889     {"PERF",
 890      "Sets or shows the route workload. Higher means more agressive route updating, lower means better performance Accepts numbers between 10% and 500%.",
 891      {{"/qh perf", "Show current Performance Factor"},
 892       {"/qh perf 1", "Sets standard performance"},
 893       {"/qh perf 50%", "Does half as much background processing"},
 894       {"/qh perf 3", "Computes routes 3 times more aggressively.  Better have some good horsepower!"}},
 895       QuestHelper.genericSetScale, QuestHelper, "perf_scale_2", "performance factor", .1, 5},
 896
 897     {"PERFLOAD",
 898        "Sets or shows the initialization workload. Higher numbers will make QuestHelper load faster, lower numbers will result in better framerate while it's loading.",
 899        {{"/qh perfload", "Show current Performance Factor"},
 900         {"/qh perfload 1", "Sets standard performance"},
 901         {"/qh perfload 50%", "Does half as much background processing"},
 902         {"/qh perfload 3", "Loads 3 times as quickly."}},
 903         QuestHelper.genericSetScale, QuestHelper, "perfload_scale", "boot performance factor", .2, 5},
 904
 905     {"TOP",
 906      "Displays various performance stats on QuestHelper.",
 907       {
 908         {"/qh top recycle", "Displays detailed information on QuestHelper's recycled item pools"},
 909         {"/qh top usage", "Displays detailed information on which table types are most common"},
 910         {"/qh top cache", "Displays detailed information on the internal distance cache"},
 911         {"/qh top perf", "Displays detailed information on coroutine CPU usage"},
 912       }, QuestHelper.Top, QuestHelper},
 913
 914     {"ERROR",
 915      "Displays the first QuestHelper error that has been generated this session in a form which can be copied out of WoW.",
 916      {}, QuestHelper.ShowError, QuestHelper},
 917
 918     {"POS",
 919       "Prints the player's current position. Exists mainly for my own personal convenience.",
 920       {}, function (qh) qh:TextOut(qh:LocationString(qh.i, qh.x, qh.y) .. "   " .. qh:Location_RawString(qh:Location_RawRetrieve()) .. "  " .. qh:Location_AbsoluteString(qh:Location_AbsoluteRetrieve())) end, QuestHelper},
 921   }},
 922
 923   { "Help", {
 924     {"HELP",
 925      "Displays a list of help commands. Listed commands are filtered by the passed string.",
 926      {}, QuestHelper.Help, QuestHelper},
 927
 928     {"VERSION",
 929      "Displays QuestHelper's version.", {}, QuestHelper.PrintVersion, QuestHelper},
 930
 931     {"CHANGES",
 932      "Displays a summary of changes recently made to QuestHelper.",
 933      {}, QuestHelper.ChangeLog, QuestHelper},
 934
 935     --[[{"DONATE",
 936      "Displays some instructions and a link for donating.",
 937      {}, QuestHelper.Donate, QuestHelper},]]
 938   }},
 939
 940   { "Incredibly Experimental And Unsupported", {
 941     {"BONFIRES",
 942      "Adds waypoints for the Midsummer Bonfires.",
 943      {}, QH_AddFires},
 944   }},
 945 }
 946
 947 function QuestHelper_SlashCommand(input)
 948   local _, _, command, argument = string.find(input, "^%s*([^%s]-)%s+(.-)%s*$")
 949   if not command then
 950     command, argument = input, ""
 951   end
 952
 953   command = string.upper(command)
 954
 955   for i1, cat in ipairs(commands) do
 956     for i, data in ipairs(cat[2]) do
 957       if data[1] == command then
 958         local st = {}
 959
 960         for i = 5,#data do table.insert(st, data[i]) end
 961         table.insert(st, argument)
 962
 963         if type(data[4]) == "function" then
 964           data[4](unpack(st))
 965         else
 966           QuestHelper:TextOut(data[1].." is not yet implemented.")
 967         end
 968
 969         return
 970       end
 971     end
 972   end
 973
 974   QuestHelper:Help()
 975 end
 976
 977 SLASH_QuestHelper1 = "/qh"
 978 SLASH_QuestHelper2 = "/questhelper"
 979 SlashCmdList["QuestHelper"] = function (text) QuestHelper_SlashCommand(text) end