WoW:API GetActionCooldown: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Added {{clr}})
m (Move page script moved page API GetActionCooldown to WoW:API GetActionCooldown without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:


  start, duration, enable = GetActionCooldown(slot)
  start, duration, enable = GetActionCooldown(slot)
{{clr}}
 
== Parameters ==
== Parameters ==
''Arguments''
<big>'''Arguments'''</big>


:;slot : Integer - The [[ActionSlot|action slot]] to retrieve data from.
:;slot : Integer - The [[ActionSlot|action slot]] to retrieve data from.
''Returns''


:;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.
<big>'''Returns'''</big>
:;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.
: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.
:;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 ==
== Example ==

Latest revision as of 04:45, 15 August 2023

← 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, 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. 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=9318"