Combat Alert Readme
===================

About
-----

	Combat Alert lets you manipulate filters that enables the addon to notify you when a event occurs.

Example
-------

	If you would like to see and hear when you enter and combat you could create these alert pattern;

		warn state combat
		
	and

		show state nocombat

	You could make the alerts more prominent by changing the alert patterns to;

		alert state combat

	and

		warn state nocombat

Patterns
--------

	The patterns follow a specific space-seperated order to allow global matching;

		<type> <type-specific arguments>

	where type is the type of combat event that is fired by the client, skill is the name of the skill
	associated with the fired event and type-specific arguments are defined by Combat Alert.

Pattern commands
----------------

	The slash commands that allow you to manipulate patterns are;

		/combatalert list <table> <filter>	- list patterns

		/combatalert delete <table> <filter>	- delete a pattern

		/combatalert insert <table> <pattern>	- insert a pattern

	where filter is text contained within the event pattern (ie "cooldown" or "debuff player")

	a wildcard (*) can be used within the filter (ie "debuff * Unstable" or "* player")

	NB. filter is implemented with a string:find command so you can use a regular expression also

	(ie "/combatalert list known %a%splayer" to list all collected self-events).

Pattern tables
--------------

	collected	stores collected event patterns

	collect		stores patterns that, when matched, will collect the event

	ignore		stores patterns that, when matched, will ignore the event

	show		stores patterns that, when matched, will display a message

	warn		stores patterns that, when matched, will display a message and play a noise

	alert		stores patterns that, when matched, will display a message and play a loud noise

Pattern arguments
-----------------

	TYPE	ARGS	VALUE			DESCRIPTION
	----	----	-----			-----------

	state					fired when you enter or exit combat

		skill

			combat			you have entered combat

			nocombat		you have exited combat

	cast					fired when someone casts a spell or uses an item

		sourcetype

			player			you begin to cast a spell

			party			a party member begins to cast a spell

			raid			a raid member begins to cast a spell

			pet			your pet begins to cast a spell

			focus			your focus begins to cast a spell

			target			your target begins to cast a spell

		victimtype

			player			you are the target of a spell cast

			party			a party member is the target of a spell cast

			raid			a raid member is the target of a spell cast

			pet			your pets is the target of a spell cast

			focus			your focus is the target of a spell cast

			target			your target is the target of a spell cast

		skill

			...			item/spell name

	gain/fade/buff/debuff/dispel		fired when someones aura/ability changes

		unittype

			player			your aura/ability changes

			party			a party members aura/ability changes

			raid			a raid members aura/ability changes

			pet			your pets aura/ability changes

			focus			your focus' aura/ability changes

			target			your targets aura/ability changes

		skill

			...			aura/ability name

	cooldown				fired when an item or spell is ready to use

		skill

			...			item/spell name

Other valid unittypes are; unknown, npc, tank, assist, star, circle, diamond, triangle, moon, square, cross and skull

... the damage/heal notices will be filterable with similar syntax and the their frame will be configurable soon!

Example commands to try
-----------------------

	/cal insert show cooldown Super Mana Potion

		shows you when your mana potion cooldown has finished

	/cal insert show debuff target Mortal Strike

		shows you when your target is debuffed with MS

	/cal insert warn debuff player Unstable Affliction

		warns you when you are afflicted with UA

	/cal insert warn cast * target Greater Heal

		shows you when your target is about to be healed

	/cal insert warn cast * player Mana Burn

		shows you when anyone is casting Mana Burn on you

	/cal insert alert fade focus Shackle Undead

		or

	/cal insert alert fade focus Polymorph

		warns you when your focussed target breaks CC

... its not overly complicated to configure patterns! :)~

This addon isnt designed to handle a lot of patterns - it will slow your client down if you add too many. LibFeedback is

being created for use in my addons and it will help to make Combat Alert more self-sufficient and sexy (triggers to show

BigWigs-style alerts is one thing LibFeedback will allow when its finished).

Have Fun! :)