Quantcast

Document return values for state:RuneCount().

Johnny C. Lam [05-08-14 - 17:26]
Document return values for state:RuneCount().

git-svn-id: svn://svn.curseforge.net/wow/ovale/mainline/trunk@1399 d5049fe3-3747-40f7-a4b5-f36d6801af5f
Filename
OvaleRunes.lua
diff --git a/OvaleRunes.lua b/OvaleRunes.lua
index bba6657..3a8fa83 100644
--- a/OvaleRunes.lua
+++ b/OvaleRunes.lua
@@ -328,6 +328,10 @@ statePrototype.ConsumeRune = function(state, atTime, name, snapshot)
 	end
 end

+-- Returns a triplet of count, startCooldown, endCooldown:
+--     count			The number of currently active runes of the given type.
+--     startCooldown	The time at which the next rune of the given type went on cooldown.
+--     endCooldown		The time at which the next rune of the given type will be active.
 statePrototype.RuneCount = function(state, name, death)
 	local count = 0
 	local startCooldown, endCooldown = math.huge, math.huge