WoW:API GameTooltip SetPlayerBuff: Difference between revisions

← Older edit

WoW:API GameTooltip SetPlayerBuff (source)

Revision as of 04:45, 15 August 2023

134 bytes added , 15 August 2023

m

Move page script moved page API GameTooltip SetPlayerBuff to WoW:API GameTooltip SetPlayerBuff without leaving a redirect

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
-{{widgetmethod}}
+{{widgetmethod}} __NOTOC__
-{{stub/api}}
+{{removedapi|3.0.2|It was replaced with [[API GameTooltip SetUnitBuff|GameTooltip:SetUnitBuff]].}}
-MUST access it in this fasion, if you want to specify what TYPE of buff you want to set the tooltip to.
+Sets a GameTooltip to a player buff of the type last used in [[API GetPlayerBuff|GetPlayerBuff]].
+ GameTooltip:SetPlayerBuff(buffIndex)
-local buffIndex, untilCancelled = [[API GetPlayerBuff|GetPlayerBuff]](blah.index, "HARMFUL");
+== Arguments ==
+:; buffIndex : Number - The index of the buff to set in the game tooltip (affected by the filter used in [[API GetPlayerBuff|GetPlayerBuff]])
-GameTooltip:SetPlayerBuff(buffIndex);
+== Returns ==
+:nil
-From what I can understand, GetPlayerBuff sets what type of buff-type that SetPlayerBuff will use.
-It will use whatever last type of buff you specified in GetPlayerBuff, hence the reason you should specify GetPlayerBuff right before you call SetPlayerBuff.
+== Example ==
+ local buffIndex, untilCancelled = GetPlayerBuff(1, "HARMFUL");
+ GameTooltip:SetPlayerBuff(buffIndex);
-I also tried to have GameTooltip:SetPlayerBuff(blah.index), seeing as how blah.index and buffIndex are the same number, but it wouldn't work. You MUST have it as above.
+<big>'''Result'''</big>
+The GameTooltip is set to the first harmful buff.
-Options for GetPlayerBuff are : HELPFUL|HARMFUL|PASSIVE
+== 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