annotate Degaine.lua @ 47:f861e1c0535b v1.0beta11

Take into account that sheathing while drawing doesn't actually sheath
author contrebasse
date Sun, 27 Feb 2011 21:24:10 +0100
parents 1967c9a3c5c2
children 94566cb4534f
rev   line source
contrebasse@43 1 local AddonName, T = ...
contrebasse@5 2 -- Draw your weapons automagically
contrebasse@0 3
contrebasse@12 4
contrebasse@12 5 ---------------------------------------------------------------
contrebasse@12 6 -- Known bugs
contrebasse@12 7 ---------------------------------------------------------------
contrebasse@10 8 -- If you stand up by jumping or walking it won't draw your weapon
contrebasse@10 9 -- (it's not possible to know if you were sitting or standing before)
contrebasse@0 10
contrebasse@5 11 --@debug@
contrebasse@28 12 local debug = false
contrebasse@5 13 --@end-debug@
contrebasse@0 14
contrebasse@12 15
contrebasse@5 16 ---------------------------------------------------------------
contrebasse@5 17 -- Globals to local
contrebasse@5 18 ---------------------------------------------------------------
contrebasse@21 19 -- These need to be globals :
contrebasse@6 20 -- GLOBALS: Degaine_ToggleAuto, Degaine_isAuto, BINDING_HEADER_DEGAINE
contrebasse@0 21
contrebasse@21 22 -- It doesn't matter if they are globals, rarely unsed :
contrebasse@14 23 -- GLOBALS: DEFAULT_CHAT_FRAME
contrebasse@5 24
contrebasse@5 25 -- Lua functions
contrebasse@0 26 local pairs = pairs;
contrebasse@0 27 local type = type;
contrebasse@35 28 local select = select
contrebasse@0 29
contrebasse@5 30 -- Wow functions
contrebasse@14 31 local GetTime = GetTime
contrebasse@5 32 local InCombatLockdown = InCombatLockdown
contrebasse@5 33 local ToggleSheath = ToggleSheath
contrebasse@20 34 local UnitName = UnitName
contrebasse@24 35 local IsMounted = IsMounted
contrebasse@33 36 local UnitCastingInfo = UnitCastingInfo
contrebasse@35 37 local GetUnitSpeed = GetUnitSpeed
contrebasse@0 38
contrebasse@0 39
contrebasse@5 40 ---------------------------------------------------------------
contrebasse@8 41 -- Local vars
contrebasse@8 42 ---------------------------------------------------------------
contrebasse@8 43 -- const
contrebasse@8 44 local DegaineFrame = CreateFrame("Frame")
contrebasse@8 45 local playername = UnitName("player")
contrebasse@35 46 local delay = 2.5 -- seconds
contrebasse@35 47 local delay_short = 0.5 -- seconds
contrebasse@8 48
contrebasse@8 49 -- vars
contrebasse@8 50 local t_left = -1
contrebasse@14 51 local isGossipClosed = true
contrebasse@14 52 local wasGossipOpened = false
contrebasse@14 53 local t_lastGossipClosed = 0
contrebasse@34 54 --local wasMounted = IsMounted() -- handle mounts with UNIT_AURA
contrebasse@33 55 local isTradeSkill = false
contrebasse@47 56 local t_lastDegaine = 0 -- Time of the last draw
contrebasse@8 57
contrebasse@12 58
contrebasse@8 59 ---------------------------------------------------------------
contrebasse@5 60 -- Some stuff...
contrebasse@5 61 ---------------------------------------------------------------
contrebasse@5 62 -- Bindings
contrebasse@5 63 BINDING_HEADER_DEGAINE = "Dégainer automatiquement"
contrebasse@5 64
contrebasse@5 65 -- Print status
contrebasse@5 66 local printState = function()
contrebasse@11 67 DEFAULT_CHAT_FRAME:AddMessage(Degaine_isAuto and "Dégainage automatique |cFF00FF00activé|r" or "Dégainage automatique |cFFFF0000désactivé|r")
contrebasse@5 68 end
contrebasse@5 69
contrebasse@5 70
contrebasse@5 71 ---------------------------------------------------------------
contrebasse@28 72 -- Launch drawing weapons
contrebasse@28 73 ---------------------------------------------------------------
contrebasse@28 74 -- Wait a few seconds before drawing, to be able to see the curren animation (and avoid bugs)
contrebasse@28 75 local Degaine_OnUpdate = function(self,t_elapsed)
contrebasse@28 76 t_left = t_left - t_elapsed;
contrebasse@28 77 if t_left<=0 then
contrebasse@28 78 ToggleSheath()
contrebasse@28 79 DegaineFrame:SetScript("OnUpdate", nil)
contrebasse@47 80 t_lastDegaine = GetTime()
contrebasse@28 81 end
contrebasse@28 82 end
contrebasse@32 83 local start = function(arg_delay)
contrebasse@43 84
contrebasse@43 85 --@debug@
contrebasse@43 86 --DEFAULT_CHAT_FRAME:AddMessage("Go !")
contrebasse@43 87 --@end-debug@
contrebasse@43 88
contrebasse@47 89 if Degaine_isAuto and (GetTime()-t_lastDegaine)>1 and not InCombatLockdown() then
contrebasse@32 90 t_left = arg_delay or delay
contrebasse@28 91 DegaineFrame:SetScript("OnUpdate", Degaine_OnUpdate)
contrebasse@28 92 end
contrebasse@28 93 end
contrebasse@28 94
contrebasse@28 95
contrebasse@28 96 ---------------------------------------------------------------
contrebasse@5 97 -- Events config
contrebasse@5 98 ---------------------------------------------------------------
contrebasse@5 99 -- Events to watch
contrebasse@5 100 local events = { -- no args to watch
contrebasse@14 101 GOSSIP_SHOW = function()
contrebasse@19 102 -- isGossipClosed :
contrebasse@19 103 -- if the gossip is already opened, no need to draw weapon
contrebasse@19 104 -- UnitName("npc")==UnitName("target") :
contrebasse@19 105 -- hack gossips again because there's no emote with non npc
contrebasse@19 106 -- you have to target the npc to interact with it
contrebasse@19 107 -- things such as boards can't be targeted and start no emote
contrebasse@17 108 local returnvalue = isGossipClosed and UnitName("npc")==UnitName("target")
contrebasse@14 109 isGossipClosed = false
contrebasse@14 110 return returnvalue
contrebasse@14 111 end,
contrebasse@14 112 MERCHANT_SHOW = function()
contrebasse@19 113 -- hack for the cases where the merchant's frame is opened from a gossip frame :
contrebasse@19 114 -- the gossip is closed and the merchant opened but the weapon is not stealthed
contrebasse@14 115 if (GetTime() - t_lastGossipClosed) < 0.5 then
contrebasse@14 116 return not wasGossipOpened
contrebasse@14 117 else
contrebasse@14 118 return isGossipClosed
contrebasse@14 119 end
contrebasse@14 120 end,
contrebasse@41 121 QUEST_PROGRESS = true,
contrebasse@11 122 BANKFRAME_OPENED = true, --function() return GossipFrame:IsShown() end,
contrebasse@0 123 AUCTION_HOUSE_SHOW = true,
contrebasse@5 124 }
contrebasse@5 125 local events1player = { -- the first arg is "player"
contrebasse@5 126 UNIT_SPELLCAST_FAILED = true,
contrebasse@5 127 UNIT_SPELLCAST_INTERRUPTED = true,
contrebasse@5 128 UNIT_SPELLCAST_SUCCEEDED = true,
contrebasse@33 129 UNIT_SPELLCAST_START = true, -- to ckeck tradeskill
contrebasse@5 130 }
contrebasse@31 131
contrebasse@43 132 --[[
contrebasse@43 133 -- Was used when moving prevented to play the emote when talking
contrebasse@43 134 -- Was needed for CHAT_MSG_SAY and CHAT_MSG_YELL
contrebasse@35 135 local function playerIsNotMoving()
contrebasse@35 136 return GetUnitSpeed("player") == 0
contrebasse@35 137 end
contrebasse@43 138 --]]
contrebasse@5 139 local events2playername = { -- the 2nd arg is playername
contrebasse@43 140 CHAT_MSG_SAY = true,
contrebasse@43 141 CHAT_MSG_YELL = true,
contrebasse@35 142 CHAT_MSG_TEXT_EMOTE = true, -- the emote is not shown, but the weapon is stealthed
contrebasse@5 143 }
contrebasse@0 144
contrebasse@0 145
contrebasse@5 146 ---------------------------------------------------------------
contrebasse@24 147 -- Handle mounts with OnUpdate
contrebasse@24 148 ---------------------------------------------------------------
contrebasse@24 149 -- works with GupPet but not with the default interface...
contrebasse@24 150 -- I guess that's because a specific /cancelaura or alike is done
contrebasse@24 151 -- hooksecurefunc("Dismount",start);
contrebasse@24 152
contrebasse@28 153 -- With OnUpdate
contrebasse@24 154 local handleMountsFrame = CreateFrame("frame")
contrebasse@24 155 local handleMountsOnUpdate
contrebasse@24 156 do
contrebasse@24 157 local IsMounted = IsMounted
contrebasse@24 158 local wasMounted = IsMounted()
contrebasse@24 159 function handleMountsOnUpdate(self,t_elapsed)
contrebasse@24 160 if IsMounted() then
contrebasse@24 161 wasMounted = true
contrebasse@24 162 else
contrebasse@24 163 if wasMounted then
contrebasse@35 164 start(delay_short) -- no animation for unmounting
contrebasse@24 165 wasMounted = false
contrebasse@24 166 end
contrebasse@24 167 end
contrebasse@24 168 end
contrebasse@24 169 end
contrebasse@5 170
contrebasse@12 171
contrebasse@5 172 ---------------------------------------------------------------
contrebasse@5 173 -- Activation functions
contrebasse@5 174 ---------------------------------------------------------------
contrebasse@5 175 local activate = function()
contrebasse@5 176 if (not Degaine_isAuto) or InCombatLockdown() then return end
contrebasse@5 177
contrebasse@9 178 --DegaineFrame:SetScript("OnUpdate", Degaine_OnUpdate);
contrebasse@5 179 --@debug@
contrebasse@5 180 if debug then
contrebasse@11 181 DegaineFrame:RegisterAllEvents()
contrebasse@5 182 else
contrebasse@5 183 --@end-debug@
contrebasse@18 184 for k,_ in pairs(events) do DegaineFrame:RegisterEvent(k) end
contrebasse@18 185 for k,_ in pairs(events1player) do DegaineFrame:RegisterEvent(k) end
contrebasse@18 186 for k,_ in pairs(events2playername) do DegaineFrame:RegisterEvent(k) end
contrebasse@28 187 --DegaineFrame:RegisterEvent("UNIT_AURA")
contrebasse@28 188 handleMountsFrame:SetScript("OnUpdate",handleMountsOnUpdate)
contrebasse@39 189 --@debug@
contrebasse@5 190 end
contrebasse@5 191 --@end-debug@
contrebasse@0 192 end
contrebasse@5 193 local desactivate = function()
contrebasse@24 194 DegaineFrame:SetScript("OnUpdate", nil)
contrebasse@24 195 t_left = -1
contrebasse@37 196 isTradeSkill = false
contrebasse@18 197 for k,_ in pairs(events) do DegaineFrame:UnregisterEvent(k) end
contrebasse@18 198 for k,_ in pairs(events1player) do DegaineFrame:UnregisterEvent(k) end
contrebasse@18 199 for k,_ in pairs(events2playername) do DegaineFrame:UnregisterEvent(k) end
contrebasse@28 200 --DegaineFrame:UnregisterEvent("UNIT_AURA")
contrebasse@28 201 handleMountsFrame:SetScript("OnUpdate",nil)
contrebasse@0 202 end
contrebasse@6 203 Degaine_ToggleAuto = function()
contrebasse@5 204 if Degaine_isAuto then
contrebasse@5 205 Degaine_isAuto = false
contrebasse@5 206 desactivate()
contrebasse@5 207 else
contrebasse@5 208 Degaine_isAuto = true
contrebasse@5 209 activate()
contrebasse@5 210 end
contrebasse@5 211 printState()
contrebasse@5 212 end
contrebasse@0 213
contrebasse@5 214
contrebasse@24 215
contrebasse@5 216 ---------------------------------------------------------------
contrebasse@5 217 -- Event/hooks functions
contrebasse@5 218 ---------------------------------------------------------------
contrebasse@12 219 local Degaine_OnEvent = function(self,event, arg1, arg2, _, _, arg5, ...)
contrebasse@5 220 --@debug@
contrebasse@41 221 if debug then
contrebasse@41 222 DEFAULT_CHAT_FRAME:AddMessage(event)
contrebasse@41 223 if arg1 then DEFAULT_CHAT_FRAME:AddMessage("arg1 = "..arg1) end
contrebasse@41 224 if arg2 then DEFAULT_CHAT_FRAME:AddMessage("arg2 = "..arg2) end
contrebasse@41 225 end
contrebasse@5 226 --@end-debug@
contrebasse@5 227
contrebasse@28 228 --[[ IsMounted() renvoie toujours false ici, on doit passer par OnUpdate
contrebasse@28 229 if event=="UNIT_AURA" then
contrebasse@28 230 if arg1=="player" then
contrebasse@28 231 DEFAULT_CHAT_FRAME:AddMessage("player")
contrebasse@28 232 if IsMounted() then
contrebasse@28 233 DEFAULT_CHAT_FRAME:AddMessage("ismounted")
contrebasse@28 234 wasMounted = true
contrebasse@28 235 else
contrebasse@28 236 DEFAULT_CHAT_FRAME:AddMessage("notmounted")
contrebasse@28 237 if wasMounted then
contrebasse@28 238 DEFAULT_CHAT_FRAME:AddMessage("wasmounted : start")
contrebasse@28 239 wasMounted = false
contrebasse@28 240 start()
contrebasse@28 241 end
contrebasse@28 242 end
contrebasse@28 243 end
contrebasse@28 244 else
contrebasse@28 245 --]]
contrebasse@12 246 if events[event] then
contrebasse@12 247 if type(events[event])~="function" or events[event]() then
contrebasse@12 248 start()
contrebasse@12 249 end
contrebasse@12 250 elseif events1player[event] then
contrebasse@12 251 if arg1=="player" then
contrebasse@33 252 if event == "UNIT_SPELLCAST_START" then
contrebasse@33 253 --name, nameSubtext, text, texture, startTime, endTime, isTradeSkill, castID, notInterruptible = UnitCastingInfo("unit")
contrebasse@33 254 isTradeSkill = select(7,UnitCastingInfo("player"))
contrebasse@33 255 --DEFAULT_CHAT_FRAME:AddMessage(name)
contrebasse@33 256 --DEFAULT_CHAT_FRAME:AddMessage(isTradeSkill and "True" or "False")
contrebasse@33 257 --if isTradeSkill then
contrebasse@33 258
contrebasse@33 259 --end
contrebasse@44 260 --elseif arg5 and not T.SpellBlackList[arg5] then -- arg5 is SpellID
contrebasse@44 261 elseif (arg5 and T.SpellWhiteList[arg5]) or isTradeSkill then -- arg5 is SpellID
contrebasse@33 262 isTradeSkill = false -- for next time
contrebasse@44 263 start(type(T.SpellWhiteList[arg5])=="number" and T.SpellWhiteList[arg5] or delay_short)
contrebasse@12 264 end
contrebasse@12 265 end
contrebasse@12 266 elseif events2playername[event] then
contrebasse@35 267 if arg2==playername and (type(events2playername[event])~="function" or events2playername[event]()) then
contrebasse@12 268 start()
contrebasse@12 269 end
contrebasse@14 270 elseif event == "GOSSIP_CLOSED" then
contrebasse@14 271 wasGossipOpened = not isGossipClosed
contrebasse@14 272 isGossipClosed = true
contrebasse@14 273 t_lastGossipClosed = GetTime()
contrebasse@5 274
contrebasse@0 275 elseif event == "PLAYER_REGEN_ENABLED" then
contrebasse@21 276 for k,_ in pairs(events1player) do DegaineFrame:UnregisterEvent(k) end
contrebasse@21 277 --desactivate()
contrebasse@0 278 elseif event == "PLAYER_REGEN_DISABLED" then
contrebasse@22 279 for k,_ in pairs(events1player) do DegaineFrame:RegisterEvent(k) end
contrebasse@22 280 --activate()
contrebasse@5 281
contrebasse@0 282 elseif event == "ADDON_LOADED" and arg1==AddonName then
contrebasse@5 283 if Degaine_isAuto==nil then
contrebasse@5 284 Degaine_isAuto = true
contrebasse@0 285 end
contrebasse@11 286 if Degaine_isAuto then activate() else desactivate() end
contrebasse@5 287 printState()
contrebasse@5 288
contrebasse@5 289 -- Not needed anymore
contrebasse@5 290 DegaineFrame:UnregisterEvent("ADDON_LOADED")
contrebasse@31 291
contrebasse@31 292 elseif event == "PLAYER_LOGIN" then
contrebasse@44 293 -- BLacklis alomst all Companions and mounts
contrebasse@44 294 T.DoBlackListCrittersAndMount()
contrebasse@0 295 end
contrebasse@0 296 end
contrebasse@31 297
contrebasse@5 298 -- Hook when standing up
contrebasse@5 299 -- (Didn't work, see http://forums.wowace.com/showthread.php?p=310547#post310547)
contrebasse@8 300 hooksecurefunc("SitStandOrDescendStart",start);
contrebasse@0 301
contrebasse@0 302
contrebasse@6 303 ---------------------------------------------------------------
contrebasse@6 304 -- Commands
contrebasse@6 305 ---------------------------------------------------------------
contrebasse@6 306 -- Bindings
contrebasse@6 307 BINDING_HEADER_DEGAINE = "Dégainer automatiquement"
contrebasse@6 308
contrebasse@6 309 -- Slash command
contrebasse@7 310 -- GLOBALS: SLASH_DEGAINE1
contrebasse@7 311 SLASH_DEGAINE1 = "/degaine"
contrebasse@6 312 SlashCmdList["DEGAINE"] = Degaine_ToggleAuto
contrebasse@6 313
contrebasse@5 314
contrebasse@5 315 ---------------------------------------------------------------
contrebasse@5 316 -- Initialization
contrebasse@5 317 ---------------------------------------------------------------
contrebasse@5 318 DegaineFrame:SetScript("OnEvent",Degaine_OnEvent)
contrebasse@5 319
contrebasse@5 320 -- Global events
contrebasse@14 321 DegaineFrame:RegisterEvent("GOSSIP_CLOSED")
contrebasse@5 322 DegaineFrame:RegisterEvent("PLAYER_REGEN_ENABLED")
contrebasse@5 323 DegaineFrame:RegisterEvent("PLAYER_REGEN_DISABLED")
contrebasse@5 324 DegaineFrame:RegisterEvent("ADDON_LOADED")
contrebasse@31 325 DegaineFrame:RegisterEvent("PLAYER_LOGIN")
contrebasse@5 326 activate()