WoW:API UnitBuff: Difference between revisions

← Older edit

WoW:API UnitBuff (source)

Revision as of 04:47, 15 August 2023

1,904 bytes added , 15 August 2023

m

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

Anonymous user

Move page script

@@ Line 1: / Line 1: @@
 {{wowapi}} __NOTOC__
+Retrieves info about a certain buff on a certain unit. This is essentially an alias of [[API_UnitAura|UnitAura]] with the "HELPFUL" filter.
+ name, rank, icon, count, debuffType, duration, expirationTime, unitCaster, isStealable,
+ shouldConsolidate, spellId = UnitBuff("unit", [index] or ["name", "rank"][, "filter"])
-Retrieve info about a certain buff on a certain unit.
+== Arguments ==
+;unitId : String - The [[unitId|unit]] to query information for
+;index or name : Number or string - The index or name of the buff to retrieve information for. Indices start at 1 and go up indefinitely until there are no more buffs on target.
+;filter : String - zero or more of "PLAYER", "RAID", "CANCELABLE", "NOT_CANCELABLE", separated by pipe ("|") or space characters.
- buffName, buffRank, buffTexture, buffApplications = UnitBuff(unit, buffIndex[, showCastable]);
+== Returns ==
+;name : String - The name of the spell or effect of the buff, or nil if no buff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon.
-== Parameters ==
+;rank : String - The rank line from the tooltip of the spell or effect that caused the buff, e.g. "Rank 2". Returns "" if there is no rank.
-=== Arguments ===
+;iconTexture : String - The identifier of (path and filename to) the indicated buff.
+;count : Number - The number of times the buff has been applied to the target.
-:(unit, buffIndex, showCastable)
+;debuffType : String - The magic type of the buff
+;duration : Number - The full duration of the buff in seconds
-:;unit : String - The [[unitId]] to query information for
+;expirationTime : Number - Time the buff will expire in seconds
+;source : String - The [[unitId|unit]] that cast the buff
-:;buffIndex : Number - The index of the buff to retrieve information for. Starts at 1 and goes up to a certain number: The maximum numbers used by the Blizzard code are 16 for party/pet and 8(?) for target buffs. ''Is this information up to date? --[[User:Mikk|Mikk]] 07:14, 11 August 2006 (EDT)''
+;isStealable : Boolean - 1 if it is stealable otherwise nil
+;shouldConsolidate : Boolean - 1 if the buff should be placed in a buff consolidation box (usually long-term effects).
-:;showCastable : [[Boolean]] - If present and true (1), then only buffs will be returned which are castable by the player. Index is still starting with 1 and counting up. (Added in 1.9, works in 1.9.3)
+;spellId : Number - spell ID of the aura.
-=== Returns ===
-:;buffName : String - The name of the spell or effect of the buff. This is the name shown in yellow when you mouse over the icon. (Added in 2.0)
-:;buffRank : String - The rank of the spell or effect that caused the buff. Returns "" if there is no rank. (Added in 2.0)
-:;buffTexture : String - The identifier of (path and filename to) the indicated buff, or nil if no buff
-:;buffApplications : String - The number of times the buff has been applied to the target.
 == Example ==
-  buff = UnitBuff("pet", 1);
+  local buffs, i = { }, 1;
+ local buff = UnitBuff("player", i);
-=== Result ===
+ while buff do
+   buffs[#buffs + 1] = buff;
+   i = i + 1;
+   buff = UnitBuff("player", i);
+ end;
+ if #buffs < 1 then
+   buffs = "You have no buffs";
+ else
+   buffs[1] = "You're buffed with: "..buffs[1];
+   buffs = table.concat(buffs, ", ");
+ end;
+ DEFAULT_CHAT_FRAME:AddMessage(buffs);
-: Retrieves the texture name of the first buff that your pet has
+=====Macro Options:=====
+. Prints the names of all buffs on the current target:
+<pre>/run for i=1,40 do local B=UnitBuff("target",i); if B then print(i.."="..B) end end</pre>
+. Prints the name, icon texture, and time left for all buffs on the player.
+<pre>/run for i=1,40 do local n,_,icon,_,_,dur,x,_,_=UnitBuff("player",i);if n then print(i.."="..n..", "..icon..", "..format("%.2f",-1*(GetTime()-x)/60).." minutes left.")end end
+</pre>
+== History ==
+* Patch 1.9 added castable to the list of parameters.
+* Patch 2.0 added name and rank return values.
+* Patch 2.1 added duration and timeLeft return values.
+* Patch 2.3.2 changed behaviour of castable parameter - spells cast by other players are no longer shown at all when castable is used. Bug or intented change?
+* Patch 2.4 (PTR 8089-enGB) changed (again) behaviour of castable parameter - spells cast by other '''classes''' are no longer shown at all when castable is used. Tested with druid and priest spells, MacOSX client. Needs to be confirmed.
+* Patch 2.4 (Live) has corrected the bug introduced in 2.3.2. The castable parameter correctly filters non-castable buffs once again.
+* Patch 3.0 updated the return values.
+* Patch 3.1 changed the boolean return value isMine to the string value source.
 == See also ==
 : [[API UnitDebuff|UnitDebuff]]
-: [[Check Hunter Aspect|Sample Code Check Hunter Aspect]]
+: [[HOWTO: Identify Buffs Using Textures]]
 : [[Queriable Buff effects|List of known buff and debuff effects that can be queried]]

Navigation menu

Search

WoW:API UnitBuff: Difference between revisions

WoW:API UnitBuff (source)

Revision as of 04:47, 15 August 2023