WoW:API GetPlayerBuffTimeLeft: Difference between revisions

WoW:API GetPlayerBuffTimeLeft (source)

150 bytes removed , 28 May 2009

removedapi, format

Anonymous user

@@ Line 1: / Line 1: @@
- <center>'''GetPlayerBuffTimeLeft''' ''-Documentation by Sarf-''</center>
+{{removedapi|3.0|Use {{api|UnitAura}} (or derived functions) to retrieve information about buffs.}}
+{{wowapi}}
 Retrieve info about a certain player buff of a certain type.
+ buffTimeLeft = GetPlayerBuffTimeLeft(buffIndex);
-	buffTimeLeft = GetPlayerBuffTimeLeft(buffIndex)
+==Arguments==
+;buffIndex : The index of the buff to retrieve. Can be obtained with [[API GetPlayerBuff|GetPlayerBuff]]
-----
-;''Arguments''
-:(Number buffIndex)
-:;buffIndex : The index of the buff to retrieve. Can be obtained with [[API GetPlayerBuff|GetPlayerBuff]]
+==Returns==
+;buffTimeLeft : The time (in seconds) left until the buff expires.
-----
+==Example==
-;''Returns''
-:(Number buffTimeLeft)
-:;buffTimeLeft : The time (in seconds) left until the buff expires.
-----
-;''Example''
   local timeLeft = GetPlayerBuffTimeLeft(buffIndex)
-;''Result''
+;Result : Retrieves amount of time left of the first buff you have.
-Retrieves amount of time left of the first buff you have.
-or
-;''Example''
    for i=0,31 do
@@ Line 39: / Line 23: @@
   end
-;''Result''
+;Result : Will display your buff/debuff durations.
-Will display your buff/debuff durations.
-----
-;''Description''
-: Retrieves time left until a certain buff expires.
-;''See Also''
+==See Also==
 :* [[API GetPlayerBuff|GetPlayerBuff]]
 :* [[API GetPlayerBuffTexture|GetPlayerBuffTexture]]
-----
-{{WoW API}}