WoW API: UnitIsFriend

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < UnitIsFriend

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.

Parameters

Function

UnitIsFriend

UnitIsFriend("unit","otherunit")
Determine whether a unit is friendly with you or not.

Arguments

unit

String - The UnitId of the first unit.

otherunit

String - The UnitId of the unit to compare with the first unit.

Returns

IsFriend

Returns either nil or 1, not a boolean value.
If the second parameter is "target" and nothing is targeted, this function returns nil.

Example

IsFriend

/script if (UnitIsFriend("player","target")) then AssistUnit("target"); end
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"); end;
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, using your faction's default language.