WoW:API GetComboPoints: Difference between revisions

WoW:API GetComboPoints (source)

17 bytes added , 19 April 2009

rewrite to match API formats and correct parameters

Anonymous user

@@ 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