WoW:API GetPlayerBuffTimeLeft: Difference between revisions

m
Move page script moved page API GetPlayerBuffTimeLeft to WoW:API GetPlayerBuffTimeLeft without leaving a redirect
No edit summary
m (Move page script moved page API GetPlayerBuffTimeLeft to WoW:API GetPlayerBuffTimeLeft without leaving a redirect)
 
(2 intermediate revisions by 2 users not shown)
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|toc=0}}
Retrieve info about a certain player buff of a certain type.
Retrieve info about a certain player buff of a certain type.
buffTimeLeft = GetPlayerBuffTimeLeft(buffIndex);


buffTimeLeft = GetPlayerBuffTimeLeft(buffIndex)
== Parameters ==
 
=== Arguments ===
----
* buffIndex (number) - 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''
 
:(Number buffTimeLeft)


:;buffTimeLeft : The time (in seconds) left until the buff expires.
=== Returns ===
* buffTimeLeft (number) - The time, in seconds, left until the buff expires.


----
== Examples ==
;''Example''
  local timeLeft = GetPlayerBuffTimeLeft(buffIndex)
  local timeLeft = GetPlayerBuffTimeLeft(buffIndex)
 
Result - Retrieves amount of time left of the first buff you have.
;''Result''
 
Retrieves amount of time left of the first buff you have.
 
or
 
;''Example''


   for i=0,31 do
   for i=0,31 do
Line 38: Line 22:
   end
   end
  end
  end
Result - Will display your buff/debuff durations.


;''Result''
==See Also==
 
Will display your buff/debuff durations.
----
;''Description''
 
: Retrieves time left until a certain buff expires.
 
;''See Also''
 
:* [[API GetPlayerBuff|GetPlayerBuff]]
:* [[API GetPlayerBuff|GetPlayerBuff]]
:* [[API GetPlayerBuffTexture|GetPlayerBuffTexture]]
:* [[API GetPlayerBuffTexture|GetPlayerBuffTexture]]
----
{{WoW API}}
Anonymous user