WoW:API UnitIsFriend: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API UnitIsFriend to API UnitIsFriend without leaving a redirect)
 
(10 intermediate revisions by 10 users not shown)
Line 1: Line 1:
/script if (UnitIsFriend("player","target")) then AssistUnit("target"); end
{{wowapi}}
This function will determine whether two units are friendly to each other (i.e. able to help each other in combat).
isFriend = UnitIsFriend("unit","otherunit");
 
== Arguments ==
;unit:String - A valid [[API TYPE UnitId|unit]].
;otherunit:String - A valid [[API TYPE UnitId|unit]].
 
== Returns ==
;IsFriend:Boolean flag - 1 if otherunit is friendly to unit; nil otherwise.
 
== Example ==
The following snippet outputs a message when the player has a hostile target.
if UnitExists("target") and not UnitIsFriend("player", "target") then
  print(UnitName("target") .. " is evil! Run!");
end

Latest revision as of 04:47, 15 August 2023

WoW API < UnitIsFriend

This function will determine whether two units are friendly to each other (i.e. able to help each other in combat).

isFriend = UnitIsFriend("unit","otherunit");

Arguments[edit]

unit
String - A valid unit.
otherunit
String - A valid unit.

Returns[edit]

IsFriend
Boolean flag - 1 if otherunit is friendly to unit; nil otherwise.

Example[edit]

The following snippet outputs a message when the player has a hostile target.

if UnitExists("target") and not UnitIsFriend("player", "target") then
 print(UnitName("target") .. " is evil! Run!");
end