WoW:API GetComboPoints: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API GetComboPoints to API GetComboPoints without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<b>GetComboPoints()</b>
{{wowapi}}__NOTOC__
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.
GetComboPoints(unit, target);


<tt>
== Parameters ==
  local comboPoints = GetComboPoints();<br>
=== Arguments ===
  if ( comboPoints == 5 ) then<br>
:(unit, target)
    print "You have 5 Combopoints, use a Finishing Move!";<br>
  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.


[[Category:API Functions|GetComboPoints]]
=== Returns ===
[[Category:API Character Functions|GetComboPoints]]
:;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