FANDOM


m
m (Categorization and formatting)
Line 3: Line 3:
 
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.
   
local start, duration, enable = GetPetActionCooldown(petActionButtonId);
+
startTime, duration, enable = GetPetActionCooldown(index);
   
 
----
 
----
 
;''Arguments''
 
;''Arguments''
   
: petActionButtonId - the Id for the pet action button you want to query for cooldown info.
+
: (index)
  +
:; index : Number - The index of the pet action button you want to query for cooldown info.
   
 
----
 
----
 
;''Returns''
 
;''Returns''
   
:(Number startTime, Number duration, Number enable)
+
:(startTime, duration, enable)
   
:;startTime : 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 : 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 : 0 if no cooldown, 1 if cooldown is in effect (probably)
+
:;enable : Boolean - 0 if no cooldown, 1 if cooldown is in effect (probably)
   
 
----
 
----
Line 34: Line 34:
 
----
 
----
 
{{Template:WoW API}}
 
{{Template:WoW API}}
  +
[[Category:API Pet Functions|GetPetActionCooldown]]

Revision as of 20:06, December 28, 2004

GetPetActionCooldown

Returns cooldown information for the pet action in the specified pet action bar slot.

  startTime, duration, enable = GetPetActionCooldown(index);

Arguments
(index)
index 
Number - The index of the pet action button you want to query for cooldown info.

Returns
(startTime, duration, enable)
startTime 
Number - The time when the cooldown started (as returned by GetTime()) 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)

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.

Template:WoW API

Community content is available under CC-BY-SA unless otherwise noted.