Changes: API GetRaidRosterInfo

Revision as of 16:11, 17 August 2007

Gets information about a raid member.

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

Parameters

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.

Returns

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

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.

@@ Line 8: / Line 8: @@
 === 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 ===
+;name: String - raid member's name. In cross-realm battlegrounds, returns "Name-Server" for cross-realm players.
-:name, rank, subgroup, level, class, fileName, zone, online, isDead
+;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.
-:;name: String - the name of the player
+;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.
-:;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.
+;fileName: String - The system representation of the character's class; always in english, always fully capitalized.
-::'''Possible values:'''  0, 1, 2
+;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?''
-:;subgroup: Integer - The raid party this character is currently a member of.  Raid subgroups are numbered as on the standard raid window.
+:You should use functions categorised under '''Location Functions''' for getting your own location text --[[User:Salanex|Salanex]]
-::'''Possible values:'''  1, 2, 3, 4, 5, 6, 7, 8
+:'''Possible values:'''  nil, "Offline", any valid location
+;online: [[Boolean]] - Returns 1 if raid member is online, nil otherwise.
-:;level: Number - The level of the character.  If this character is offline, the level will show as 0 (not nil).
+;isDead: [[Boolean]] - Returns 1 if raid member is dead (hunters Feigning Death are considered alive), nil otherwise.
-::'''Possible values:'''  0, any valid character level
+;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
-:;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:'''  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 ==