SpellFlashCore

SpellFlashCore.FlashAction

This is used to flash an action bar spell.

SpellFlashCore.FlashAction(SpellName, color, size, brightness, blink, NoMacros)
Arguments:
SpellName
(string or number or table) Spell name or global spell id number or table of global spell id numbers.
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.
NoMacros
(boolean) If true will skip checking for macros.




SpellFlashCore.FlashItem

This is used to flash an action bar item.

SpellFlashCore.FlashItem(ItemName, color, size, brightness, blink, NoMacros)
Arguments:
ItemName
(string or number or table) Item name or item id number or table of item id numbers.
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.
NoMacros
(boolean) If true will skip checking for macros.




SpellFlashCore.FlashForm

This is used to flash a stance, form, presence, aura or aspect bar spell.

SpellFlashCore.FlashForm(SpellName, color, size, brightness, blink)
Arguments:
SpellName
(string or number or table) Localized name or global id number of the spell or table of global id numbers.
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.




SpellFlashCore.FlashPet

This is used to flash a pet bar spell.

SpellFlashCore.FlashPet(SpellName, color, size, brightness, blink)
Arguments:
SpellName
(string or number or table) Localized name or global id number of the spell or table of global id numbers.
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.




SpellFlashCore.FlashVehicle

This is used to flash a vehicle bar spell.

SpellFlashCore.FlashVehicle(SpellName, color, size, brightness, blink)
Arguments:
SpellName
(string or number or table) Localized name or global id number of the spell or table of global id numbers.
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.




SpellFlashCore.FlashTotemCall

This is used to flash the multiple totem call button.

SpellFlashCore.FlashTotemCall(color, size, brightness, blink)
Arguments:
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.




SpellFlashCore.FlashTotemRecall

This is used to flash the multiple totem recall button.

SpellFlashCore.FlashTotemRecall(color, size, brightness, blink)
Arguments:
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.




SpellFlashCore.FlashFrame

This is used to flash a frame.

SpellFlashCore.FlashFrame(frame, color, size, brightness, blink)
Arguments:
frame
(variable) The variable assigned to a frame that you want to be flashed.
color
(string or table or nil) Will accept color tables {r=1.0, g=1.0, b=1.0} or a string with the name of a color that has already been defined. May be nil for "White".
size
(number or nil) Percent for the flash size or nil for default.
brightness
(number or nil) Percent for the flash brightness or nil for default.
blink
(boolean) If true will make the action button fade in and out.




SpellFlashCore.Flashable

Determines if a specified spell is able to be found on the action bars to be flashed.

found = SpellFlashCore.Flashable(SpellName, NoMacros)
Arguments:
SpellName
(string or number or table) Spell name or global spell id number or table of global spell id numbers.
NoMacros
(boolean) If true will skip checking for macros.
Returns:
found
(boolean) True if a specified spell is able to be found on the action bars to be flashed.




SpellFlashCore.ItemFlashable

Determines if a specified item is able to be found on the action bars to be flashed.

found = SpellFlashCore.ItemFlashable(ItemName, NoMacros)
Arguments:
ItemName
(string or number or table) Item name or item id number or table of item id numbers.
NoMacros
(boolean) If true will skip checking for macros.
Returns:
found
(boolean) True if a specified item is able to be found on the action bars to be flashed.




SpellFlashCore.SpellName

This returns the localized spell name.

name = SpellFlashCore.SpellName(SpellID, NoSubName)
Arguments:
SpellID
(number) Global spell ID number.
NoSubName
(boolean) If true will not return the spell name with the sub name attached.
Returns:
name
(string) Localized spell name.




SpellFlashCore.ItemName

This returns the localized item name.

name = SpellFlashCore.ItemName(ItemID)
Arguments:
ItemID
(number) Global item ID number.
Returns:
name
(string) Localized item name.




SpellFlashCore.Replace

This replaces text with new text in a string.

REPLACED_STRING = SpellFlashCore.Replace(STRING, FIND, REPLACE, FIND, REPLACE, ...)
Arguments:
STRING
(string) The original string.
FIND
(string or number) The search text.
REPLACE
(string or number or nil) The replacement text.
Returns:
REPLACED_STRING
(string) The replaced string.




SpellFlashCore.CopyTable

A simple function that will copy a table.

CopiedTable = SpellFlashCore.CopyTable(Table)
Arguments:
Table
(table) The original table.
Returns:
CopiedTable
(table) The copied table.




SpellFlashCore.RegisterDebugEvent

This will register an event for debugging purposes.

Debug slash command: /spellflashcore debug

Debug event slash command: /spellflashcore register EVENT_NAME

SpellFlashCore.RegisterDebugEvent(event)
Arguments:
event
(string) Event name to register.




SpellFlashCore.UnregisterDebugEvent

This will unregister an event for debugging purposes.

Debug slash command: /spellflashcore debug

Debug event slash command: /spellflashcore unregister EVENT_NAME

SpellFlashCore.UnregisterDebugEvent(event)
Arguments:
event
(string) Event name to unregister.




SpellFlashCore.RegisterAllDebugEvents

This will register all events for debugging purposes.

Debug slash command: /spellflashcore debug

Debug event slash command: /spellflashcore register all

SpellFlashCore.RegisterAllDebugEvents()




SpellFlashCore.UnregisterAllDebugEvents

This will unregister all events for debugging purposes.

Debug slash command: /spellflashcore debug

Debug event slash command: /spellflashcore unregister all

SpellFlashCore.UnregisterAllDebugEvents()




SpellFlashCore.debug

This will dump the value of msg to the default chat window if debug mode has been enabled.

Debug slash command: /spellflashcore debug

SpellFlashCore.debug(...)
Arguments:
...
(string or number or nil) String, number or array of strings and numbers that will be sent to the default chat window.




SpellFlashCore.RegisterBigLibTimer

Use this to embed BigLibTimer into your addon. Use either the argument or the return value but not both, because that would be the same as just using the argument.
BigLibTimer API: http://wow.curseforge.com/addons/biglibtimer/pages/api/

handler = SpellFlashCore.RegisterBigLibTimer(handler)
Arguments:
handler
(frame or table or nil) Table or frame to have the BigLibTimer functions saved to.
Returns:
handler
(table) Table with the BigLibTimer functions saved to it.