WoW:API UnitIsTappedByPlayer: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<center>'''UnitIsTappedByPlayer''' - ''Documentation by John''</center>
{{wowapi}}__NOTOC__


Checks to see if a unit is tapped by the player
Checks to see if a unit is tapped by the player
  local isTapped = UnitIsTappedByPlayer(unit);
  local isTapped = UnitIsTappedByPlayer(unit);


----
== Parameters ==
;''Arguments''
=== Arguments ===


:;unit ([[API_TYPE_UnitId|UnitID]]) : the unit name (e.g., "target")
:;unit : String - the ([[API_TYPE_UnitId|UnitID]]) (e.g., "target")


----
=== Returns ===
;''Returns''


:;isTapped: true if the unit is tapped by current player, false otherwise.
:;isTapped: true if the unit is tapped by current player, false otherwise.


----
== Example ==
;''Example''


  if (UnitIsTappedByPlayer("target")) then
  if (UnitIsTappedByPlayer("target")) then
Line 21: Line 19:
  end
  end


;''Example used in conjunction with UnitIsTapped''
=== Example used in conjunction with UnitIsTapped ===
   
   
  if (UnitIsTapped("target")) and (not UnitIsTappedByPlayer("target")) then
  if (UnitIsTapped("target")) and (not UnitIsTappedByPlayer("target")) then
   -- Target is tapped by another player
   -- Target is tapped by another player
  end
  end
----
__NOTOC__
{{Template:WoW API}}

Revision as of 09:15, 7 July 2006

WoW API < UnitIsTappedByPlayer

Checks to see if a unit is tapped by the player

local isTapped = UnitIsTappedByPlayer(unit);

Parameters

Arguments

unit
String - the (UnitID) (e.g., "target")

Returns

isTapped
true if the unit is tapped by current player, false otherwise.

Example

if (UnitIsTappedByPlayer("target")) then
 -- Target is tapped by player
end

Example used in conjunction with UnitIsTapped

if (UnitIsTapped("target")) and (not UnitIsTappedByPlayer("target")) then
 -- Target is tapped by another player
end