WoW:API UnitIsFriend - Revision history

Move page script: Move page script moved page API UnitIsFriend to WoW:API UnitIsFriend without leaving a redirect

2023-08-15T04:47:46Z

Move page script moved page API UnitIsFriend to API UnitIsFriend without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Starlightblunder: boilerplate

2009-08-31T18:35:50Z

boilerplate

← Older revision		Revision as of 18:35, 31 August 2009
Line 1:		Line 1:
	{{wowapi}}		{{wowapi}}
	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.~~		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");

	== ~~Parameters~~ ==		== Arguments ==
			;unit:String - A valid [[API TYPE UnitId\|unit]].
			;otherunit:String - A valid [[API TYPE UnitId\|unit]].

	==~~= Function =~~==		== Returns ==
	:;~~UnitIsFriend~~ : ~~UnitIsFriend("unit","~~otherunit~~")<br>Determine whether a unit~~ is friendly ~~with you or not~~.		;IsFriend:Boolean flag - 1 if otherunit is friendly to unit; nil otherwise.

	==~~= Arguments =~~==		== Example ==
	~~:;unit:String -~~ The ~~[[API TYPE UnitId\|UnitId]] of~~ the ~~first unit.~~		The following snippet outputs a message when the player has a hostile target.
	~~:;otherunit:String - The [[API TYPE UnitId\|UnitId]] of the unit to compare with the first unit.~~		if UnitExists("target") and not UnitIsFriend("player", "target") then
			print(UnitName("target") .. " is evil! Run!");
	~~=== Returns ===~~		end
	~~:;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~~")~~; end; <br> This is to find if the target is not 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.~~

WoWWiki>Cowlinator: /* Example */

2009-01-17T08:57:01Z

Example

← Older revision		Revision as of 08:57, 17 January 2009
Line 17:		Line 17:
	:;IsFriend : /script if (UnitIsFriend("player","target")) then AssistUnit("target"); end <br> This will determine if your target is friendly, and if it is assist.		:;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"); 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, using your faction's default language.		:;Not IsFriend : /script if not (UnitIsFriend("player","target")) then SendChatMessage("%t is evil!","SAY"); end; <br> This is to find if the target is not 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.

WoWWiki>SunziWu: removed use of language argument to SendChatMessage() to make it more general

2007-01-12T04:23:57Z

removed use of language argument to SendChatMessage() to make it more general

← Older revision		Revision as of 04:23, 12 January 2007
Line 17:		Line 17:
	:;IsFriend : /script if (UnitIsFriend("player","target")) then AssistUnit("target"); end <br> This will determine if your target is friendly, and if it is assist.		:;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.		:;Not IsFriend : /script if not (UnitIsFriend("player","target")) then SendChatMessage("%t is evil!","SAY"); 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, using your faction's default language.

WoWWiki>Hobinbot: upgraded deprecated template

2007-01-06T18:10:43Z

upgraded deprecated template

← Older revision		Revision as of 18:10, 6 January 2007
Line 1:		Line 1:
			{{wowapi}}
	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.		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.

Line 17:		Line 18:

	:;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.		:;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.


	~~----~~
	~~{{template:WoW API}}~~

WoWWiki>Golgor: added: if not (UnitIsFriend("player","target"))

2006-04-06T18:16:41Z

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

← Older revision		Revision as of 18:16, 6 April 2006
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}}

WoWWiki>Muert at 05:34, 4 January 2006

2006-01-04T05:34:23Z

← Older revision		Revision as of 05:34, 4 January 2006
Line 7:		Line 7:
	Note: returns either nil or 1, not a boolean value.		Note: returns either nil or 1, not a boolean value.

	~~[[Category:API Functions\|UnitIsFriend]]~~
	~~[[Category:~~API ~~Unit Functions\|UnitIsFriend]]~~		----
			{{WoW API}}

WoWWiki>Shag at 15:45, 30 October 2005

2005-10-30T15:45:02Z

← Older revision		Revision as of 15:45, 30 October 2005
Line 4:		Line 4:

	If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.		If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.

			Note: returns either nil or 1, not a boolean value.

	[[Category:API Functions\|UnitIsFriend]]		[[Category:API Functions\|UnitIsFriend]]
	[[Category:API Unit Functions\|UnitIsFriend]]		[[Category:API Unit Functions\|UnitIsFriend]]

WoWWiki>Inglais at 13:23, 27 August 2005

2005-08-27T13:23:59Z

← Older revision		Revision as of 13:23, 27 August 2005
Line 4:		Line 4:

	If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.		If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.

			[[Category:API Functions\|UnitIsFriend]]
			[[Category:API Unit Functions\|UnitIsFriend]]

WoWWiki>Earen at 23:05, 14 July 2005

2005-07-14T23:05:52Z

← Older revision		Revision as of 23:05, 14 July 2005
Line 2:		Line 2:

	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.		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.

			If the second parameter is "target" and nothing is targeted, this function returns <tt>nil</tt>.