WoW:API GetComboPoints: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated to reflect unit argument is now mandatory.)
m (Move page script moved page API GetComboPoints to API GetComboPoints without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{wowapi}}
{{wowapi}}__NOTOC__
'''GetComboPoints()'''
Retrieves the number of combo points gained by a player.


Delivers how much combo points the rogue or the druids cat form on the actual target has.  Pass "player" as the first argument to get the player's combo points.  Can also be retrieve combo points for other units.
GetComboPoints(unit, target);


<tt>
== Parameters ==
  if ( GetComboPoints("player") == 5 ) then<br>
=== Arguments ===
    print "You have 5 Combopoints, use a Finishing Move!";<br>
:(unit, target)
  end
</tt>


The return value is a number (0 up to 5).
:;unit : String - Either "player" or "vehicle".  (More strings/[[UnitId]]s may be possible but have not been seen in Blizzard code.)
:;target : String - Should be "target".  No other value has been seen in Blizzard code.
 
=== Returns ===
:;Number : between 0 and 5 inclusive

Latest revision as of 04:45, 15 August 2023

WoW API < GetComboPoints

Retrieves the number of combo points gained by a player.

GetComboPoints(unit, target);

Parameters[edit]

Arguments[edit]

(unit, target)
unit
String - Either "player" or "vehicle". (More strings/UnitIds may be possible but have not been seen in Blizzard code.)
target
String - Should be "target". No other value has been seen in Blizzard code.

Returns[edit]

Number
between 0 and 5 inclusive