WoW:API GetPlayerBuffTexture: Difference between revisions

Revision as of 12:51, 28 May 2009

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

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

buffTexture = GetPlayerBuffTexture(buffIndex)

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

buffTexture: The identifier of (path and filename of) the texture of the buff, or nil if no such buff exist.

icon:SetTexture(GetPlayerBuffTexture(buffIndex))

@@ Line 1: / Line 1: @@
+{{removedapi|3.0|Use {{api|UnitAura}} (or derived functions) to retrieve information about buffs.}}
 {{wowapi}}
@@ Line 5: / Line 6: @@
   buffTexture = GetPlayerBuffTexture(buffIndex)
-----
+==Arguments==
-;''Arguments''
+;buffIndex : The index of the buff to retrieve. Can be obtained with [[API GetPlayerBuff|GetPlayerBuff]].
-:(Number buffIndex)
+==Returns==
+;buffTexture : The identifier of (path and filename of) the texture of the buff, or nil if no such buff exist.
-:;buffIndex : The index of the buff to retrieve. Can be obtained with [[API GetPlayerBuff|GetPlayerBuff]]
+==Example==
-----
-;''Returns''
-:(String buffTexture)
-:;buffTexture : The identifier of (path and filename of) the texture of the buff, or nil if no such buff exist.
-----
-;''Example''
   icon:SetTexture(GetPlayerBuffTexture(buffIndex))
-;''Result''
+;Result : Retrieves buff texture and sets the icons texture to that.
-Retrieves buff texture and sets the icons texture to that.
-----
-;''Description''
-: Retrieves the texture name of a certain buff.
-;''See Also''
-:* [[API GetPlayerBuff|GetPlayerBuff]]
-:* [[API GetPlayerBuffTimeLeft|GetPlayerBuffTimeLeft]]
-----
+==See Also==
+* [[API GetPlayerBuff|GetPlayerBuff]]
+* [[API GetPlayerBuffTimeLeft|GetPlayerBuffTimeLeft]]