WoW:API GetRaidRosterInfo: Difference between revisions
Jump to navigation
Jump to search
m (Move page script moved page API GetRaidRosterInfo to API GetRaidRosterInfo without leaving a redirect) |
|||
| (8 intermediate revisions by 7 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 === | ||
; | ;{{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 === | ||
| Line 17: | 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 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]] | ||
| Line 23: | 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 (" | ;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 | ||
== Details == | == Details == | ||
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
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.