Get an Epic Experience with Premium

Bitten's SpellFlash Library

Libraries Login to Add Favorites
  • World of Warcraft
  • 9,562 Monthly Downloads
  • Supports: 6.1.0
  • 6,683,219 Total Downloads
  • Updated 03/09/2015
  • Created 04/28/2012
  • 575 Favorites
  • Project Site
  • Comments
  • Release Type: Release
  • License: All Rights Reserved
  • Newest File: 60100.201503092107

About Bitten's SpellFlash Library

When you download one of Bitten's SpellFlash class modules, it comes with a copy of this addon. You do not need to download this addon separately. If you have it installed, you can delete it. That is, of course, unless you like to install the "nolib" versions of addons - but in that case you should know what you are doing and I don't need to give you any more instruction. :)

This is a library to make SpellFlash modules easier to create. Please see the FAQ before posting a question. If that doesn't address your issue, or you have a suggestion to improve this addon, please either leave a comment or create a ticket.

If you are an addon author and want to learn more, read on. If you are not an addon author, there is nothing here you need to worry about - read on only only if you're curious.

Help with cooldown and (de)buff timing

There are often times when want to know whether a certain (de)buff will be present when it's time to cast the next spell. If you use a naive approach of simply checking for the presence of a buff now, and it falls off half way through your current cast, you may have been flashing the wrong spell. There are clones of many (de)buff and cooldown checking functions that allow you to get the information you need easily. For example this library function:

function c.GetMyDebuffDuration(name, noGCD)
    return s.MyDebuffDuration(c.GetID(name)) - c.GetBusyTime(noGCD)

Passing a value for noGCD will cause it to ignore the global cooldown, which is useful for spells that are not on the gcd. Otherwise it uses the longer of the gcd and your current cast.

International support without cluttering your code with spell IDs

There are clones of several often-used SpellFlash functions that translate from the spell name you pass to their spell id. For example, you can replace calls that look like

s.Buff(74434--[[Soulburn]], "player")

With calls that look like


Without fear of your code breaking when used on a non-English client. There is also a function, c.GetID("name"), that you can use if a cloned function does not exist in the library. Note that for these functions to work, you must have the spell or buff defined in a.spells.

Estimated Harm and Heal Target Counts

During your rotation function you will have access to the estimated harm and heal targets, to smoothly ramp through AoE rotatinos:

if c.EstimatedHarmTargets > 2 then
if c.EstimatedHealTargets > 5 then
Learning More

There are several other little features, like simplifying your Spam function while supporting options to turn rotations on and off. Feel free to browse the source to learn more. All of Bitten's SpellFlash modules use this library, so any of them provide examples of how to use it.

r393 | slippycheeze | 2015-03-10 04:07:20 +0000 (Tue, 10 Mar 2015) | 1 line
Changed paths:
   A /tags/60100.201503092107 (from /trunk:392)

