WoW:API UnitIsFriend: Difference between revisions

WoW:API UnitIsFriend (source)

Revision as of 18:16, 6 April 2006

712 bytes added , 6 April 2006

added: if not (UnitIsFriend("player","target"))

Anonymous user

WoWWiki>Golgor

@@ Line 1: / Line 1: @@
-/script if (UnitIsFriend("player","target")) then AssistUnit("target"); end
+This function will determine if the target is friendly towards you (i.e. is green if you target it). It has nothing to do with whether you have added the unit to your friends list or not.
-Note: in the context of this function, "friend" is any PC in your faction or any NPC that is friendly towards you (i.e. is green if you target it). It has nothing to do with whether you have added the unit to your friends list or not.
+== Parameters ==
-If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.
+=== Function ===
+:;UnitIsFriend : UnitIsFriend("unit","otherunit")<br>Determine whether a unit is friendly with you or not.
-Note: returns either nil or 1, not a boolean value.
+=== Arguments ===
+:;unit:String - The [[API TYPE UnitId|UnitId]] of the first unit.
+:;otherunit:String - The [[API TYPE UnitId|UnitId]] of the unit to compare with the first unit.
+=== Returns ===
+:;IsFriend: Returns either nil or 1, not a boolean value.<br>If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.
+=== Example ===
+:;IsFriend : /script if (UnitIsFriend("player","target")) then AssistUnit("target"); end <br> This will determine if your target is friendly, and if it is assist.
+:;Not IsFriend : /script if not (UnitIsFriend("player","target")) then SendChatMessage("%t is evil!","SAY","Orcish"); end; <br> This is to find if the target not is friendly with you (enemy). If you target an unfriendly target with the name "60Mage" this script will write "60Mage is evil!" in /s.
 ----
-{{WoW API}}
+{{template:WoW API}}