WoW:API GetShapeshiftFormCooldown: Difference between revisions

← Older edit

WoW:API GetShapeshiftFormCooldown (source)

Revision as of 04:46, 15 August 2023

616 bytes added , 15 August 2023

m

Move page script moved page API GetShapeshiftFormCooldown to WoW:API GetShapeshiftFormCooldown without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-GetShapeshiftFormCooldown(index);
+{{wowapi}} __NOTOC__
+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);