Changes: API GetPetActionCooldown

Latest revision as of 02:39, 22 July 2022

Returns cooldown info for an action on the pet action bar.

startTime, duration, enable = GetPetActionCooldown(index)

Parameters

Arguments

index: number - The index of the pet action button you want to query for cooldown info.

Returns

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)

@@ Line 1: / Line 1: @@
+{{wowapi}} __NOTOC__
- <center>'''GetPetActionCooldown''' </center>
+Returns cooldown info for an action on the pet action bar.
+ startTime, duration, enable = GetPetActionCooldown(index)
-Returns cooldown information for the pet action in the specified pet action bar slot.
+==Parameters==
+===Arguments===
-   startTime, duration, enable = GetPetActionCooldown(index);
+:;index:{{apitype|number}} - The index of the pet action button you want to query for cooldown info.
+===Returns===
-----
+:;startTime:{{apitype|number}} - The time when the cooldown started (as returned by [[API GetTime|GetTime()]]) or zero if no cooldown
-;''Arguments''
+:;duration:{{apitype|number}} - The number of seconds the cooldown will last, or zero if no cooldown
+:;enable:{{apitype|boolean}} - 0 if no cooldown, 1 if cooldown is in effect (probably)
-: (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 [[API GetTime|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}}
-[[Category:API Pet Functions|GetPetActionCooldown]]