Quantcast

Fix the documentation for SpellUsable() condition.

Johnny C. Lam [03-20-13 - 19:30]
Fix the documentation for SpellUsable() condition.

git-svn-id: svn://svn.curseforge.net/wow/ovale/mainline/trunk@807 d5049fe3-3747-40f7-a4b5-f36d6801af5f
Filename
OvaleCondition.lua
diff --git a/OvaleCondition.lua b/OvaleCondition.lua
index aefbb41..a408476 100644
--- a/OvaleCondition.lua
+++ b/OvaleCondition.lua
@@ -2342,12 +2342,14 @@ end
 -- @name SpellUsable
 -- @paramsig boolean
 -- @param id The spell ID.
--- @param yesno Optional. If yes, then return true if the target is aggroed. If no, then return true if it isn't aggroed.
+-- @param yesno Optional. If yes, then return true if the spell has been learned and the player has enough resources to cast it.
+--     If no, then return true if the player can't cast the spell for one of the above reasons.
 --     Default is yes.
 --     Valid values: yes, no.
 -- @return A boolean value.
 -- @usage
--- if SpellUsable(tigers_fury) Spell(berserk_cat)
+-- if SpellUsable(avenging_wrath) and SpellCooldown(avenging_wrath) <10
+--     Spell(guardian_of_ancient_kings_retribution)

 OvaleCondition.conditions.spellusable = function(condition)
 	return testbool(API_IsUsableSpell(condition[1]), condition[2])