WoW:API GetActionCooldown: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Added {{clr}})
Line 1: Line 1:
<center>'''GetActionCooldown''' - ''Documentation by Sarf''</center>
{{wowapi}} __NOTOC__


Retrieves the cooldown data of the action specified.
Retrieves the [[cooldown]] data of the action specified.


  start, duration, enable = GetActionCooldown(slot)
  start, duration, enable = GetActionCooldown(slot)
{{clr}}
== Parameters ==
== Parameters ==
=== Arguments ===
''Arguments''
:(slot)


:;slot : Integer - The action slot to retrieve data from.
:;slot : Integer - The [[ActionSlot|action slot]] to retrieve data from.
=== Returns ===
''Returns''
:start, duration, enable


:;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. (Lets you know when a shapeshifting form has ended and the actual countdown has started).
:;enable : Number: Indicate if cooldown is enabled, is greater than 0 if a cooldown is active, and 0 if a cooldown cannot be active. This lets you know when a shapeshifting form has ended and the actual countdown has started.


== Example ==
== Example ==
<!-- begin code -->
local start, duration, enable = GetActionCooldown(slot);
if ( start &gt; 0 and duration &gt; 0 and enable &gt; 0) then
-- do stuff when cooldown is under effect
else
-- do stuff when cooldown is not active
end
<!-- end code -->
or
<!-- begin code -->
<!-- begin code -->
  local start, duration, enable = GetActionCooldown(slot);
  local start, duration, enable = GetActionCooldown(slot);
Line 34: Line 24:
  end
  end
<!-- end code -->
<!-- end code -->
----
__NOTOC__
{{Template:WoW API}}

Revision as of 19:01, 16 October 2006

← WoW API < GetActionCooldown

Retrieves the cooldown data of the action specified. 

start, duration, enable = GetActionCooldown(slot)

Parameters

Arguments

slot
Integer - The action slot to retrieve data from.

Returns

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. This 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 ) then
	-- do stuff when cooldown is not active
else
	-- do stuff when cooldown is under effect
end
Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_GetActionCooldown&oldid=9316"