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 == "RAIDACCESSIBLE" or input == "RA" then
 402     QuestHelper_Pref.filter_raid_accessible = not QuestHelper_Pref.filter_raid_accessible
 403     self:TextOut("Filter "..self:HighlightText("raidaccessible").." set to "..self:HighlightText(QuestHelper_Pref.filter_raid_accessible and "active" or "inactive")..".")
 404     QH_Route_Filter_Rescan("filter_quest_raid_accessible")
 405   elseif input == "" then
 406     self:TextOut("Filter "..self:HighlightText("zone")..": "..self:HighlightText(QuestHelper_Pref.filter_zone and "active" or "inactive"))
 407     self:TextOut("Filter "..self:HighlightText("level")..": "..self:HighlightText(QuestHelper_Pref.filter_level and "active" or "inactive"))
 408     self:TextOut("Filter "..self:HighlightText("group")..": "..self:HighlightText(QuestHelper_Pref.filter_group and "active" or "inactive"))
 409     self:TextOut("Filter "..self:HighlightText("done")..": "..self:HighlightText(QuestHelper_Pref.filter_done and "active" or "inactive"))
 410     self:TextOut("Filter "..self:HighlightText("blocked")..": "..self:HighlightText(QuestHelper_Pref.filter_blocked and "active" or "inactive"))
 411     self:TextOut("Filter "..self:HighlightText("watched")..": "..self:HighlightText(QuestHelper_Pref.filter_watched and "active" or "inactive"))
 412     self:TextOut("Filter "..self:HighlightText("wintergrasp")..": "..self:HighlightText(QuestHelper_Pref.filter_wintergrasp and "active" or "inactive"))
 413     self:TextOut("Filter "..self:HighlightText("raidaccessible")..": "..self:HighlightText(QuestHelper_Pref.filter_raid_accessible and "active" or "inactive"))
 414   else
 415     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")..", "..self:HighlightText("wintergrasp")..", or "..self:HighlightText("raidaccessible")..".")
 416   end
 417 end
 418
 419 function QuestHelper:ToggleArrow(text)
 420   if text == "reset" then QH_Arrow_Reset() return end
 421
 422   QuestHelper_Pref.arrow = not QuestHelper_Pref.arrow
 423   if QuestHelper_Pref.arrow then
 424     QH_Arrow_Show()
 425     self:TextOut(QHFormat("SETTINGS_ARROWLINK_ON", QHText("SETTINGS_ARROWLINK_ARROW")))
 426   else
 427     self:TextOut(QHFormat("SETTINGS_ARROWLINK_OFF", QHText("SETTINGS_ARROWLINK_ARROW")))
 428   end
 429 end
 430
 431 function QuestHelper:ToggleRadar(text)
 432   QuestHelper_Pref.radar = not QuestHelper_Pref.radar
 433   if QuestHelper_Pref.radar then
 434     self:TextOut(QHFormat("SETTINGS_RADAR_ON"))
 435   else
 436     self:TextOut(QHFormat("SETTINGS_RADAR_OFF"))
 437   end
 438 end
 439
 440 function QuestHelper:ToggleCartWP()
 441   QuestHelper_Pref.cart_wp_new = not QuestHelper_Pref.cart_wp_new
 442   if QuestHelper_Pref.cart_wp_new then
 443     self:EnableCartographer()
 444     if Cartographer_Waypoints then
 445       if Waypoint and Waypoint.prototype then
 446         self:TextOut("Would use "..self:HighlightText("Cartographer Waypoints").." to show objectives, but another mod is interfering with it.")
 447       else
 448         self:TextOut(QHFormat("SETTINGS_ARROWLINK_ON", QHText("SETTINGS_ARROWLINK_CART")))
 449       end
 450     else
 451       self:TextOut("Would use "..self:HighlightText("Cartographer Waypoints").." to show objectives, except it doesn't seem to be present.")
 452     end
 453   else
 454     self:DisableCartographer()
 455     self:TextOut(QHFormat("SETTINGS_ARROWLINK_OFF", QHText("SETTINGS_ARROWLINK_CART")))
 456   end
 457 end
 458
 459 function QuestHelper:ToggleTomTomWP()
 460   QuestHelper_Pref.tomtom_wp_new = not QuestHelper_Pref.tomtom_wp_new
 461   if QuestHelper_Pref.tomtom_wp_new then
 462     self:EnableTomTom()
 463     if TomTom then
 464       self:TextOut(QHFormat("SETTINGS_ARROWLINK_ON", QHText("SETTINGS_ARROWLINK_TOMTOM")))
 465     else
 466       self:TextOut("Would use "..self:HighlightText("TomTom").." to show objectives, except it doesn't seem to be present.")
 467     end
 468   else
 469     self:DisableTomTom()
 470     self:TextOut(QHFormat("SETTINGS_ARROWLINK_OFF", QHText("SETTINGS_ARROWLINK_TOMTOM")))
 471   end
 472 end
 473
 474 function QuestHelper:PrintVersion()
 475   self:TextOut("Version: "..self:HighlightText(GetAddOnMetadata("QuestHelper", "Version") or "Unknown"))
 476 end
 477
 478 local function RecycleStatusString(fmt, usedcount, freetable, usedtable)
 479   local freetablecount = QuestHelper:TableSize(freetable)
 480   if usedtable then
 481     local usedtablecount = QuestHelper:TableSize(usedtable)
 482     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)
 483   else
 484     return string.format(fmt, QuestHelper:ProgressString(string.format("%d/%d", usedcount, usedcount+freetablecount), ((usedcount+freetablecount == 0) and 1) or (1-usedcount/(usedcount+freetablecount))))
 485   end
 486 end
 487
 488 function QuestHelper:Top(cmd)
 489   if cmd and string.find(cmd, "all") then
 490     cmd = cmd .. " collected recycle clear boot usage"
 491   end
 492
 493   if cmd and string.find(cmd, "boot") then
 494     local bootv = {}
 495     for k, v in pairs(QuestHelper_Loadtime) do
 496       table.insert(bootv, {time = v, file = k})
 497     end
 498     table.sort(bootv, function (a, b) return a.time < b.time end)
 499
 500     if string.find(cmd, "sort") then
 501       local boott = {}
 502       for i = 1, #bootv - 1 do
 503         table.insert(boott, {time = bootv[i + 1].time - bootv[i].time, file = bootv[i].file})
 504       end
 505       table.sort(boott, function(a, b) return a.time < b.time end)
 506
 507       for _, v in pairs(boott) do
 508         QuestHelper:TextOut(string.format("%s: %f", v.file, v.time))
 509       end
 510       QuestHelper:TextOut(string.format("%s: shrug", bootv[#bootv].file))
 511     else
 512       for i = 1, #bootv do
 513         QuestHelper:TextOut(string.format("%f: %s", bootv[i].time - bootv[1].time, bootv[i].file))
 514       end
 515     end
 516   end
 517
 518   local pre_ttf
 519   local pre_db
 520   if cmd and string.find(cmd, "collected") then
 521     pre_ttf = self:DumpTableTypeFrequencies(true)
 522     pre_db = DB_DumpItems()
 523   end
 524
 525   if cmd and string.find(cmd, "recycle") then
 526     self:DumpTableTypeFrequencies()
 527     self:TextOut(RecycleStatusString("Using %s lua tables.", self.used_tables, self.free_tables, self.recycle_tabletyping))
 528     self:TextOut(RecycleStatusString("Using %s texture objects.", self.used_textures, self.free_textures))
 529     self:TextOut(RecycleStatusString("Using %s font objects.", self.used_text, self.free_text))
 530     self:TextOut(RecycleStatusString("Using %s frame objects.", self.used_frames, self.free_frames))
 531   end
 532
 533   if cmd and string.find(cmd, "usage") then
 534     self:DumpTableTypeFrequencies()
 535   end
 536
 537   if cmd and string.find(cmd, "cache") then
 538     self:DumpCacheData()
 539   end
 540
 541   if cmd and string.find(cmd, "perf") then
 542     QH_Timeslice_DumpPerf()
 543   end
 544
 545   local uncd = 0
 546   for k, v in pairs(QuestHelper_Collector) do
 547     if not v.compressed then uncd = uncd + 1 end
 548   end
 549   uncd = uncd - 1
 550   local uncs = ""
 551   if uncd > 0 then
 552     uncs = string.format(" (%d uncompressed IDs)", uncd)
 553   end
 554
 555   UpdateAddOnMemoryUsage()
 556   local pre_gc = GetAddOnMemoryUsage("QuestHelper")
 557
 558   collectgarbage("collect")
 559
 560   UpdateAddOnMemoryUsage()
 561   local post_gc = GetAddOnMemoryUsage("QuestHelper")
 562
 563   if cmd and string.find(cmd, "collected") then
 564     local post_ttf = self:DumpTableTypeFrequencies(true)
 565
 566     local union = {}
 567     for k, v in pairs(pre_ttf) do union[k] = (pre_ttf[k] or 0) - (post_ttf[k] or 0) end
 568     for k, v in pairs(post_ttf) do union[k] = (pre_ttf[k] or 0) - (post_ttf[k] or 0) end
 569
 570     local sorted = {}
 571     for k, v in pairs(union) do
 572       table.insert(sorted, {k = k, d = v})
 573     end
 574
 575     table.sort(sorted, function(a, b) return a.d < b.d end)
 576     for _, v in pairs(sorted) do
 577       if v.d > 0 then
 578         QuestHelper:TextOut(string.format("%d: %s", v.d, v.k))
 579       end
 580     end
 581
 582     local post_db = DB_DumpItems()
 583
 584     local st = {}
 585     for k, v in pairs(pre_db) do
 586       if not post_db[k] then
 587         table.insert(st, k)
 588       end
 589     end
 590     table.sort(st)
 591
 592     for _, v in ipairs(st) do
 593       QuestHelper:TextOut("DB: " .. v)
 594     end
 595   end
 596
 597   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))
 598
 599   if cmd and string.find(cmd, "clear") then
 600     local cleared = QH_ClearPathcache()
 601
 602     collectgarbage("collect")
 603     UpdateAddOnMemoryUsage()
 604     local new_post_gc = GetAddOnMemoryUsage("QuestHelper")
 605     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))
 606
 607     local cleared = QuestHelper:RecycleClear()
 608
 609     collectgarbage("collect")
 610     UpdateAddOnMemoryUsage()
 611     local new_post_gc_2 = GetAddOnMemoryUsage("QuestHelper")
 612     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))
 613   end
 614 end
 615
 616 function QuestHelper:ToggleMapButton()
 617   QuestHelper_Pref.map_button = not QuestHelper_Pref.map_button
 618
 619   if QuestHelper_Pref.map_button then
 620     QuestHelper:InitMapButton()
 621     self:TextOut("Map button has been |cff00ff00enabled|r.")
 622   else
 623     QuestHelper:HideMapButton()
 624     self:TextOut("Map button has been |cffff0000disabled|r.  Use '/qh button' to restore it.")
 625   end
 626 end
 627
 628 function QuestHelper:ChangeLog()
 629   self:ShowText(QuestHelper_ChangeLog, string.format("QuestHelper %s ChangeLog", QuestHelper_Version))
 630 end
 631
 632 function QuestHelper:Submit()
 633   self:ShowText([[
 634 |TInterface\AddOns\QuestHelper\Art\Upload.tga:100:300|t
 635 Your data can't be submitted automatically, since AddOns can't interact with anything outside of World of Warcraft.
 636
 637 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.
 638
 639 World of Warcraft stores QuestHelper's data in a file named |cff40bbffQuestHelper.lua|r.
 640
 641 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.
 642
 643 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.
 644
 645 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.
 646
 647 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.
 648
 649 After you find |cff40bbffQuestHelper.lua|r, you can email it to me here: |cff40bbffqhaddon@gmail.com|r
 650 ]], "How To Submit Your Data")
 651 end
 652
 653 function QuestHelper:ShowError(params)
 654   if params and params == "full" then
 655     QuestHelper_ErrorCatcher_GenerateReport()
 656   end
 657   QuestHelper_ErrorCatcher_ReportError()
 658 end
 659
 660 local commands
 661
 662 function QuestHelper:Help(argument)
 663   local text = ""
 664   local argument = argument and argument:upper() or ""
 665
 666   for i1, cat in ipairs(commands) do
 667     text = string.format("%s|cffffff00%s|r\n\n", text, cat[1])
 668     for i, data in ipairs(cat[2]) do
 669       if data[1]:find(argument, 1, true) then
 670         text = string.format("%s    |cffff8000%s|r   %s\n", text, data[1], data[2])
 671
 672         if #data[3] > 0 then
 673           text = string.format("%s\n      %s\n", text, #data[3] == 1 and "Example:" or "Examples:")
 674           for i, pair in ipairs(data[3]) do
 675             text = string.format("%s        |cff40bbff%s|r\n          %s\n", text, pair[1], pair[2])
 676           end
 677         end
 678
 679         text = text .. "\n"
 680       end
 681     end
 682     text = text .. "\n\n"
 683   end
 684
 685   self:ShowText(text == "" and ("No commands containing '"..argument.."'") or text, "QuestHelper Slash Commands")
 686 end
 687
 688 function QuestHelper:Donate(argument)
 689   local text = ""
 690   local argument = argument and argument:upper() or ""
 691
 692   for i1, cat in ipairs(commands) do
 693     text = string.format("%s|cffffff00%s|r\n\n", text, cat[1])
 694     for i, data in ipairs(cat[2]) do
 695       if data[1]:find(argument, 1, true) then
 696         text = string.format("%s    |cffff8000%s|r   %s\n", text, data[1], data[2])
 697
 698         if #data[3] > 0 then
 699           text = string.format("%s\n      %s\n", text, #data[3] == 1 and "Example:" or "Examples:")
 700           for i, pair in ipairs(data[3]) do
 701             text = string.format("%s        |cff40bbff%s|r\n          %s\n", text, pair[1], pair[2])
 702           end
 703         end
 704
 705         text = text .. "\n"
 706       end
 707     end
 708     text = text .. "\n\n"
 709   end
 710
 711   self:ShowText([[
 712 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.
 713
 714 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:
 715
 716   |cff40bbffReduced memory and CPU usage for smoother gameplay|r
 717
 718   |cff40bbffFlying mount support for both Northrend and Outland|r
 719
 720   |cff40bbffBetter support for Northrend "phased" quests|r
 721
 722   |cff40bbffAchievementHelper, built right into QuestHelper|r
 723
 724   |cff40bbffPaths that lead you around obstacles instead of through them|r
 725
 726 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!
 727
 728 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.
 729
 730 Thanks!]], "Please Donate!", 500, 20, 10)
 731 end
 732
 733 commands =
 734  {
 735   { "Common commands", {
 736     {"HIDDEN",
 737      "Compiles a list of objectives that QuestHelper is hiding from you. Depending on the reason, you can also unhide the objective.",
 738      {}, QH_Hidden_Menu},
 739
 740     {"INCOMPLETE",
 741      "Show start locations of incomplete quests on the main map. Useful for those pursuing the Loremaster achievement.",
 742      {}, QH_Incomplete},
 743
 744     {"RADAR",
 745      "Display a guess of your current target's location on the minimap.",
 746      {}, QuestHelper.ToggleRadar, QuestHelper},
 747
 748     {"FIND",
 749      "Search for an item, location, or npc.",
 750      {{"/qh find item rune of teleport", "Finds a reagent vendor."},
 751       {"/qh find npc bragok", "Finds the Ratchet flight point."},
 752       {"/qh find loc stormwind 50 60", "Finds the Stormwind auction house."},
 753       {"/qh find loc 50 50", "Finds the center of the zone you're in."},
 754       {"/qh find something", "Searches for something in all categories."},
 755       {"/qh find", "Lists objectives you manually created so that you can remove them."}}, QH_FindName},
 756
 757     {"HIDE",
 758      "Hides QuestHelper's modifications to the minimap and world map, and pauses routing calculations.",
 759       {}, QuestHelper.ToggleHide, QuestHelper},
 760
 761     {"ARROW",
 762      "Toggles Questhelper's built-in directional arrow.",
 763       {{"/qh arrow reset", "Reset location to the center of the screen."}},
 764       QuestHelper.ToggleArrow, QuestHelper},
 765
 766     {"METRIC",
 767      "Toggles distance units between metres and yards.",
 768      {}, QuestHelper.ToggleMetric, QuestHelper},
 769
 770     {"CARTWP",
 771      "Toggles displaying the current objective using Cartographer Waypoints (must be installed separately).",
 772       {}, QuestHelper.ToggleCartWP, QuestHelper},
 773
 774     {"TOMTOM",
 775      "Toggles displaying the current objective using TomTom (must be installed separately).",
 776       {}, QuestHelper.ToggleTomTomWP, QuestHelper},
 777
 778     {"SOLO",
 779      "Toggles solo mode. When enabled, assumes your party members don't exist. Objective sharing with party members will also be disabled.",
 780       {}, QuestHelper.ToggleSolo, QuestHelper},
 781   }},
 782
 783   { "Objective filtering", {
 784     {"FILTER",
 785      "Automatically ignores/unignores objectives based on criteria.",
 786      {
 787       {"/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."},
 788       {"/qh filter group", "Toggle showing objectives that require groups. Automatically disables while grouped."},
 789
 790       {"/qh filter zone", "Toggle showing objectives outside the current zone."},
 791       {"/qh filter done", "Toggle showing objectives for uncompleted quests."},
 792
 793       {"/qh filter blocked", "Toggle showing blocked objectives, such as quest turn-ins for incomplete quests."},
 794       {"/qh filter watched", "Toggle limiting to objectives watched in the Quest Log"},
 795
 796       {"/qh filter wintergrasp", "Toggle ignoring of PvP Wintergrasp quest objectives while not in Wintergrasp"},
 797       {"/qh filter raidaccessible", "Toggle ignoring non-raid quests when in a raid"},
 798       }, QuestHelper.Filter, QuestHelper},
 799
 800     {"LEVEL",
 801      "Adjusts the level offset used by the level filter. Naturally, the level filter must be turned on to have an effect.",
 802      {{"/qh level", "See information related to the level filter."},
 803       {"/qh level 0", "Only allow objectives at or below your current level."},
 804       {"/qh level +2", "Allow objectives up to two levels above your current level."},
 805       {"/qh level -1", "Only allow objectives below your current level."}}, QuestHelper.LevelOffset, QuestHelper},
 806
 807     {"GROUP",
 808      "Adjusts the player cutoff used by the group filter. Naturally, the group filter must be turned on to have an effect.",
 809      {{"/qh group", "See information related to the group filter."},
 810       {"/qh group 0", "Only allow objectives that can be done solo."},
 811       {"/qh group 2", "Allow objectives that require, at most, two groupmembers."},
 812       {"/qh group 5", "Allow objectives that require, at most, five groupmembers."},
 813       {"/qh group instance", "Equivalent to /qh group 5."},
 814       {"/qh group raid", "Equivalent to /qh group 10. All raid quests are currently assumed to be 10-person raids."},
 815     }, QuestHelper.GroupOffset, QuestHelper},
 816
 817     {"SCALE",
 818      "Scales the map icons used by QuestHelper. Will accept values between 50% and 300%.",
 819      {{"/qh scale 1", "Uses the default icon size."},
 820       {"/qh scale 2", "Makes icons twice their default size."},
 821       {"/qh scale 80%", "Makes icons slightly smaller than their default size."}},
 822       QuestHelper.genericSetScale, QuestHelper, "scale", "icon scale", .5, 3},
 823
 824     {"SHARE",
 825      "Toggles objective sharing between QuestHelper users.",
 826       {}, QuestHelper.ToggleShare, QuestHelper},
 827   }},
 828
 829   { "Interface", {
 830     --[[{"BLIZZMAP",
 831      "Toggles the visibility of Blizzard's built-in map points.",
 832      {}, QuestHelper.ToggleBlizzMap, QuestHelper},]]
 833
 834     {"TRACK",
 835      "Toggles the visibility of the QuestHelper's replacement quest tracker.",
 836       {}, QuestHelper.ToggleTrack, QuestHelper},
 837
 838     {"TSCALE",
 839      "Scales the quest tracker provided by QuestHelper. Will accept values between 50% and 300%.",
 840      {},
 841      QuestHelper.TrackerScale, QuestHelper},
 842
 843     {"TRESET",
 844      "Reset's the position of the quest tracker provided by QuestHelper, in cause you move it somewhere inaccessable.",
 845      {{"/qh treset center", "Resets to the center of the screen, instead of a more normal quest tracker location."}}, QuestHelper.ResetTrackerPosition, QuestHelper},
 846
 847     {"TLEVEL",
 848      "Toggles display of levels in the quest tracker provided by QuestHelper.",
 849      {}, QuestHelper.ToggleTrackLevel, QuestHelper},
 850
 851     {"TQCOL",
 852      "Toggles display of colours for the difficulty level of quests in the quest tracker provided by QuestHelper.",
 853      {}, QuestHelper.ToggleTrackQColour, QuestHelper},
 854
 855     {"TOCOL",
 856      "Toggles display of colours for objective progress in the quest tracker provided by QuestHelper.",
 857      {}, QuestHelper.ToggleTrackOColour, QuestHelper},
 858
 859     {"TOOLTIP",
 860      "Toggles appending information about tracked items and NPCs to their tooltips.",
 861       {}, QuestHelper.ToggleTooltip, QuestHelper},
 862
 863     {"FTIME",
 864      "Toggles display of flight time estimates.", {}, QuestHelper.ToggleFlightTimes, QuestHelper},
 865
 866     {"TRAVELTIME",
 867      "Toggles display of travel time estimates.", {}, QuestHelper.ToggleTravelTimes, QuestHelper},
 868
 869     {"ANTS",
 870      "Toggles the display of trails on the world map on and off.",
 871       {}, QuestHelper.ToggleAnts, QuestHelper},
 872
 873     {"ZONES",
 874       "Changes the display of the quest objective zones on the main map.",
 875       {}, QuestHelper.SetZones, QuestHelper},
 876
 877     {"MINIOPACITY",
 878      "Set the opacity of icons on the minimap.",
 879       {}, QuestHelper.genericSetScale, QuestHelper, "mini_opacity", "minimap icon opacity", .1, 1.0},
 880
 881     {"LOCALE",
 882      "Select the locale to use for displayed messages.",
 883       {}, QuestHelper.SetLocale, QuestHelper},
 884
 885     {"BUTTON",
 886      "Toggles the display of QuestHelper's button on the world map.",
 887      {}, QuestHelper.ToggleMapButton, QuestHelper},
 888
 889     {"SETTINGS",
 890      "Opens the Settings menu at the current cursor location. Note that not all settings can be changed through the menu.",
 891      {}, QuestHelper.DoSettingsMenu, QuestHelper},
 892   }},
 893
 894   { "Data collection", {
 895     {"SUBMIT",
 896      "Displays instructions for submitting your collected data.",
 897      {}, QuestHelper.Submit, QuestHelper},
 898
 899      --[[
 900     {"NAG",
 901      "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.",
 902        {{"/qh nag verbose", "Prints the specific changes that were found."}}, QuestHelper.Nag, QuestHelper},]]
 903
 904     {"PURGE",
 905      "Deletes all QuestHelper's collected data.", {}, QuestHelper.Purge, QuestHelper},
 906
 907     {"HARDRESET",
 908      "Deletes all QuestHelper's collected data and resets QuestHelper preferences.", {}, QuestHelper.HardReset, QuestHelper},
 909   }},
 910
 911   { "Performance and debug", {
 912     {"PERF",
 913      "Sets or shows the route workload. Higher means more agressive route updating, lower means better performance Accepts numbers between 10% and 500%.",
 914      {{"/qh perf", "Show current Performance Factor"},
 915       {"/qh perf 1", "Sets standard performance"},
 916       {"/qh perf 50%", "Does half as much background processing"},
 917       {"/qh perf 3", "Computes routes 3 times more aggressively.  Better have some good horsepower!"}},
 918       QuestHelper.genericSetScale, QuestHelper, "perf_scale_2", "performance factor", .1, 5},
 919
 920     {"PERFLOAD",
 921        "Sets or shows the initialization workload. Higher numbers will make QuestHelper load faster, lower numbers will result in better framerate while it's loading.",
 922        {{"/qh perfload", "Show current Performance Factor"},
 923         {"/qh perfload 1", "Sets standard performance"},
 924         {"/qh perfload 50%", "Does half as much background processing"},
 925         {"/qh perfload 3", "Loads 3 times as quickly."}},
 926         QuestHelper.genericSetScale, QuestHelper, "perfload_scale", "boot performance factor", .2, 5},
 927
 928     {"TOP",
 929      "Displays various performance stats on QuestHelper.",
 930       {
 931         {"/qh top recycle", "Displays detailed information on QuestHelper's recycled item pools"},
 932         {"/qh top usage", "Displays detailed information on which table types are most common"},
 933         {"/qh top cache", "Displays detailed information on the internal distance cache"},
 934         {"/qh top perf", "Displays detailed information on coroutine CPU usage"},
 935       }, QuestHelper.Top, QuestHelper},
 936
 937     {"ERROR",
 938      "Displays the first QuestHelper error that has been generated this session in a form which can be copied out of WoW.",
 939      {}, QuestHelper.ShowError, QuestHelper},
 940
 941     {"POS",
 942       "Prints the player's current position. Exists mainly for my own personal convenience.",
 943       {}, 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},
 944   }},
 945
 946   { "Help", {
 947     {"HELP",
 948      "Displays a list of help commands. Listed commands are filtered by the passed string.",
 949      {}, QuestHelper.Help, QuestHelper},
 950
 951     {"VERSION",
 952      "Displays QuestHelper's version.", {}, QuestHelper.PrintVersion, QuestHelper},
 953
 954     {"CHANGES",
 955      "Displays a summary of changes recently made to QuestHelper.",
 956      {}, QuestHelper.ChangeLog, QuestHelper},
 957
 958     --[[{"DONATE",
 959      "Displays some instructions and a link for donating.",
 960      {}, QuestHelper.Donate, QuestHelper},]]
 961   }},
 962 }
 963
 964 function QuestHelper_SlashCommand(input)
 965   local _, _, command, argument = string.find(input, "^%s*([^%s]-)%s+(.-)%s*$")
 966   if not command then
 967     command, argument = input, ""
 968   end
 969
 970   command = string.upper(command)
 971
 972   for i1, cat in ipairs(commands) do
 973     for i, data in ipairs(cat[2]) do
 974       if data[1] == command then
 975         local st = {}
 976
 977         for i = 5,#data do table.insert(st, data[i]) end
 978         table.insert(st, argument)
 979
 980         if type(data[4]) == "function" then
 981           data[4](unpack(st))
 982         else
 983           QuestHelper:TextOut(data[1].." is not yet implemented.")
 984         end
 985
 986         return
 987       end
 988     end
 989   end
 990
 991   QuestHelper:Help()
 992 end
 993
 994 SLASH_QuestHelper1 = "/qh"
 995 SLASH_QuestHelper2 = "/questhelper"
 996 SlashCmdList["QuestHelper"] = function (text) QuestHelper_SlashCommand(text) end