WoW:API UnitIsPVP: Difference between revisions

Revision as of 18:12, 24 February 2006

UnitIsPVP - Documentation by MadJester

Checks to see if a unit is flagged for PvP or not.

local ispvp = UnitIsPVP(unit);

if (UnitIsPVP("target")) then
 -- Target is flagged for PvP
end

@@ Line 1: / Line 1: @@
 <center>'''UnitIsPVP''' - ''Documentation by MadJester''</center>
-'''Checks to see if a unit is flagged for PvP or not.'''
+Checks to see if a unit is flagged for PvP or not.
-  UnitIsPVP("unit")
+  local ispvp = UnitIsPVP(unit);
-== Parameters ==
+----
-=== Arguments ===
+;''Arguments''
-target, player_name
+:;unit ([[API_TYPE_UnitId|UnitID]]) : the unit name (e.g., "target")
-=== Returns ===
+----
+;''Returns''
-Elsewhere it had been said to return a True or False , to be correct it will return 1 or nothing.
+:;ispvp : 1 if the unit is flagged for PvP, nil otherwise.
-=== Examples ===
+----
+;''Example''
-Example of correct use:
+  if (UnitIsPVP("target")) then
-  if(UnitIsPVP("target"))then
+  -- Target is flagged for PvP
+ end
-Example of incorrect use:
- if(UnitIsPVP("target")=="true")then
- if(UnitIsPVP("target")=="1")then
 ----
 __NOTOC__
 {{Template:WoW API}}