annotate Core.lua @ 174:5f8d8a8ed6a4

Added tag v81 for changeset 556cb7c32580
author yellowfive
date Tue, 14 Jan 2020 12:51:30 -0800
parents 3be9cc6f7d20
children eec8032ba9df
rev   line source
yellowfive@57 1 AskMrRobot = LibStub("AceAddon-3.0"):NewAddon("AskMrRobot", "AceEvent-3.0", "AceComm-3.0", "AceConsole-3.0", "AceSerializer-3.0")
yellowfive@57 2 local Amr = AskMrRobot
yellowfive@57 3 Amr.Serializer = LibStub("AskMrRobot-Serializer")
yellowfive@57 4
yellowfive@57 5 Amr.ADDON_NAME = "AskMrRobot"
yellowfive@57 6
yellowfive@57 7 -- types of inter-addon messages that we receive, used to parcel them out to the proper handlers
yellowfive@57 8 Amr.MessageTypes = {
yellowfive@57 9 Version = "_V",
yellowfive@124 10 VersionRequest = "_VR"
yellowfive@57 11 }
yellowfive@57 12
yellowfive@57 13 local L = LibStub("AceLocale-3.0"):GetLocale("AskMrRobot", true)
yellowfive@57 14 local AceGUI = LibStub("AceGUI-3.0")
yellowfive@57 15
yellowfive@57 16 -- minimap icon and LDB support
yellowfive@57 17 local _amrLDB = LibStub("LibDataBroker-1.1"):NewDataObject(Amr.ADDON_NAME, {
yellowfive@57 18 type = "launcher",
yellowfive@57 19 text = "Ask Mr. Robot",
yellowfive@57 20 icon = "Interface\\AddOns\\" .. Amr.ADDON_NAME .. "\\Media\\icon",
yellowfive@57 21 OnClick = function(self, button, down)
yellowfive@57 22 if button == "LeftButton" then
yellowfive@124 23 --if IsControlKeyDown() then
yellowfive@124 24 -- Amr:Wipe()
yellowfive@124 25 --else
yellowfive@57 26 Amr:Toggle()
yellowfive@124 27 --end
yellowfive@57 28 elseif button == "RightButton" then
yellowfive@57 29 Amr:EquipGearSet()
yellowfive@57 30 end
yellowfive@57 31 end,
yellowfive@57 32 OnTooltipShow = function(tt)
yellowfive@57 33 tt:AddLine("Ask Mr. Robot", 1, 1, 1);
yellowfive@57 34 tt:AddLine(" ");
yellowfive@57 35 tt:AddLine(L.MinimapTooltip)
yellowfive@57 36 end
yellowfive@57 37 })
yellowfive@57 38 local _icon = LibStub("LibDBIcon-1.0")
yellowfive@57 39
yellowfive@57 40
yellowfive@57 41 -- initialize the database
yellowfive@57 42 local function initializeDb()
yellowfive@57 43
yellowfive@57 44 local defaults = {
yellowfive@139 45 char = {
yellowfive@139 46 LastVersion = 0, -- used to clean out old stuff
yellowfive@129 47 FirstUse = true, -- true if this is first time use, gets cleared after seeing the export help splash window
yellowfive@129 48 Talents = {}, -- for each spec, selected talents
yellowfive@165 49 Essences = {}, -- for each spec, selected essences
yellowfive@165 50 UnlockedEssences = {}, -- unlocked essences for this character
yellowfive@129 51 Equipped = {}, -- for each spec, slot id to item info
yellowfive@129 52 BagItems = {}, -- list of item info for bags
yellowfive@129 53 BankItems = {}, -- list of item info for bank
yellowfive@129 54 BagItemsAndCounts = {}, -- used mainly for the shopping list
yellowfive@129 55 BankItemsAndCounts = {}, -- used mainly for the shopping list
yellowfive@139 56 GearSetups = {}, -- imported gear sets
yellowfive@161 57 JunkData = {}, -- imported data about items that can be vendored/scrapped/disenchanted
yellowfive@129 58 ExtraEnchantData = {}, -- enchant id to enchant display information and material information
yellowfive@129 59 Logging = { -- character logging settings
yellowfive@129 60 Enabled = false, -- whether logging is currently on or not
yellowfive@129 61 LastZone = nil, -- last zone the player was in
yellowfive@129 62 LastDiff = nil, -- last difficulty for the last zone the player was in
yellowfive@129 63 LastWipe = nil -- last time a wipe was called by this player
yellowfive@129 64 }
yellowfive@129 65 },
yellowfive@57 66 profile = {
yellowfive@57 67 minimap = { -- minimap hide/show and position settings
yellowfive@57 68 hide = false
yellowfive@57 69 },
yellowfive@57 70 window = {}, -- main window position settings
yellowfive@57 71 shopWindow = {}, -- shopping list window position settings
yellowfive@161 72 junkWindow = {}, -- junk list window position settings
yellowfive@57 73 options = {
yellowfive@57 74 autoGear = false, -- auto-equip saved gear sets when changing specs
yellowfive@161 75 junkVendor = false, -- auto-show junk list at vendor/scrapper
yellowfive@61 76 shopAh = false, -- auto-show shopping list at AH
yellowfive@91 77 disableEm = false, -- disable auto-creation of equipment manager sets
yellowfive@61 78 uiScale = 1 -- custom scale for AMR UI
yellowfive@57 79 },
yellowfive@57 80 Logging = { -- global logging settings
yellowfive@57 81 Auto = {} -- for each instanceId, for each difficultyId, true if auto-logging enabled
yellowfive@57 82 }
yellowfive@57 83 },
yellowfive@57 84 global = {
yellowfive@57 85 Region = nil, -- region that this user is in, all characters on the same account should be the same region
yellowfive@139 86 Shopping2 = {}, -- shopping list data stored globally for access on any character
yellowfive@57 87 Logging = { -- a lot of log data is stored globally for simplicity, can only be raiding with one character at a time
yellowfive@57 88 Wipes = {}, -- times that a wipe was called
yellowfive@57 89 PlayerData = {}, -- player data gathered at fight start
yellowfive@57 90 PlayerExtras = {} -- player extra data like auras, gathered at fight start
yellowfive@57 91 }
yellowfive@57 92 }
yellowfive@57 93 }
yellowfive@57 94
yellowfive@124 95 Amr.db = LibStub("AceDB-3.0"):New("AskMrRobotDb4", defaults)
yellowfive@110 96
yellowfive@110 97 -- set defaults for auto logging; if a new zone is added and some other stuff was turned on, turn on the new zone too
yellowfive@110 98 local hasSomeLogging = false
yellowfive@110 99 local addedLogging = {}
yellowfive@57 100 for i, instanceId in ipairs(Amr.InstanceIdsOrdered) do
yellowfive@110 101 local byDiff = Amr.db.profile.Logging.Auto[instanceId]
yellowfive@57 102 if not byDiff then
yellowfive@57 103 byDiff = {}
yellowfive@110 104 Amr.db.profile.Logging.Auto[instanceId] = byDiff
yellowfive@110 105 addedLogging[instanceId] = byDiff
yellowfive@57 106 end
yellowfive@57 107
yellowfive@57 108 for k, difficultyId in pairs(Amr.Difficulties) do
yellowfive@110 109 if not byDiff[difficultyId] then
yellowfive@57 110 byDiff[difficultyId] = false
yellowfive@110 111 else
yellowfive@110 112 hasSomeLogging = true
yellowfive@57 113 end
yellowfive@57 114 end
yellowfive@137 115 end
yellowfive@137 116
yellowfive@137 117 for k,v in pairs(Amr.db.profile.Logging.Auto) do
yellowfive@137 118 if not Amr.IsSupportedInstanceId(k) then
yellowfive@137 119 Amr.db.profile.Logging.Auto[k] = nil
yellowfive@137 120 end
yellowfive@57 121 end
yellowfive@57 122
yellowfive@110 123 if hasSomeLogging then
yellowfive@110 124 for instanceId, byDiff in pairs(addedLogging) do
yellowfive@110 125 for k, difficultyId in pairs(Amr.Difficulties) do
yellowfive@110 126 byDiff[difficultyId] = true
yellowfive@110 127 end
yellowfive@110 128 end
yellowfive@110 129 end
yellowfive@110 130
yellowfive@139 131 -- upgrade old gear set info to new format
yellowfive@139 132 if Amr.db.char.GearSets then
yellowfive@139 133 Amr.db.char.GearSets = nil
yellowfive@139 134 end
yellowfive@139 135
yellowfive@139 136 if not Amr.db.char.GearSetups then
yellowfive@139 137 Amr.db.char.GearSetups = {}
yellowfive@139 138 end
yellowfive@139 139
yellowfive@139 140 if Amr.db.global.Shopping then
yellowfive@139 141 Amr.db.global.Shopping = nil
yellowfive@139 142 end
yellowfive@57 143
yellowfive@57 144 Amr.db.RegisterCallback(Amr, "OnProfileChanged", "RefreshConfig")
yellowfive@57 145 Amr.db.RegisterCallback(Amr, "OnProfileCopied", "RefreshConfig")
yellowfive@57 146 Amr.db.RegisterCallback(Amr, "OnProfileReset", "RefreshConfig")
yellowfive@57 147 end
yellowfive@57 148
yellowfive@57 149 function Amr:OnInitialize()
yellowfive@57 150
yellowfive@57 151 initializeDb()
yellowfive@57 152
yellowfive@57 153 Amr:RegisterChatCommand("amr", "SlashCommand")
yellowfive@57 154
yellowfive@57 155 _icon:Register(Amr.ADDON_NAME, _amrLDB, self.db.profile.minimap)
yellowfive@57 156
yellowfive@57 157 -- listen for inter-addon communication
yellowfive@139 158 self:RegisterComm(Amr.ChatPrefix, "OnCommReceived")
yellowfive@57 159 end
yellowfive@57 160
yellowfive@57 161 local _enteredWorld = false
yellowfive@57 162 local _pendingInit = false
yellowfive@57 163
yellowfive@139 164 -- upgrade some stuff from old to new formats
yellowfive@139 165 local function upgradeFromOld()
yellowfive@139 166
yellowfive@139 167 local currentVersion = tonumber(GetAddOnMetadata(Amr.ADDON_NAME, "Version"))
yellowfive@139 168 if Amr.db.char.LastVersion < 65 then
yellowfive@143 169
yellowfive@143 170 if not Amr.db.profile.options.disableEm then
yellowfive@143 171 for i = 1,GetNumSpecializations() do
yellowfive@143 172 local _, specName = GetSpecializationInfo(i)
yellowfive@143 173 if specName then
yellowfive@143 174 local setid = C_EquipmentSet.GetEquipmentSetID("AMR " .. specName)
yellowfive@143 175 if setid then
yellowfive@143 176 C_EquipmentSet.DeleteEquipmentSet(setid)
yellowfive@143 177 end
yellowfive@139 178 end
yellowfive@139 179 end
yellowfive@139 180 end
yellowfive@143 181
yellowfive@139 182 end
yellowfive@139 183 Amr.db.char.LastVersion = currentVersion
yellowfive@139 184
yellowfive@139 185 end
yellowfive@139 186
yellowfive@133 187 local function finishInitialize()
yellowfive@57 188
yellowfive@57 189 -- record region, the only thing that we still can't get from the log file
yellowfive@57 190 Amr.db.global.Region = Amr.RegionNames[GetCurrentRegion()]
yellowfive@57 191
yellowfive@57 192 -- make sure that some initialization is deferred until after PLAYER_ENTERING_WORLD event so that data we need is available;
yellowfive@57 193 -- also delay this initialization for a few extra seconds to deal with some event spam that is otherwise hard to identify and ignore when a player logs in
yellowfive@57 194 Amr.Wait(5, function()
yellowfive@145 195 --Amr:InitializeVersions()
yellowfive@57 196 Amr:InitializeGear()
yellowfive@57 197 Amr:InitializeExport()
yellowfive@57 198 Amr:InitializeCombatLog()
yellowfive@139 199
yellowfive@139 200 upgradeFromOld()
yellowfive@57 201 end)
yellowfive@57 202 end
yellowfive@57 203
yellowfive@133 204 local function onPlayerEnteringWorld()
yellowfive@57 205
yellowfive@57 206 _enteredWorld = true
yellowfive@57 207
yellowfive@57 208 if _pendingInit then
yellowfive@57 209 finishInitialize()
yellowfive@57 210 _pendingInit = false
yellowfive@57 211 end
yellowfive@57 212 end
yellowfive@57 213
yellowfive@57 214 function Amr:OnEnable()
yellowfive@57 215
yellowfive@81 216 --[[
yellowfive@57 217 -- listen for changes to the snapshot enable state, and always make sure it is enabled if using the core AskMrRobot addon
yellowfive@57 218 self:RegisterMessage("AMR_SNAPSHOT_STATE_CHANGED", function(eventName, isEnabled)
yellowfive@57 219 if not isEnabled then
yellowfive@57 220 -- immediately re-enable on any attempt to disable
yellowfive@57 221 Amr.Serializer:EnableSnapshots()
yellowfive@57 222 end
yellowfive@57 223 end)
yellowfive@57 224 self.Serializer:EnableSnapshots()
yellowfive@81 225 ]]
yellowfive@57 226
yellowfive@57 227 -- update based on current configuration whenever enabled
yellowfive@57 228 self:RefreshConfig()
yellowfive@57 229
yellowfive@57 230 -- if we have fully entered the world, do initialization; otherwise wait for PLAYER_ENTERING_WORLD to continue
yellowfive@57 231 if not _enteredWorld then
yellowfive@57 232 _pendingInit = true
yellowfive@57 233 else
yellowfive@57 234 _pendingInit = false
yellowfive@57 235 finishInitialize()
yellowfive@57 236 end
yellowfive@57 237 end
yellowfive@57 238
yellowfive@57 239 function Amr:OnDisable()
yellowfive@57 240 -- disabling is not supported
yellowfive@57 241 end
yellowfive@57 242
yellowfive@57 243
yellowfive@57 244 ----------------------------------------------------------------------------------------
yellowfive@57 245 -- Slash Commands
yellowfive@57 246 ----------------------------------------------------------------------------------------
yellowfive@57 247 local _slashMethods = {
yellowfive@57 248 hide = "Hide",
yellowfive@57 249 show = "Show",
yellowfive@57 250 toggle = "Toggle",
yellowfive@124 251 equip = "EquipGearSet",
yellowfive@57 252 version = "PrintVersions",
yellowfive@161 253 junk = "ShowJunkWindow",
yellowfive@124 254 --wipe = "Wipe",
yellowfive@124 255 --undowipe = "UndoWipe",
yellowfive@61 256 reset = "Reset",
yellowfive@57 257 test = "Test"
yellowfive@57 258 }
yellowfive@57 259
yellowfive@57 260 function Amr:SlashCommand(input)
yellowfive@57 261 input = string.lower(input)
yellowfive@57 262 local parts = {}
yellowfive@57 263 for w in input:gmatch("%S+") do
yellowfive@57 264 table.insert(parts, w)
yellowfive@57 265 end
yellowfive@57 266
yellowfive@57 267 if #parts == 0 then return end
yellowfive@57 268
yellowfive@57 269 local func = _slashMethods[parts[1]]
yellowfive@57 270 if not func then return end
yellowfive@57 271
yellowfive@57 272 local funcArgs = {}
yellowfive@57 273 for i = 2, #parts do
yellowfive@57 274 table.insert(funcArgs, parts[i])
yellowfive@57 275 end
yellowfive@57 276
yellowfive@57 277 Amr[func](Amr, unpack(funcArgs))
yellowfive@57 278 end
yellowfive@57 279
yellowfive@57 280
yellowfive@57 281 ----------------------------------------------------------------------------------------
yellowfive@57 282 -- Configuration
yellowfive@57 283 ----------------------------------------------------------------------------------------
yellowfive@57 284
yellowfive@57 285 -- refresh all state based on the current values of configuration options
yellowfive@57 286 function Amr:RefreshConfig()
yellowfive@57 287
yellowfive@57 288 self:UpdateMinimap()
yellowfive@57 289 self:RefreshOptionsUi()
yellowfive@57 290 self:RefreshLogUi()
yellowfive@57 291 end
yellowfive@57 292
yellowfive@57 293 function Amr:UpdateMinimap()
yellowfive@57 294
yellowfive@57 295 if self.db.profile.minimap.hide or not Amr:IsEnabled() then
yellowfive@57 296 _icon:Hide(Amr.ADDON_NAME)
yellowfive@57 297 else
yellowfive@57 298 -- change icon color if logging
yellowfive@57 299 if Amr:IsLogging() then
yellowfive@57 300 _amrLDB.icon = 'Interface\\AddOns\\AskMrRobot\\Media\\icon_green'
yellowfive@57 301 else
yellowfive@57 302 _amrLDB.icon = 'Interface\\AddOns\\AskMrRobot\\Media\\icon'
yellowfive@57 303 end
yellowfive@57 304
yellowfive@57 305 _icon:Show(Amr.ADDON_NAME)
yellowfive@57 306 end
yellowfive@57 307 end
yellowfive@57 308
yellowfive@57 309
yellowfive@57 310 ----------------------------------------------------------------------------------------
yellowfive@57 311 -- Version Checking
yellowfive@57 312 ----------------------------------------------------------------------------------------
yellowfive@57 313
yellowfive@57 314 -- version of addon being run by each person in the player's raid or group
yellowfive@57 315 Amr.GroupVersions = {}
yellowfive@57 316
yellowfive@57 317 local function toGroupVersionKey(realm, name)
yellowfive@57 318 realm = string.gsub(realm, "%s+", "")
yellowfive@57 319 return name .. "-" .. realm
yellowfive@57 320 end
yellowfive@57 321
yellowfive@57 322 -- prune out version information for players no longer in the current raid group
yellowfive@57 323 local function pruneVersionInfo()
yellowfive@57 324
yellowfive@57 325 local newVersions = {}
yellowfive@57 326 local units = Amr:GetGroupUnitIdentifiers()
yellowfive@57 327
yellowfive@57 328 for i, unitId in ipairs(units) do
yellowfive@57 329 local realm, name = Amr:GetRealmAndName(unitId)
yellowfive@57 330 if realm then
yellowfive@57 331 local key = toGroupVersionKey(realm, name)
yellowfive@57 332 newVersions[key] = Amr.GroupVersions[key]
yellowfive@57 333 end
yellowfive@57 334 end
yellowfive@57 335
yellowfive@57 336 Amr.GroupVersions = newVersions
yellowfive@57 337 end
yellowfive@57 338
yellowfive@57 339 -- send version information to other people in the same raid group
yellowfive@57 340 local function sendVersionInfo()
yellowfive@57 341
yellowfive@57 342 local realm = GetRealmName()
yellowfive@57 343 local name = UnitName("player")
yellowfive@57 344 local ver = GetAddOnMetadata(Amr.ADDON_NAME, "Version")
yellowfive@57 345
yellowfive@57 346 local msg = string.format("%s\n%s\n%s\n%s", Amr.MessageTypes.Version, realm, name, ver)
yellowfive@57 347 Amr:SendAmrCommMessage(msg)
yellowfive@57 348 end
yellowfive@57 349
yellowfive@57 350 local function onVersionInfoReceived(message)
yellowfive@57 351
yellowfive@57 352 -- message will be of format: realm\nname\nversion
yellowfive@57 353 local parts = {}
yellowfive@57 354 for part in string.gmatch(message, "([^\n]+)") do
yellowfive@57 355 table.insert(parts, part)
yellowfive@57 356 end
yellowfive@57 357
yellowfive@57 358 local key = toGroupVersionKey(parts[2], parts[3])
yellowfive@57 359 local ver = parts[4]
yellowfive@57 360
yellowfive@57 361 Amr.GroupVersions[key] = tonumber(ver)
yellowfive@57 362
yellowfive@57 363 -- make sure that versions are properly pruned in case this message arrived late and the player has since been removed from the group
yellowfive@57 364 pruneVersionInfo()
yellowfive@57 365 end
yellowfive@57 366
yellowfive@57 367 -- get the addon version another person in the player's raid/group is running, or 0 if they are not running the addon
yellowfive@57 368 function Amr:GetAddonVersion(realm, name)
yellowfive@57 369 local ver = Amr.GroupVersions[toGroupVersionKey(realm, name)]
yellowfive@57 370 return ver or 0
yellowfive@57 371 end
yellowfive@57 372
yellowfive@57 373 function Amr:PrintVersions()
yellowfive@57 374
yellowfive@57 375 if not IsInGroup() and not IsInRaid() then
yellowfive@57 376 self:Print(L.VersionChatNotGrouped)
yellowfive@57 377 return
yellowfive@57 378 end
yellowfive@57 379
yellowfive@57 380 local units = self:GetGroupUnitIdentifiers()
yellowfive@57 381
yellowfive@57 382 local msg = {}
yellowfive@57 383 table.insert(msg, L.VersionChatTitle)
yellowfive@57 384
yellowfive@57 385 for i, unitId in ipairs(units) do
yellowfive@57 386 local realm, name = self:GetRealmAndName(unitId)
yellowfive@57 387 if realm then
yellowfive@57 388 local key = toGroupVersionKey(realm, name)
yellowfive@57 389 local ver = Amr.GroupVersions[key]
yellowfive@57 390 if not ver then
yellowfive@57 391 table.insert(msg, key .. " |cFFFF0000" .. L.VersionChatNotInstalled .. "|r")
yellowfive@57 392 else
yellowfive@57 393 table.insert(msg, key .. " v" .. ver)
yellowfive@57 394 end
yellowfive@57 395 end
yellowfive@57 396 end
yellowfive@57 397
yellowfive@57 398 msg = table.concat(msg, "\n")
yellowfive@57 399 print(msg)
yellowfive@57 400 end
yellowfive@57 401
yellowfive@57 402 function Amr:InitializeVersions()
yellowfive@57 403 Amr:AddEventHandler("GROUP_ROSTER_UPDATE", pruneVersionInfo)
yellowfive@57 404 Amr:AddEventHandler("GROUP_ROSTER_UPDATE", sendVersionInfo)
yellowfive@57 405
yellowfive@57 406 -- request version information from anyone in my group upon initialization
yellowfive@57 407 if IsInGroup() or IsInRaid() then
yellowfive@57 408 Amr:SendAmrCommMessage(Amr.MessageTypes.VersionRequest)
yellowfive@57 409 end
yellowfive@57 410 end
yellowfive@57 411
yellowfive@57 412
yellowfive@57 413 ----------------------------------------------------------------------------------------
yellowfive@57 414 -- Generic Helpers
yellowfive@57 415 ----------------------------------------------------------------------------------------
yellowfive@57 416
yellowfive@57 417 local _waitTable = {}
yellowfive@57 418 local _waitFrame = nil
yellowfive@57 419
yellowfive@57 420 -- execute the specified function after the specified delay (in seconds)
yellowfive@57 421 function Amr.Wait(delay, func, ...)
yellowfive@57 422 if not _waitFrame then
yellowfive@57 423 _waitFrame = CreateFrame("Frame", "AmrWaitFrame", UIParent)
yellowfive@57 424 _waitFrame:SetScript("OnUpdate", function (self, elapse)
yellowfive@57 425 local count = #_waitTable
yellowfive@57 426 local i = 1
yellowfive@57 427 while(i <= count) do
yellowfive@57 428 local waitRecord = table.remove(_waitTable, i)
yellowfive@57 429 local d = table.remove(waitRecord, 1)
yellowfive@57 430 local f = table.remove(waitRecord, 1)
yellowfive@57 431 local p = table.remove(waitRecord, 1)
yellowfive@57 432 if d > elapse then
yellowfive@57 433 table.insert(_waitTable, i, { d-elapse, f, p })
yellowfive@57 434 i = i + 1
yellowfive@57 435 else
yellowfive@57 436 count = count - 1
yellowfive@57 437 f(unpack(p))
yellowfive@57 438 end
yellowfive@57 439 end
yellowfive@57 440 end)
yellowfive@57 441 end
yellowfive@57 442 table.insert(_waitTable, { delay, func, {...} })
yellowfive@57 443 return true
yellowfive@57 444 end
yellowfive@57 445
yellowfive@57 446 -- helper to iterate over a table in order by its keys
yellowfive@57 447 function Amr.spairs(t, order)
yellowfive@57 448 -- collect the keys
yellowfive@57 449 local keys = {}
yellowfive@57 450 for k in pairs(t) do keys[#keys+1] = k end
yellowfive@57 451
yellowfive@57 452 -- if order function given, sort by it by passing the table and keys a, b,
yellowfive@57 453 -- otherwise just sort the keys
yellowfive@57 454 if order then
yellowfive@57 455 table.sort(keys, function(a,b) return order(t, a, b) end)
yellowfive@57 456 else
yellowfive@57 457 table.sort(keys)
yellowfive@57 458 end
yellowfive@57 459
yellowfive@57 460 -- return the iterator function
yellowfive@57 461 local i = 0
yellowfive@57 462 return function()
yellowfive@57 463 i = i + 1
yellowfive@57 464 if keys[i] then
yellowfive@57 465 return keys[i], t[keys[i]]
yellowfive@57 466 end
yellowfive@57 467 end
yellowfive@57 468 end
yellowfive@57 469
yellowfive@57 470 function Amr.StartsWith(str, prefix)
yellowfive@57 471 if string.len(str) < string.len(prefix) then return false end
yellowfive@57 472 return string.sub(str, 1, string.len(prefix)) == prefix
yellowfive@57 473 end
yellowfive@57 474
yellowfive@124 475 function Amr.IsEmpty(table)
yellowfive@124 476 return next(table) == nil
yellowfive@124 477 end
yellowfive@124 478
yellowfive@124 479 function Amr.Contains(table, value)
yellowfive@124 480 if not table then return false end
yellowfive@124 481 for k,v in pairs(table) do
yellowfive@124 482 if v == value then
yellowfive@124 483 return true
yellowfive@124 484 end
yellowfive@124 485 end
yellowfive@124 486 return false
yellowfive@124 487 end
yellowfive@124 488
yellowfive@57 489 -- helper to get the unit identifiers (e.g. to pass to GetUnitName) for all members of the player's current group/raid
yellowfive@57 490 function Amr:GetGroupUnitIdentifiers()
yellowfive@57 491
yellowfive@57 492 local units = {}
yellowfive@57 493 if IsInRaid() then
yellowfive@57 494 for i = 1,40 do
yellowfive@57 495 table.insert(units, "raid" .. i)
yellowfive@57 496 end
yellowfive@57 497 elseif IsInGroup() then
yellowfive@57 498 table.insert(units, "player")
yellowfive@57 499 for i = 1,4 do
yellowfive@57 500 table.insert(units, "party" .. i)
yellowfive@57 501 end
yellowfive@57 502 else
yellowfive@57 503 table.insert(units, "player")
yellowfive@57 504 end
yellowfive@57 505
yellowfive@57 506 return units
yellowfive@57 507 end
yellowfive@57 508
yellowfive@57 509 -- helper to get the realm and name from a unitId (e.g. "player" or "raid1")
yellowfive@57 510 function Amr:GetRealmAndName(unitId)
yellowfive@57 511
yellowfive@57 512 local name = GetUnitName(unitId, true)
yellowfive@57 513 if not name then return end
yellowfive@57 514
yellowfive@57 515 local realm = GetRealmName()
yellowfive@57 516 local splitPos = string.find(name, "-")
yellowfive@57 517 if splitPos ~= nil then
yellowfive@57 518 realm = string.sub(name, splitPos + 1)
yellowfive@57 519 name = string.sub(name, 1, splitPos - 1)
yellowfive@57 520 end
yellowfive@57 521
yellowfive@57 522 return realm, name
yellowfive@57 523 end
yellowfive@57 524
yellowfive@57 525 -- find the unitid of a player given the name and realm... this comes from the server so the realm will be in english...
yellowfive@57 526 -- TODO: more robust handling of players with same name but different realms in the same group on non-english clients
yellowfive@57 527 function Amr:GetUnitId(unitRealm, unitName)
yellowfive@57 528
yellowfive@57 529 local nameMatches = {}
yellowfive@57 530
yellowfive@57 531 local units = Amr:GetGroupUnitIdentifiers()
yellowfive@57 532 for i, unitId in ipairs(units) do
yellowfive@57 533 local realm, name = Amr:GetRealmAndName(unitId)
yellowfive@57 534 if realm then
yellowfive@57 535 -- remove spaces to ensure proper matches
yellowfive@57 536 realm = string.gsub(realm, "%s+", "")
yellowfive@57 537 unitRealm = string.gsub(unitRealm, "%s+", "")
yellowfive@57 538
yellowfive@57 539 if unitRealm == realm and unitName == name then return unitId end
yellowfive@57 540 if unitName == name then
yellowfive@57 541 table.insert(nameMatches, unitId)
yellowfive@57 542 end
yellowfive@57 543 end
yellowfive@57 544 end
yellowfive@57 545
yellowfive@57 546 -- only one player with same name, must be the player of interest
yellowfive@57 547 if #nameMatches == 1 then return nameMatches[1] end
yellowfive@57 548
yellowfive@57 549 -- could not find or ambiguous
yellowfive@57 550 return nil
yellowfive@57 551 end
yellowfive@57 552
yellowfive@133 553 --[[
yellowfive@57 554 -- search the tooltip for txt, returns true if it is encountered on any line
yellowfive@57 555 function Amr:IsTextInTooltip(tt, txt)
yellowfive@57 556 local regions = { tt:GetRegions() }
yellowfive@57 557 for i, region in ipairs(regions) do
yellowfive@57 558 if region and region:GetObjectType() == "FontString" then
yellowfive@57 559 if region:GetText() == txt then
yellowfive@57 560 return true
yellowfive@57 561 end
yellowfive@57 562 end
yellowfive@57 563 end
yellowfive@57 564 return false
yellowfive@57 565 end
yellowfive@133 566 ]]
yellowfive@57 567
yellowfive@124 568 -- helper to determine if we can equip an item (it is soulbound)
yellowfive@59 569 function Amr:CanEquip(bagId, slotId)
yellowfive@124 570 local item = Item:CreateFromBagAndSlot(bagId, slotId)
yellowfive@124 571 if item then
yellowfive@124 572 local loc = item:GetItemLocation()
yellowfive@124 573 return C_Item.IsBound(loc)
yellowfive@124 574 else
yellowfive@124 575 -- for now just return true if we can't find the item... will get an error trying to equip if it isn't bound
yellowfive@124 576 return true
yellowfive@124 577 end
yellowfive@124 578
yellowfive@124 579 --local tt = Amr.GetItemTooltip(bagId, slotId)
yellowfive@124 580 --if self:IsTextInTooltip(tt, ITEM_SOULBOUND) then return true end
yellowfive@124 581 --if self:IsTextInTooltip(tt, ITEM_BNETACCOUNTBOUND) then return true end
yellowfive@124 582 --if self:IsTextInTooltip(tt, ITEM_ACCOUNTBOUND) then return true end
yellowfive@57 583 end
yellowfive@57 584
yellowfive@57 585 -- helper to determine if an item has a unique constraint
yellowfive@133 586 --[[
yellowfive@57 587 function Amr:IsUnique(bagId, slotId)
yellowfive@81 588 local tt = Amr.GetItemTooltip(bagId, slotId)
yellowfive@57 589 if self:IsTextInTooltip(tt, ITEM_UNIQUE_EQUIPPABLE) then return true end
yellowfive@57 590 if self:IsTextInTooltip(tt, ITEM_UNIQUE) then return true end
yellowfive@57 591 return false
yellowfive@57 592 end
yellowfive@133 593 ]]
yellowfive@57 594
yellowfive@57 595
yellowfive@57 596 ----------------------------------------------------------------------------------------
yellowfive@57 597 -- Inter-Addon Communication
yellowfive@57 598 ----------------------------------------------------------------------------------------
yellowfive@57 599 function Amr:SendAmrCommMessage(message, channel)
yellowfive@57 600 -- prepend version to all messages
yellowfive@57 601 local v = GetAddOnMetadata(Amr.ADDON_NAME, "Version")
yellowfive@57 602 message = v .. "\r" .. message
yellowfive@57 603
yellowfive@79 604 Amr:SendCommMessage(Amr.ChatPrefix, message, channel or (IsInGroup(LE_PARTY_CATEGORY_INSTANCE) and "INSTANCE_CHAT" or "RAID"))
yellowfive@57 605 end
yellowfive@57 606
yellowfive@57 607 function Amr:OnCommReceived(prefix, message, distribution, sender)
yellowfive@57 608
yellowfive@57 609 local parts = {}
yellowfive@57 610 for part in string.gmatch(message, "([^\r]+)") do
yellowfive@57 611 table.insert(parts, part)
yellowfive@57 612 end
yellowfive@57 613
yellowfive@57 614 local ver = parts[1]
yellowfive@57 615 if ver then ver = tonumber(ver) end
yellowfive@57 616 if ver then
yellowfive@57 617 -- newest versions of the addon start all messages with a version number
yellowfive@57 618 message = parts[2]
yellowfive@57 619 end
yellowfive@57 620
yellowfive@57 621 -- we always allow version checks, even from old versions of the addon that aren't otherwise compatible
yellowfive@57 622 if Amr.StartsWith(message, Amr.MessageTypes.Version) then
yellowfive@57 623 -- version checking between group members
yellowfive@57 624 if Amr.StartsWith(message, Amr.MessageTypes.VersionRequest) then
yellowfive@57 625 sendVersionInfo()
yellowfive@57 626 else
yellowfive@57 627 onVersionInfoReceived(message)
yellowfive@57 628 end
yellowfive@57 629
yellowfive@57 630 return
yellowfive@57 631 end
yellowfive@57 632
yellowfive@57 633 -- any other kind of message is ignored if the version is too old
yellowfive@57 634 if not ver or ver < Amr.MIN_ADDON_VERSION then return end
yellowfive@57 635
yellowfive@124 636 --[[
yellowfive@57 637 if Amr.StartsWith(message, Amr.MessageTypes.Team) then
yellowfive@57 638 -- if fully initialized, process team optimizer messages
yellowfive@57 639 if Amr["ProcessTeamMessage"] then
yellowfive@57 640 Amr:ProcessTeamMessage(message)
yellowfive@57 641 end
yellowfive@57 642 else
yellowfive@57 643 -- if we are fully loaded, process a player snapshot when it is received (combat logging)
yellowfive@57 644 if Amr["ProcessPlayerSnapshot"] then
yellowfive@57 645 self:ProcessPlayerSnapshot(message)
yellowfive@57 646 end
yellowfive@57 647 end
yellowfive@124 648 ]]
yellowfive@57 649 end
yellowfive@57 650
yellowfive@57 651
yellowfive@57 652 ----------------------------------------------------------------------------------------
yellowfive@57 653 -- Events
yellowfive@57 654 ----------------------------------------------------------------------------------------
yellowfive@57 655 local _eventHandlers = {}
yellowfive@57 656
yellowfive@57 657 local function handleEvent(eventName, ...)
yellowfive@57 658 local list = _eventHandlers[eventName]
yellowfive@57 659 if list then
yellowfive@57 660 --print(eventName .. " handled")
yellowfive@57 661 for i, handler in ipairs(list) do
yellowfive@57 662 if type(handler) == "function" then
yellowfive@57 663 handler(select(1, ...))
yellowfive@57 664 else
yellowfive@57 665 Amr[handler](Amr, select(1, ...))
yellowfive@57 666 end
yellowfive@57 667 end
yellowfive@57 668 end
yellowfive@57 669 end
yellowfive@57 670
yellowfive@57 671 -- WoW and Ace seem to work on a "one handler" kind of approach to events (as far as I can tell from the sparse documentation of both).
yellowfive@57 672 -- This is a simple wrapper to allow adding multiple handlers to the same event, thus allowing better encapsulation of code from file to file.
yellowfive@57 673 function Amr:AddEventHandler(eventName, methodOrName)
yellowfive@57 674 local list = _eventHandlers[eventName]
yellowfive@57 675 if not list then
yellowfive@57 676 list = {}
yellowfive@57 677 _eventHandlers[eventName] = list
yellowfive@57 678 Amr:RegisterEvent(eventName, handleEvent)
yellowfive@57 679 end
yellowfive@57 680 table.insert(list, methodOrName)
yellowfive@57 681 end
yellowfive@57 682
yellowfive@57 683 Amr:AddEventHandler("PLAYER_ENTERING_WORLD", onPlayerEnteringWorld)
yellowfive@57 684
yellowfive@57 685
yellowfive@57 686 ----------------------------------------------------------------------------------------
yellowfive@57 687 -- Debugging
yellowfive@57 688 ----------------------------------------------------------------------------------------
yellowfive@124 689 function Amr:dump(o)
yellowfive@124 690 if type(o) == 'table' then
yellowfive@124 691 local s = '{ '
yellowfive@124 692 for k,v in pairs(o) do
yellowfive@124 693 if type(k) ~= 'number' then k = '"'..k..'"' end
yellowfive@124 694 s = s .. '['..k..'] = ' .. Amr:dump(v) .. ','
yellowfive@124 695 end
yellowfive@124 696 return s .. '} '
yellowfive@124 697 else
yellowfive@124 698 return tostring(o)
yellowfive@124 699 end
yellowfive@124 700 end
yellowfive@124 701
yellowfive@69 702 function Amr:Test()
yellowfive@124 703
yellowfive@69 704 end