WoW:API GetRaidRosterInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Remove singatures made using ~ in main namespace)
m (Move page script moved page API GetRaidRosterInfo to API GetRaidRosterInfo without leaving a redirect)
 
(9 intermediate revisions by 8 users not shown)
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]].
;{{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 ===
: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 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".
:;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 6/07/2013): Sometimes values are different, example: Thron des Donners and Der Thron des Donners.
::'''Possible values:'''  1, 2, 3, 4, 5, 6, 7, 8
:'''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]]
:;level: Number - The level of the character.  If this character is offline, the level will show as 0 (not nil).
:'''Possible values:'''  nil, "Offline", any valid location
::'''Possible values:'''  0, any valid character level
;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.
:;class: String - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters.
;role: String - The player's role within the raid ("MAINTANK" or "MAINASSIST").
::'''Possible values:'''  Any valid character class, localized
;isML: [[Boolean]] - Returns 1 if the raid member is master looter, nil otherwise
 
:;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.
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.

Latest revision as of 04:46, 15 August 2023

← WoW API < GetRaidRosterInfo

Gets information about a raid member. 

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

Parameters[edit]

Arguments[edit]

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[edit]

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.
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).
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.
zone
String - The name of the zone this character is currently in. This is the value returned by 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 SetMapToCurrentZone() cure this?
You should use functions categorised under Location Functions for getting your own location text --Salanex
Possible values: nil, "Offline", any valid location
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.
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

Details[edit]

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.

Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetRaidRosterInfo&oldid=19269"