WoW:API GetPlayerBuffTimeLeft: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(removedapi, format)
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.
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)
  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
   for i=0,31 do
Line 39: Line 23:
  end
  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 GetPlayerBuff|GetPlayerBuff]]
:* [[API GetPlayerBuffTexture|GetPlayerBuffTexture]]
:* [[API GetPlayerBuffTexture|GetPlayerBuffTexture]]
----
{{WoW API}}

Revision as of 12:52, 28 May 2009

Icon-remove-48x48.png This is no longer a part of the World of Warcraft API.
  • Use UnitAura (or derived functions) to retrieve information about buffs.
  • It was removed in patch 3.0.

← WoW API < GetPlayerBuffTimeLeft

Retrieve info about a certain player buff of a certain type. 

buffTimeLeft = GetPlayerBuffTimeLeft(buffIndex);

Arguments

buffIndex
The index of the buff to retrieve. Can be obtained with GetPlayerBuff

Returns

buffTimeLeft
The time (in seconds) left until the buff expires.

Example

local timeLeft = GetPlayerBuffTimeLeft(buffIndex)
Result
Retrieves amount of time left of the first buff you have.
 for i=0,31 do
  local id,cancel = GetPlayerBuff(i,"HELPFUL|HARMFUL|PASSIVE");
  if(id > -1) then
    local timeleft = GetPlayerBuffTimeLeft(id);
   DEFAULT_CHAT_FRAME:AddMessage(timeleft);
  end
end
Result
Will display your buff/debuff durations.

See Also

Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_GetPlayerBuffTimeLeft&oldid=5625"