annotate Core.lua @ 139:c229c759a125 v65

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