annotate bossmods.lua @ 70:cdee65c1bd8c

Implement a list of items to be automatically marked as sent to the guild vault. List controlled on the Options tab like the existing filter. Default list is Cataclysm crafting material drops.
author Farmbuyer of US-Kilrogg <farmbuyer@gmail.com>
date Fri, 11 May 2012 03:56:21 +0000
parents c01875b275ca
children 095ee38508e8
rev   line source
farmbuyer@2 1 local addon = select(2,...)
farmbuyer@67 2 if addon.NOLOAD then return end
farmbuyer@2 3
farmbuyer@42 4 --[==[
farmbuyer@2 5 Here's the control flow:
farmbuyer@42 6 (1) This file or another addon calls
farmbuyer@42 7 addon:register_boss_mod("Foo",register[,unregister])
farmbuyer@2 8 (2) When OL decides it's time to register with a boss mod, it calls
farmbuyer@2 9 register (addon, addon_do_boss)
farmbuyer@2 10 which should do whatever's needed. This may happen more than once, if OL
farmbuyer@42 11 is turned on/off, etc. It should return a true value if successful.
farmbuyer@2 12 (2b) If a boss mod is already in place,
farmbuyer@2 13 unregister (addon)
farmbuyer@2 14 will be called first, if such a function was given at the start.
farmbuyer@2 15 (3) When the boss mod triggers a callback, this code should call
farmbuyer@2 16 addon_do_boss (.....)
farmbuyer@2 17 with the crapton of data passed as in the DBM-related code below.
farmbuyer@2 18
farmbuyer@2 19 NOTA BENE:
farmbuyer@2 20 - 'register' will not be called multiple times in a row for the same boss mod.
farmbuyer@2 21 - The callback for (3) must check if OL is appropriately active.
farmbuyer@2 22
farmbuyer@2 23 ------ Constants
farmbuyer@6 24 ------ Globals
farmbuyer@2 25 ------ Deadly Boss Mods
farmbuyer@42 26 ]==]
farmbuyer@2 27
farmbuyer@2 28 ------ Constants
farmbuyer@2 29
farmbuyer@6 30 ------ Globals
farmbuyer@2 31 local flib = LibStub("LibFarmbuyer")
farmbuyer@2 32 local pprint, tabledump = addon.pprint, flib.tabledump
farmbuyer@2 33
farmbuyer@2 34 -- Lua
farmbuyer@6 35 local pairs, ipairs, tinsert, tremove = pairs, ipairs, table.insert, table.remove
farmbuyer@6 36 local tonumber = tonumber
farmbuyer@2 37
farmbuyer@2 38 -- WoW
farmbuyer@56 39 --local GetRaidRosterInfo = GetRaidRosterInfo
farmbuyer@2 40
farmbuyer@2 41 -- OL
farmbuyer@2 42 local addon_do_boss
farmbuyer@2 43
farmbuyer@2 44
farmbuyer@2 45 ------ Deadly Boss Mods
farmbuyer@2 46 do
farmbuyer@42 47 local DBM
farmbuyer@56 48 local location, maxsize
farmbuyer@42 49 local real_loadmod
farmbuyer@42 50 -- When zoning into a raid instance not seen this session, make sure
farmbuyer@42 51 -- we don't report a previous raid instance as current location. DBM
farmbuyer@42 52 -- has no callback event for this, so we do a small hook instead.
farmbuyer@42 53 local function resetting_loadmod (...)
farmbuyer@42 54 addon.latest_instance = nil
farmbuyer@42 55 return real_loadmod(...)
farmbuyer@42 56 end
farmbuyer@42 57
farmbuyer@2 58 local function DBMBossCallback (self, reason, mod, ...)
farmbuyer@2 59 if (not self.rebroadcast) and (not self.enabled) then return end
farmbuyer@2 60
farmbuyer@2 61 local name
farmbuyer@2 62 if mod.combatInfo and mod.combatInfo.name then
farmbuyer@2 63 name = mod.combatInfo.name
farmbuyer@2 64 elseif mod.id then
farmbuyer@2 65 name = mod.id
farmbuyer@2 66 else
farmbuyer@2 67 name = "Unknown Boss"
farmbuyer@2 68 end
farmbuyer@2 69
farmbuyer@56 70 local it
farmbuyer@56 71 if location then
farmbuyer@56 72 it = location
farmbuyer@56 73 else
farmbuyer@56 74 it, maxsize = self.instance_tag()
farmbuyer@56 75 end
farmbuyer@42 76 self.latest_instance = it
farmbuyer@2 77 location = nil
farmbuyer@2 78
farmbuyer@2 79 local duration = 0
farmbuyer@2 80 if mod.combatInfo and mod.combatInfo.pull then
farmbuyer@2 81 duration = math.floor (GetTime() - mod.combatInfo.pull)
farmbuyer@2 82 end
farmbuyer@2 83
farmbuyer@56 84 return addon_do_boss (self, reason, name, it, maxsize, duration)
farmbuyer@2 85 end
farmbuyer@2 86
farmbuyer@2 87 local function callback(...) DBMBossCallback(addon,...) end
farmbuyer@2 88
farmbuyer@2 89 local function _registerDBM (self, OL_boss_worker)
farmbuyer@42 90 DBM = _G.DBM
farmbuyer@42 91 if DBM then
farmbuyer@2 92 local rev = tonumber(DBM.Revision) or 0
farmbuyer@2 93 if rev < 1503 then
farmbuyer@2 94 self.status_text = "|cffff1010Deadly Boss Mods must be version 1.26 or newer to work with Ouro Loot.|r"
farmbuyer@2 95 return
farmbuyer@2 96 end
farmbuyer@2 97 addon_do_boss = OL_boss_worker
farmbuyer@42 98 local r = DBM:RegisterCallback("kill", callback)
farmbuyer@42 99 DBM:RegisterCallback("wipe", callback)
farmbuyer@56 100 DBM:RegisterCallback("pull", function()
farmbuyer@56 101 location, maxsize = self.instance_tag()
farmbuyer@56 102 end)
farmbuyer@42 103 real_loadmod = DBM.LoadMod
farmbuyer@42 104 DBM.LoadMod = resetting_loadmod
farmbuyer@2 105 return r > 0
farmbuyer@2 106 else
farmbuyer@2 107 self.status_text = "|cffff1010Ouro Loot cannot find Deadly Boss Mods, loot will not be grouped by boss.|r"
farmbuyer@2 108 end
farmbuyer@2 109 end
farmbuyer@2 110
farmbuyer@42 111 local function _unregisterDBM (self)
farmbuyer@42 112 self.latest_instance = nil
farmbuyer@42 113 DBM.LoadMod = real_loadmod
farmbuyer@42 114 end
farmbuyer@42 115
farmbuyer@42 116 addon:register_boss_mod ("DBM", _registerDBM, _unregisterDBM)
farmbuyer@2 117 end -- DBM tie-ins
farmbuyer@2 118
farmbuyer@2 119
farmbuyer@2 120 -- DXE, BigWigs, etc, need to be researched for this too
farmbuyer@2 121
farmbuyer@2 122 -- vim:noet