WoW:API GetRaidRosterInfo - Revision history

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

2023-08-15T04:46:24Z

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

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

WoWWiki>Cruciformer: Correct the case of the return value for the role. Case matters.

2018-01-08T11:43:58Z

Correct the case of the return value for the role. Case matters.

← Older revision		Revision as of 11:43, 8 January 2018
Line 25:		Line 25:
	;online: [[Boolean]] - Returns 1 if raid member is online, nil otherwise.		;online: [[Boolean]] - Returns 1 if raid member is online, nil otherwise.
	;isDead: [[Boolean]] - Returns 1 if raid member is dead (hunters Feigning Death are considered alive), nil otherwise.		;isDead: [[Boolean]] - Returns 1 if raid member is dead (hunters Feigning Death are considered alive), nil otherwise.
	;role: String - The player's role within the raid ("~~maintank~~" or "~~mainassist~~").		;role: String - The player's role within the raid ("MAINTANK" or "MAINASSIST").
	;isML: [[Boolean]] - Returns 1 if the raid member is master looter, nil otherwise		;isML: [[Boolean]] - Returns 1 if the raid member is master looter, nil otherwise

Bear at 04:59, 6 December 2013

2013-12-06T04:59:21Z

← Older revision		Revision as of 04:59, 6 December 2013
Line 9:		Line 9:
	=== Arguments ===		=== Arguments ===

	;[[raidIndex]] : Number - Index of raid member between 1 and MAX_RAID_MEMBERS (40). If you specify an index that is out of bounds, the function returns nil.		;{{api\|raidIndex\|t=t}} : Number - Index of raid member between 1 and MAX_RAID_MEMBERS (40). If you specify an index that is out of bounds, the function returns nil.

	=== Returns ===		=== Returns ===

WoWWiki>Shurshik87: /* Returns */

2013-06-07T10:44:50Z

Returns

← Older revision		Revision as of 10:44, 7 June 2013
Line 19:		Line 19:
	;fileName: String - The system representation of the character's class; always in english, always fully capitalized.		;fileName: String - The system representation of the character's class; always in english, always fully capitalized.
	;zone: String - The name of the zone this character is currently in. This is the value returned by [[API GetRealZoneText\|GetRealZoneText]]. It is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline".		;zone: String - The name of the zone this character is currently in. This is the value returned by [[API GetRealZoneText\|GetRealZoneText]]. It is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline".
			:'''BUG''' (as of 6/07/2013): Sometimes values are different, example: Thron des Donners and Der Thron des Donners.
	:'''BUG''' (as of 2/26/2005): It seems that the person calling this function will have their Zone value returned as nil if they have not changed locations since last reloading their UI. Once you change locations (get the name to popup on screen), it seems to return as normal. This only seems to affect when you look at the zone value of yourself from the raid. ''Could a call to [[API SetMapToCurrentZone\|SetMapToCurrentZone]]() cure this?''		:'''BUG''' (as of 2/26/2005): It seems that the person calling this function will have their Zone value returned as nil if they have not changed locations since last reloading their UI. Once you change locations (get the name to popup on screen), it seems to return as normal. This only seems to affect when you look at the zone value of yourself from the raid. ''Could a call to [[API SetMapToCurrentZone\|SetMapToCurrentZone]]() cure this?''
	:You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex\|Salanex]]		:You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex\|Salanex]]

WoWWiki>Allara: /* Returns */ Add a confirmation that GetRealZoneText() is equivalent to zone

2010-07-27T01:16:35Z

Returns: Add a confirmation that GetRealZoneText() is equivalent to zone

← Older revision		Revision as of 01:16, 27 July 2010
Line 18:		Line 18:
	;class: String - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters.		;class: String - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters.
	;fileName: String - The system representation of the character's class; always in english, always fully capitalized.		;fileName: String - The system representation of the character's class; always in english, always fully capitalized.
	;zone: String - The name of the zone this character is currently in. This is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline".		;zone: String - The name of the zone this character is currently in. This is the value returned by [[API GetRealZoneText\|GetRealZoneText]]. It is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline".
	:'''BUG''' (as of 2/26/2005): It seems that the person calling this function will have their Zone value returned as nil if they have not changed locations since last reloading their UI. Once you change locations (get the name to popup on screen), it seems to return as normal. This only seems to affect when you look at the zone value of yourself from the raid. ''Could a call to [[API SetMapToCurrentZone\|SetMapToCurrentZone]]() cure this?''		:'''BUG''' (as of 2/26/2005): It seems that the person calling this function will have their Zone value returned as nil if they have not changed locations since last reloading their UI. Once you change locations (get the name to popup on screen), it seems to return as normal. This only seems to affect when you look at the zone value of yourself from the raid. ''Could a call to [[API SetMapToCurrentZone\|SetMapToCurrentZone]]() cure this?''
	:You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex\|Salanex]]		:You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex\|Salanex]]

