WoW:API GetActionCooldown: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Updated formatting)
Line 14: Line 14:
:;start : Number - The time at which the current cooldown period began (Relative to the result of [[API GetTime|GetTime]]), or 0 if the cooldown is not active or not applicable.
:;start : Number - The time at which the current cooldown period began (Relative to the result of [[API GetTime|GetTime]]), or 0 if the cooldown is not active or not applicable.
:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
:;duration : Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. (Exactly what this is for is slightly unclear).
:;enable : Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. (Lets you know when a shapeshifting form has ended and the actual countdown has started).
 
== Example ==
== Example ==
<!-- begin code -->
<!-- begin code -->

Revision as of 19:18, 17 October 2005

GetActionCooldown - Documentation by Sarf

Retrieves the cooldown data of the action specified.

start, duration, enable = GetActionCooldown(slot)

Parameters

Arguments

(slot)
slot
Integer - The action slot to retrieve data from.

Returns

start, duration, enable
start
Number - The time at which the current cooldown period began (Relative to the result of GetTime), or 0 if the cooldown is not active or not applicable.
duration
Number - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable.
enable
Number - Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. (Lets you know when a shapeshifting form has ended and the actual countdown has started).

Example

local start, duration, enable = GetActionCooldown(slot);
if ( start > 0 and duration > 0 and enable > 0) then
	-- do stuff when cooldown is under effect
else
	-- do stuff when cooldown is not active
end

Template:WoW API