WoW:API GetPetActionCooldown: Difference between revisions

{{wowapi}}, format, -example
No edit summary
({{wowapi}}, format, -example)
Line 1: Line 1:
<center>'''GetPetActionCooldown''' </center>
{{wowapi}} __NOTOC__
 
Returns cooldown information for the pet action in the specified pet action bar slot.
Returns cooldown information for the pet action in the specified pet action bar slot.
 
startTime, duration, enable = GetPetActionCooldown(index);
  startTime, duration, enable = GetPetActionCooldown(index);
==Parameters==
 
===Arguments===
----
;''Arguments''
 
: (index)
:; index : Number - The index of the pet action button you want to query for cooldown info.
:; index : Number - The index of the pet action button you want to query for cooldown info.
 
===Returns===
----
;''Returns''
 
:(startTime, duration, enable)
 
:;startTime : Number - The time when the cooldown started (as returned by [[API GetTime|GetTime()]]) or zero if no cooldown
:;startTime : Number - The time when the cooldown started (as returned by [[API GetTime|GetTime()]]) or zero if no cooldown
:;duration : Number - The number of seconds the cooldown will last, or zero if no cooldown
:;duration : Number - The number of seconds the cooldown will last, or zero if no cooldown
:;enable : Boolean - 0 if no cooldown, 1 if cooldown is in effect (probably)
:;enable : Boolean - 0 if no cooldown, 1 if cooldown is in effect (probably)
----
;''Example''
for i=1, NUM_PET_ACTION_SLOTS, 1 do
  cooldown = getglobal("PetActionButton"..i.."Cooldown");
  local start, duration, enable = GetPetActionCooldown(i);
  CooldownFrame_SetTimer(cooldown, start, duration, enable);
end
 
----
;''Description''
: Returns information on the specified pet action's cooldown timer. Note that this depends on having the action in a specific action bar slot.
----
{{WoW API}}