Create tag 60100.201503092107
r392 | slippycheeze | 2015-03-10 04:07:01 +0000 (Tue, 10 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/LDB.lua

Be safer about LDB updates
r391 | slippycheeze | 2015-03-10 04:06:57 +0000 (Tue, 10 Mar 2015) | 4 lines
Changed paths:
   M /trunk/src/Events.lua

Disable debugging of "missing" spells.

In the long term this needs a real fix, but for now this avoids
cluttering the debug log with nothing but this report for many users.
r390 | slippycheeze | 2015-03-10 04:06:52 +0000 (Tue, 10 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/Debug.lua

Bump debug ring count to 250, from 100, messages
r389 | slippycheeze | 2015-03-10 04:06:48 +0000 (Tue, 10 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/BittensSpellFlashLibrary.lua

Play it safer calling UpdateLDB, since it sometimes is out of date
r388 | slippycheeze | 2015-03-10 04:06:43 +0000 (Tue, 10 Mar 2015) | 3 lines
Changed paths:
   M /trunk/src/LDB.lua

Protect against changing settings before the LDB update runs

This can happen if we don't have any flashing going on.
r386 | slippycheeze | 2015-03-09 02:21:39 +0000 (Mon, 09 Mar 2015) | 1 line
Changed paths:
   M /trunk/BittensSpellFlashLibrary.toc
   A /trunk/BittensSpellFlashLibrary.xml

Restore XML file to fix loading embedded versions of addon
r384 | slippycheeze | 2015-03-08 21:35:24 +0000 (Sun, 08 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/Debug.lua

Fix focus update for BSF report window
r383 | slippycheeze | 2015-03-08 21:35:20 +0000 (Sun, 08 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/LDB.lua
   M /trunk/src/OptionsFrames.lua

Add option to enable/disable minimap icon
r382 | slippycheeze | 2015-03-08 21:35:16 +0000 (Sun, 08 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/Debug.lua
   M /trunk/src/SlashCommands.lua

Improve clarity of the debug log ring code
r381 | slippycheeze | 2015-03-08 21:35:12 +0000 (Sun, 08 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/BittensSpellFlashLibrary.lua
   M /trunk/src/LDB.lua

Further LDB updates, including AoE target count text
r380 | slippycheeze | 2015-03-08 21:35:07 +0000 (Sun, 08 Mar 2015) | 1 line
Changed paths:
   M /trunk/src/Debug.lua

Work around Windows platform bug with lua date function
r379 | slippycheeze | 2015-03-07 01:33:08 +0000 (Sat, 07 Mar 2015) | 1 line
Changed paths:
   M /trunk/BittensSpellFlashLibrary.toc

Use backslash to appease Blizzard / WoW windows history...
r378 | slippycheeze | 2015-03-06 06:38:47 +0000 (Fri, 06 Mar 2015) | 5 lines
Changed paths:
   M /trunk/.pkgmeta
   M /trunk/BittensSpellFlashLibrary.toc
   A /trunk/src/LDB.lua
   M /trunk/src/SlashCommands.lua

Implement LDB and minimap icons for BSF reports

This doesn't do everything that I want it to do (eg: display info on
rotations, etc), but it is a good start in getting the machinery hooked
up and correct.
r377 | slippycheeze | 2015-03-06 05:54:08 +0000 (Fri, 06 Mar 2015) | 5 lines
Changed paths:
   M /trunk/.pkgmeta

Add externals to create LDB and minimap icons

This is a bump for packaging testing, but shortly these will be
implemented to allow users to see some internal state (AoE, rotation
mode, etc), and also to trigger the bug reporting window.
r376 | slippycheeze | 2015-03-06 05:54:04 +0000 (Fri, 06 Mar 2015) | 8 lines
Changed paths:
   M /trunk/.pkgmeta
   M /trunk/BittensSpellFlashLibrary.toc
   M /trunk/src/BittensSpellFlashLibrary.lua
   M /trunk/src/Debug.lua
   M /trunk/src/SlashCommands.lua

Implement `/bsf report` fully

This ditches the AceGUI dependency, and just hand-codes the window.
Which is awesome fun, I can tell you -- 1980 called and wants their UI
design code back.

Anyway, this now reports the extra details I need, includes guidance for
the user, and is generally pretty reasonable.
r375 | slippycheeze | 2015-03-02 06:16:34 +0000 (Mon, 02 Mar 2015) | 16 lines
Changed paths:
   D /trunk/.buildpath
   M /trunk/.pkgmeta
   D /trunk/.project
   M /trunk/BittensSpellFlashLibrary.toc
   D /trunk/BittensSpellFlashLibrary.xml
   A /trunk/src/Debug.lua
   M /trunk/src/SlashCommands.lua
   D /trunk/version_history.txt

Start implementing `/bsf report` to report issues

One of the ongoing problems has been that it is hard to get users to
report the right information when they feel like the rotation is off, or
a spell is missing, or something like that.

This is a start of a GUI interface to capture and export the debug log,
even if it wasn't shown, as well as details about spec, level, and
whatever other details turn out to be useful in the longer term for
debugging problems.

The biggest feature in this specific change is an attempt to
appropriately embed LibStub and AceGUI-3.0 into the packaged version, so
that I can use them in building this interface.  (Because there is no
way on earth that I am going to reimplement everything that they do
by hand.)
r373 | slippycheeze | 2015-02-25 02:07:43 +0000 (Wed, 25 Feb 2015) | 1 line
Changed paths:
   M /trunk/BittensSpellFlashLibrary.toc

Bump TOC for patch 6.1
r371 | slippycheeze | 2015-02-15 22:13:57 +0000 (Sun, 15 Feb 2015) | 9 lines
Changed paths:
   M /trunk/src/BittensSpellFlashLibrary.lua

Add Resolve, Versatility, and Crit query functions

These wrap up the logic of fetching and transforming the relevant values
into a percentage multiplier, so that we don't have to repeat the same
code everywhere.

In an ideal world the Blizzard functions would do this, but with random
stuff like needing to fetch and add two numbers for versatility, or
transform a percentage into a float, this makes life easier.
r370 | slippycheeze | 2015-02-15 22:13:52 +0000 (Sun, 15 Feb 2015) | 1 line
Changed paths:
   M /trunk/src/BittensSpellFlashLibrary.lua

Add c.GetResolve() to return resolve bonus to healing effects.
r368 | slippycheeze | 2015-02-15 09:05:26 +0000 (Sun, 15 Feb 2015) | 5 lines
Changed paths:
   M /trunk/src/BittensSpellFlashLibrary.lua
   M /trunk/src/Events.lua
   M /trunk/src/Flashing.lua

Improve integration of spell GetDelay into the delay flashing

Previously a spell-supplied GetDelay would override many of the core
features, including charges and power regen delay calculations; this
updates the code to integrate it cleanly into the core calculation.


First Previous Page 10 of 15 Next Last
  • #109

    I think and hope I have come up with a solution to make everyone happy regarding proc highlighting.  It will change the border around spells that would have proc highlighting to be red.  Note that they will only appear if "Default Proc Highlighting" is selected in the main SpellFlash options.

    Please try the beta and let me know how it works for you.  I tested it with the stock Blizzard action bars, and with Bartender.  If you use something else and try the beta, please leave a note to let me know whether it worked for you.

    <Edit:> This change is now released (no longer in beta - simply update like normal).

    Last edited by Xemnosyst on 11/15/2012 10:55:48 PM

    Author of Bitten's SpellFlash.

  • #107
    Inline Aura
    Quote from Xemnosyst »

    Inline Aura by itself, or only in combination with this library?

      Inline Aura in combination with this library... but only verseions 3.15.3 and 3.15.4. All earlier version (3.15.2 and before) work great with Inline Aura.

  • #111

    I just reactivated Inline Arua (I disabled it for a while) and played around on my druid shapeshifting & such in combat without any issues yet.  I will keep it on and hopefully experience a problem myself, but so far I have no idea what would be causing it.

    Last edited by Xemnosyst on 11/14/2012 12:04:11 AM

    Author of Bitten's SpellFlash.

  • #100
    Found a bug in Bitten's SpellFlash Library

    Appears to be a bug introduced in version 3.15.3 and it's still present in 3.15.4.

    The druid shapeshifting ability is affecting what spells/abilities are shown on the main cast bar.

    In my humanoid form I have 5 spells on my main spell bar. Spots one through five. In my cat form I have 11 spots filled on my main spell bar. Spots 1-7 and 9-12.

    Sometimes, while fighting, when I pop out of cat for a rejuve, moonfire or faerie fire and return back to cat form, I only see the first 5 of my cat abilities. I can still access abilites 6-12 via the keyboard shortcut, but I can no longer see them or click on them. At this point, even if I shapeshift in and out of cat form, I can't recover the buttons.

    It's not until the fight is over, and I shapeshift in and out of cat form, that I can finally recover my lost buttons. This problem does not seem to appear outside of a fight.

    Tried to do a bit of troubleshooting too, so I placed another ability in slot 9 in my humanoid form. When I shifted out to cast, and returned to cat form, button 9 remained, and all the others dissappeared. It appears that the only buttons that are "remembered" to be restored are the ones that have a spell in them. Anything blank is not updated/refreshed or whatever it is doing.

    As a temporary solution, I have resorted to using version 3.14.2 as that version does not have this bug.

  • #101

    I just tried it on my druid and did not experience the same issue.  I tried with both the default action bars, and with Bartender.  Are you using some other action bar addon, perhaps?

    Last edited by Xemnosyst on 11/8/2012 11:36:42 PM

    Author of Bitten's SpellFlash.

  • #106

    My setup, and what I have to do to recreate it pretty consistantly:

    Humanoid form:
    1. Moonfire
    2. Wrath
    3. Entangling Roots
    4. Faerie Fire
    5. Hurricane

    Cat form:
    1. Rake
    2. Mangle
    3. Swipe
    4. Rip
    5. Ferocious Bite
    6. Tiger's Fury
    7. Berserk
    8. null
    9. Thrash
    0. Ravage
    -. Pounce
    =. Shred

    Kill something putting 5 combo points on with Mangle; spend combo points with Ferocious Bite. Shift into humanoid form, and pull using Faerie Fire; before the GCD (global cool down) is up, start spamming cat form.

    This almost always causes the buttons to disappear.

  • #105

    I've tested Inline Aura with everything but SpellFlash turned on, and it worked just fine.

    This doesn't mean that SpellFlash is the one at fault... it very well could be Inline Aura has a bug, and that the 3.15.3 release of Bitten's SpellFlash Library has brought forth the bug.

    (Remember, everyone was playing nicely in releases 3.15.2 and before)

    Last edited by QuinicAcid on 11/9/2012 7:11:43 PM
  • #104
    Quote from QuinicAcid »

    After testing with all my addons, it's Inline Aura that's causing the problems.

    Inline Aura by itself, or only in combination with this library?

    Author of Bitten's SpellFlash.

  • #103

    After testing with all my addons, it's Inline Aura that's causing the problems.

  • #102

    I will try turning off my other addons one by one to see if they may be conflicting... but here is the list:

    Ackis Recipe List
    Inline Aura
    Minimap Button Frame
    Successful Interrupt Announcer

    Also, the only SpellFlash items that I have enabled are:

    The only addons that affect buttons or bars are ButtonForge (just adds extra bars, which Spellflash can't reach anyways) and InlineAura (used for inbutton timers and counters). I suspect it may be InlineAura, though. I'll start by turning everything off, and turning them on one by one and see what I find.

    Last edited by QuinicAcid on 11/9/2012 5:07:14 PM
  • #99

    We want a choice to keep Blizzard's proc highlighting alongside Spell Flash. Why force the change on us instead of giving us a choice? I'm very much used to the blizzard proc highlighting and I find it unnerving to play without it. Good luck with your addon, I find it impossible to use now that it dominates my bars.

  • #108

    I agree.  I rely heavily on the default blizz ui proc flashing.  I find it very handy in conjunction with spellflash, as I don't rely solely on spellflash for my next cast, I use it more as a guide.  I've read the last section of the FAQ.  Tried other options, but when it comes to proc notification, nothing comes close to being as good as the default blizz flashing (for me). 

    It's a shame it isn't a toggle'able option, as I previously really enjoyed spellflash.  Was very useful, particularly for interrupts.

    Last edited by skaali23 on 11/12/2012 8:16:16 PM
  • #110

    Please try the beta and let me know how it works for you.

    Author of Bitten's SpellFlash.

  • #97

    Is there anyway to change the spellslash animation? it hurts my eyes

  • #98

    Have you checked out the options for the size & default color of the flashing?  If those options aren't enough, it is really a question for the main SpellFlash addon.  I make modules that tell it which buttons to flash; BigRedBrent writes the main addon that actually does the flashing.

    Last edited by Xemnosyst on 11/7/2012 4:17:03 PM

    Author of Bitten's SpellFlash.

  • To post a comment, please login or register a new account.
Login to Curse

Don't have an account? Create One.

Get an epic experience with Curse Premium
  • Faster addon downloads
  • Premium-Only Beta Giveaways
  • Ad-Free Curse experience
  • Premium Curse Client
  • and many More Features
  • Learn More »

Darkest Dungeon Wiki Editing Contest