Widget API: GameTooltip:SetPlayerBuff

Revision as of 15:24, 27 June 2007 by WoWWiki>Ravas (Updated to match the current API boilerplate.)

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