WoWWiki>Mikk: Snip outdated discussion about raidids remaining the same. Put in warning about making no assumptions about it instead.

2009-09-16T18:58:14Z

Snip outdated discussion about raidids remaining the same. Put in warning about making no assumptions about it instead.

← Older revision		Revision as of 18:58, 16 September 2009
Line 28:		Line 28:

	== Details ==		== Details ==
	~~(As of 3.1, this no longer accurate. Raid indices now reorder themselves every time the raid layout changes.)~~

	~~Regarding the correspondance of raid indices~~ to ~~players: Let C be~~ the ~~list of players in a raid ordered by their raid index~~. ~~It appears that after any series of changes is made to~~ the raid, ~~at the end all players from C still in the~~ raid ~~will retain their original ordering (even if they left~~ and ~~rejoined the raid)~~, with ~~new members existing at any index 1<i<=40.~~		Do not make any assumptions about raidid (raid1, raid2, etc) to name mappings remaining the same or not. When the raid changes, people MAY retain it or not, depending on raid size and WoW patch. Yes, this behavior has changed with patches in the past and may do it again.

	~~It also appears that your character's index will always be equal to GetNumRaidMembers() for~~ the ~~purposes of GetRaidRosterInfo. In other words, your character's index will always be n in a raid of size n. All other members will have indices less than n~~.

WoWWiki>Akryn: /* Details */

2009-05-12T02:39:51Z

Details

← Older revision		Revision as of 02:39, 12 May 2009
Line 28:		Line 28:

	== Details ==		== Details ==
			(As of 3.1, this no longer accurate. Raid indices now reorder themselves every time the raid layout changes.)

	Regarding the correspondance of raid indices to players: Let C be the list of players in a raid ordered by their raid index. It appears that after any series of changes is made to the raid, at the end all players from C still in the raid will retain their original ordering (even if they left and rejoined the raid), with new members existing at any index 1<i<=40.		Regarding the correspondance of raid indices to players: Let C be the list of players in a raid ordered by their raid index. It appears that after any series of changes is made to the raid, at the end all players from C still in the raid will retain their original ordering (even if they left and rejoined the raid), with new members existing at any index 1<i<=40.

	It also appears that your character's index will always be equal to GetNumRaidMembers() for the purposes of GetRaidRosterInfo. In other words, your character's index will always be n in a raid of size n. All other members will have indices less than n.		It also appears that your character's index will always be equal to GetNumRaidMembers() for the purposes of GetRaidRosterInfo. In other words, your character's index will always be n in a raid of size n. All other members will have indices less than n.

WoWWiki>Catamorfizm: Updated with new information

2009-01-04T20:31:54Z

Updated with new information

← Older revision		Revision as of 20:31, 4 January 2009
Line 29:		Line 29:
	== Details ==		== Details ==
	Regarding the correspondance of raid indices to players: Let C be the list of players in a raid ordered by their raid index. It appears that after any series of changes is made to the raid, at the end all players from C still in the raid will retain their original ordering (even if they left and rejoined the raid), with new members existing at any index 1<i<=40.		Regarding the correspondance of raid indices to players: Let C be the list of players in a raid ordered by their raid index. It appears that after any series of changes is made to the raid, at the end all players from C still in the raid will retain their original ordering (even if they left and rejoined the raid), with new members existing at any index 1<i<=40.

			It also appears that your character's index will always be equal to GetNumRaidMembers() for the purposes of GetRaidRosterInfo. In other words, your character's index will always be n in a raid of size n. All other members will have indices less than n.

WoWWiki>Mikk at 11:01, 27 April 2008

2008-04-27T11:01:05Z

← Older revision		Revision as of 11:01, 27 April 2008
Line 3:		Line 3:
	Gets information about a raid member.		Gets information about a raid member.

	name, rank, subgroup, level, class, fileName, zone, online, isDead, role, isML = GetRaidRosterInfo(raidIndex);		name, rank, subgroup, level, class, fileName,
			zone, online, isDead, role, isML = GetRaidRosterInfo(raidIndex);

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===

	;[[raidIndex]] : Number - Index of raid member between 1 and (~~up to~~) 40. If you specify an index that is out of bounds, the function returns nil.		;[[raidIndex]] : Number - Index of raid member between 1 and MAX_RAID_MEMBERS (40). If you specify an index that is out of bounds, the function returns nil.

	=== Returns ===		=== Returns ===

WoWWiki>Starlightblunder: /* Details */

2007-08-17T16:13:06Z

Details

