WoW:API GameTooltip SetPlayerBuff: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated to match the current API boilerplate.)
mNo edit summary
Line 1: Line 1:
{{widgetmethod}} __NOTOC__
{{widgetmethod}} __NOTOC__
 
{{removedapi|3.0.2|It was replaced with [[API GameTooltip SetUnitBuff|GameTooltip:SetUnitBuff]].}}


Sets a GameTooltip to a player buff of the type last used in [[API GetPlayerBuff|GetPlayerBuff]].
Sets a GameTooltip to a player buff of the type last used in [[API GetPlayerBuff|GetPlayerBuff]].

Revision as of 06:13, 29 July 2010

Widget API ← GameTooltip < SetPlayerBuff

Sets a GameTooltip to a player buff of the type last used in GetPlayerBuff.

GameTooltip:SetPlayerBuff(buffIndex)


Arguments

buffIndex
Number - The index of the buff to set in the game tooltip (affected by the filter used in GetPlayerBuff)


Returns

nil


Example

local buffIndex, untilCancelled = GetPlayerBuff(1, "HARMFUL");
GameTooltip:SetPlayerBuff(buffIndex);

Result

The GameTooltip is set to the first harmful buff.


Details

It will use whatever the last type of buff you specified in GetPlayerBuff was, hence the reason you should specify GetPlayerBuff right before you call SetPlayerBuff.
Options for the GetPlayerBuff filter are : HELPFUL|HARMFUL|PASSIVE