WoW:API GetRaidRosterInfo

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetRaidRosterInfo

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

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.