WoW:API UnitInRaid - Revision history

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

2023-08-15T04:47:45Z

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

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

2603:3026:308:5C00:754B:6527:56F5:6861 at 09:31, 23 October 2019

2019-10-23T09:31:37Z

← Older revision		Revision as of 09:31, 23 October 2019
Line 9:		Line 9:
	== Returns ==		== Returns ==
	;raidIndex		;raidIndex
	: {{api\|raidIndex\|t=t}} of "unit" if ~~she~~ is in your raid group, otherwise nil.		: {{api\|raidIndex\|t=t}} of "unit" if he is in your raid group, otherwise nil.

	== Example ==		== Example ==

Bear at 04:59, 6 December 2013

2013-12-06T04:59:44Z

← Older revision		Revision as of 04:59, 6 December 2013
Line 9:		Line 9:
	== Returns ==		== Returns ==
	;raidIndex		;raidIndex
	: ~~[[RaidIndex]]~~ of "unit" if she is in your raid group, otherwise nil.		: {{api\|raidIndex\|t=t}} of "unit" if she is in your raid group, otherwise nil.

	== Example ==		== Example ==

85.136.139.160 at 10:30, 5 December 2013

2013-12-05T10:30:02Z

← Older revision		Revision as of 10:30, 5 December 2013
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Returns a number if the unit is in your raid group, nil otherwise.		Returns a number if the unit is in your raid group, nil otherwise.
	~~index~~ = UnitInRaid("unit")		raidIndex = UnitInRaid("unit")

	== Arguments ==		== Arguments ==
	;unit : String - [[unitId]] to check.		;unit
			: String - [[unitId]] to check.

	== Returns ==		== Returns ==
	;~~index~~ : ~~Layout position for~~ raid ~~members: integer ascending from 0 (which is the first member of the first~~ group).		;raidIndex
			: [[RaidIndex]] of "unit" if she is in your raid group, otherwise nil.

	== Example ==		== Example ==
	~~if UnitInRaid~~("target"~~) then~~		print("Your target is " .. (UnitInRaid("target") and "" or "not ") .. "in your raid group.")
	~~print~~(~~UnitName~~("target") .. " is in your raid group.");
	~~end~~

	==Details==		==Details==
	: Pets are not considered to be part of your raid group.		* The return value is the same index used to retrieve information about raid members using [[API GetRaidRosterInfo]].
	; While in a battleground, this function returns information about your battleground group.		* Pets are not considered to be part of your raid group.
			* While in a battleground, this function returns information about your battleground group.

	==See also==		==See also==
	* [[API UnitInParty]]		* [[API UnitInParty]]
			* [[API GetRaidRosterInfo]]

WoWWiki>Arrek: See also

2009-12-17T01:56:47Z

WoWWiki>Starlightblunder at 21:28, 30 July 2009

2009-07-30T21:28:54Z

← Older revision		Revision as of 21:28, 30 July 2009
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
			Returns a number if the unit is in your raid group, nil otherwise.
			index = UnitInRaid("unit")

	~~<!-- Describe the purpose of the function, exhausting detail can be saved for a later section -->~~		== Arguments ==
	~~Returns 1 if the~~ unit ~~is in your raid group, nil otherwise~~.		;unit : String - [[unitId]] to check.

	~~<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->~~		== Returns ==
	~~isTrue~~ = ~~UnitInRaid("arg1")~~		;index : Layout position for raid members: integer ascending from 0 (which is the first member of the first group).

	=~~= Parameters~~ ==
	~~=== Arguments ===~~
	~~<!-- List each argument, together with its type -->~~
	:;~~arg1~~ : ~~String - UnitID or unit name who should be checked~~

	~~=== Returns ===~~
	~~<!-- List each return value, together with its type -->~~
	:~~;isTrue : 1 or nil~~

	== Example ==		== Example ==
	~~<!-- If it helps, include an example here, though it's not required~~ if ~~the usage is self-explanatory -->~~		if UnitInRaid("target") then
	~~local TargetInRaid =~~ UnitInRaid("target")		print(UnitName("target") .. " is in your raid group.");
	~~local TargetInRaid = UnitInRaid~~("~~Duugu~~")		end

	~~====Result====~~
	~~<!-- If it helps, include example results here, though they are not required~~. ~~You're allowed to cheat liberally since WoW isn't a command line language~~. ~~-->~~
	~~TargetInRaid = 1 - If your target~~ is in your raid group.
	~~TargetInRaid = nil - If your target is not in raid group.~~

	==Details==		==Details==
	~~<!-- Details not appropriate for the main description can go here.~~
	~~REMOVE the section if you're just going to restate the intro line! -->~~

	: Pets are not considered to be part of your raid group.		: Pets are not considered to be part of your raid group.
	~~: The "~~battleground~~"-raid/party-members are also not considered to be part of~~ your ~~raid~~.		; While in a battleground, this function returns information about your battleground group.
	~~: Inside "battleground" UnitInRaid("unit") will return a number based on layout position~~

WoWWiki>Duugu at 13:22, 24 December 2007

2007-12-24T13:22:34Z

← Older revision		Revision as of 13:22, 24 December 2007
Line 10:		Line 10:
	=== Arguments ===		=== Arguments ===
	<!-- List each argument, together with its type -->		<!-- List each argument, together with its type -->
	:;arg1 : String - ~~Unit~~ who should be checked		:;arg1 : String - UnitID or unit name who should be checked

	=== Returns ===		=== Returns ===
Line 19:		Line 19:
	<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->		<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory -->
	local TargetInRaid = UnitInRaid("target")		local TargetInRaid = UnitInRaid("target")
			local TargetInRaid = UnitInRaid("Duugu")

	====Result====		====Result====

WoWWiki>Haghala: /* Details */

2006-12-19T17:34:38Z

Details

← Older revision		Revision as of 17:34, 19 December 2006
Line 31:		Line 31:
	: Pets are not considered to be part of your raid group.		: Pets are not considered to be part of your raid group.
	: The "battleground"-raid/party-members are also not considered to be part of your raid.		: The "battleground"-raid/party-members are also not considered to be part of your raid.
			: Inside "battleground" UnitInRaid("unit") will return a number based on layout position

WoWWiki>Bdkmpss: /* Details */

2006-12-18T14:50:35Z

Details

@@ Line 1: / Line 1: @@
 Returns 1 if the unit is in your raid group, nil otherwise.
-Pets are not considered to be part of a raid group.
+<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
-----
+==Details==
-{{WoW API}}
+<!-- Details not appropriate for the main description can go here.
-[[Category:World of Warcraft API]]
+: Pets are not considered to be part of your raid group.

WoWWiki>Fandyllic at 21:38, 20 March 2006

2006-03-20T21:38:23Z

← Older revision		Revision as of 21:38, 20 March 2006
Line 6:		Line 6:
	----		----
	{{WoW API}}		{{WoW API}}

			[[Category:World of Warcraft API]]

← Older revision		Revision as of 01:56, 17 December 2009
Line 17:		Line 17:
	: Pets are not considered to be part of your raid group.		: Pets are not considered to be part of your raid group.
	; While in a battleground, this function returns information about your battleground group.		; While in a battleground, this function returns information about your battleground group.

			==See also==
			* [[API UnitInParty]]