← Older revision		Revision as of 16:13, 17 August 2007
Line 8:		Line 8:
	=== Arguments ===		=== Arguments ===

	:;[[raidIndex]] : Number - Index of raid member between 1 and (up to) 40. If you specify an index that is out of bounds, the function returns [[nil]].		;[[raidIndex]] : Number - Index of raid member between 1 and (up to) 40. If you specify an index that is out of bounds, the function returns nil.

	=== Returns ===		=== Returns ===
	~~:name, rank, subgroup, level, class, fileName, zone, online, isDead~~		;name: String - raid member's name. In cross-realm battlegrounds, returns "Name-Server" for cross-realm players.
			;rank: Integer - Returns 2 if the raid member is the leader of the raid, 1 if the raid member is promoted to assistant, and 0 otherwise.
	:;name: String - ~~the~~ name ~~of the player~~		;subgroup: Integer - The raid party this character is currently a member of. Raid subgroups are numbered as on the standard raid window.
			;level: Number - The level of the character. If this character is offline, the level will show as 0 (not nil).
	:;rank: Integer - ~~The character's current rank in~~ the ~~raid. 0 is a standard~~ raid member~~. 1~~ is ~~a raid Assistant - labeled (A) in~~ the ~~standard raid window. 2 is the Leader~~ of the raid ~~- labeled (L) in~~ the ~~standard~~ raid ~~window~~.		;class: String - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters.
	~~::'''Possible values:''' 0, 1, 2~~		;fileName: String - The system representation of the character's class; always in english, always fully capitalized.
			;zone: String - The name of the zone this character is currently in. This is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline".
	:;subgroup: Integer - The raid party this character is currently a member of. Raid subgroups are numbered as on the standard raid window.		:'''BUG''' (as of 2/26/2005): It seems that the person calling this function will have their Zone value returned as nil if they have not changed locations since last reloading their UI. Once you change locations (get the name to popup on screen), it seems to return as normal. This only seems to affect when you look at the zone value of yourself from the raid. ''Could a call to [[API SetMapToCurrentZone\|SetMapToCurrentZone]]() cure this?''
	~~::'''Possible values:''' 1, 2, 3, 4, 5, 6, 7, 8~~		:You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex\|Salanex]]
			:'''Possible values:''' nil, "Offline", any valid location
	:;level: Number - The level of the character. If this character is offline, the level will show as 0 (not nil).		;online: [[Boolean]] - Returns 1 if raid member is online, nil otherwise.
	~~::'''Possible values:''' 0, any valid character level~~		;isDead: [[Boolean]] - Returns 1 if raid member is dead (hunters Feigning Death are considered alive), nil otherwise.
			;role: String - The player's role within the raid ("maintank" or "mainassist").
	:;class: String - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters.		;isML: [[Boolean]] - Returns 1 if the raid member is master looter, nil otherwise
	~~::'''Possible values:''' Any valid character class, localized~~

	:;fileName: String - The system representation of the character's class; always in english, always fully capitalized.
	~~::'''Possible values:''' "PRIEST, "WARRIOR", "WARLOCK", etc...~~

	:;zone: String - The name of the zone this character is currently in. This is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline".
	::'''BUG''' (as of 2/26/2005): It seems that the person calling this function will have their Zone value returned as nil if they have not changed locations since last reloading their UI. Once you change locations (get the name to popup on screen), it seems to return as normal. This only seems to affect when you look at the zone value of yourself from the raid. ''Could a call to [[API SetMapToCurrentZone\|SetMapToCurrentZone]]() cure this?''

	::You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex\|Salanex]]

	::'''Possible values:''' nil, "Offline", any valid location

	:;online: [[Boolean]] - ~~The player's current~~ online ~~status~~
	~~::'''Possible values:''' 1~~, nil

	:;isDead: [[Boolean]] - Returns if raid member is dead ~~or not~~
	~~::'''Possible values:''' 1~~, nil
	~~::Note: this does not show hunters as being dead when they have Feign Death~~.)

	:;role: String - The player's role within the raid
	~~::'''Possible values:'''~~ "maintank", "mainassist"

	:;isML: [[Boolean]] - Returns if the raid member is master looter
	~~::'''Possible values:''' 1~~, nil

	== Details ==		== Details ==
			Regarding the correspondance of raid indices to players: Let C be the list of players in a raid ordered by their raid index. It appears that after any series of changes is made to the raid, at the end all players from C still in the raid will retain their original ordering (even if they left and rejoined the raid), with new members existing at any index 1<i<=40.
	:Regarding the correspondance of raid indices to players: Let C be the list of players in a raid ordered by their raid index. It appears that after any series of changes is made to the raid, at the end all players from C still in the raid will retain their original ordering (even if they left and rejoined the raid), with new members existing at any index 1<i<=40.