WoW:API GetSummonFriendCooldown: Difference between revisions

Revision as of 14:24, 20 June 2010

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Returns information about the cooldown time of the RaF Summon Friend ability.

start, duration = GetSummonFriendCooldown()

start: Number - The value of GetTime() at the moment the cooldown began, 0 if the ability is ready
duration: Number - The length of the cooldown in seconds, 0 if the ability is ready

The snippet below prints the remaining time of the cooldown in seconds.

local start, duration = GetSummonFriendCooldown()
local timeleft = start + duration - GetTime()
print(timeleft)

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
-Returns information about the cooldown time of the players summon friend ability.
+Returns information about the cooldown time of the RaF Summon Friend ability.
-<pre>start, duration = GetSummonFriendCooldown()</pre>
+ start, duration = GetSummonFriendCooldown()
-== Arguments ==
-None.
 == Returns ==
-:start, duration
+;start : Number - The value of {{api|GetTime}}() at the moment the cooldown began, 0 if the ability is ready
-;start : Number - The value of [[API_GetTime | GetTime]]() at the moment the cooldown began, 0 if the ability is ready
 ;duration : Number - The length of the cooldown in seconds, 0 if the ability is ready
 == Example ==
-<pre>local start, duration = GetSummonFriendCooldown()
+The snippet below prints the remaining time of the cooldown in seconds.
-local timeleft = start + duration - GetTime()
+ local start, duration = GetSummonFriendCooldown()
-print(timeleft)</pre>
+ local timeleft = start + duration - GetTime()
+ print(timeleft)
-<big>'''Result'''</big>
-<!-- If it helps, include example results here, though they are not required. You're allowed to cheat liberally since WoW isn't a command line language. -->
-Remaining time of the cooldown in seconds.