WoW:API GetShapeshiftFormCooldown: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(upgraded deprecated template)
m (Move page script moved page API GetShapeshiftFormCooldown to API GetShapeshiftFormCooldown without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{wowapi}}
{{wowapi}} __NOTOC__
GetShapeshiftFormCooldown(index);
Returns the number of possible macro item icons.  These icons differ from the normal macro icons in that they are icons for various items in the game -- potions, armor, etc., whereas normal macro icons are icons from actions and abilities such as spells or attacks.


Parameters (index)
startTime, duration, isActive = GetShapeshiftFormCooldown(index)


Index = integer number, each class has its own index.
==Parameters==
:;index : Number - Index of the desired form
==Returns==
:;startTime : Number - The time in seconds (as returned by GetTime()) that the cooldown started
:;duration : Number - The duration in seconds of the cooldown
:;isActive : Number - Returns 1 if the cooldown is running, nil if it isn't


Returns (StartTime, Duration, isActive)
==Example==
 
local index = 1
StartTime = the server time of when the cooldown starts.
local startTime, duration, isActive = GetShapeshiftFormCooldown(index)
 
if isActive then
Duration = how long cooldown takes (in seconds)
    DEFAULT_CHAT_FRAME:AddMessage(string.format("Shapeshift %d not active", index))
 
else
isActive = if Cooldown is active - this will be = 1 (not positive on this defintion tho).
    DEFAULT_CHAT_FRAME:AddMessage(string.format("Shapeshift %d has %f seconds remaining", index, duration - (GetTime() - startTime)))
 
end
----
===Result===
Example:
Displays the seconds remaining on the shapeshift form at index 1 or "Not Active" if there's no cooldown on that form
 
Sends the time remaining for the indexed cooldown
 
/script A,B,C = GetShapeshiftFormCooldown(1); DEFAULT_CHAT_CHANNEL("Time Remaining: "..B-(GetTime()-A),1,1,1);

Latest revision as of 04:46, 15 August 2023

← WoW API < GetShapeshiftFormCooldown

Returns the number of possible macro item icons. These icons differ from the normal macro icons in that they are icons for various items in the game -- potions, armor, etc., whereas normal macro icons are icons from actions and abilities such as spells or attacks. 

startTime, duration, isActive = GetShapeshiftFormCooldown(index)

Parameters[edit]

index
Number - Index of the desired form

Returns[edit]

startTime
Number - The time in seconds (as returned by GetTime()) that the cooldown started
duration
Number - The duration in seconds of the cooldown
isActive
Number - Returns 1 if the cooldown is running, nil if it isn't

Example[edit]

local index = 1
local startTime, duration, isActive = GetShapeshiftFormCooldown(index)
if isActive then
    DEFAULT_CHAT_FRAME:AddMessage(string.format("Shapeshift %d not active", index))
else
    DEFAULT_CHAT_FRAME:AddMessage(string.format("Shapeshift %d has %f seconds remaining", index, duration - (GetTime() - startTime)))
end

Result[edit]

Displays the seconds remaining on the shapeshift form at index 1 or "Not Active" if there's no cooldown on that form

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetShapeshiftFormCooldown&oldid=19296"