WoW:API GetRaidRosterInfo: Difference between revisions
Jump to navigation
Jump to search
GetRaidRosterInfo Documentation by Totem
(This function returns all the information about each raid member) |
No edit summary |
||
| Line 14: | Line 14: | ||
:;name, rank, subgroup, level, class, fileName, zone, online | :;name, rank, subgroup, level, class, fileName, zone, online | ||
;''name'' | |||
:Provides the name of the character as a string. | |||
:'''Possible values:''' Any valid character name | |||
;''rank'' | |||
:Provides an integer of the character's current rank in the raid. 0 is a standard member of the raid. 1 is the Assistant - labeled (A) in the standard raid window. 2 is the Leader of the raid - labeled (L) in the standard raid window. | |||
:'''Possible values:''' 0, 1, 2 | |||
;''subgroup'' | |||
:Provides the raid group this character is currently a member of. Raid subgroups are numbered on the standard raid window. | |||
:'''Possible values:''' 1, 2, 3, 4, 5, 6, 7, 8 | |||
;''level'' | |||
:Provides the level of the character. If this character is offline, the level will show as 0 (not nil). | |||
:'''Possible values:''' 0, any valid character level | |||
;''class'' | |||
:Provides a string of the class of character. Capitalization seems to be standard (ex: Priest). This function works as normal for offline characters. | |||
:'''Possible values:''' Any valid character class | |||
;''fileName'' | |||
:This seems to also provide the character class, but fully capitalized (ex: PRIEST). This function works as normal for offline characters. | |||
:'''Possible values:''' Any valid character class, but capitalized | |||
;''zone'' | |||
:Provides 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. | |||
:'''Possible values:''' nil, 'Offline', any valid location | |||
;''online'' | |||
:Player's current online status | |||
:'''Possible values:''' 1, nil | |||
---- | ---- | ||
Revision as of 22:18, 26 February 2005
Gets information about each raid member.
GetRaidRosterInfo();
- Arguments
- ID of raidmember (1 ... MAX_RAID_MEMBERS)
- Returns
- name, rank, subgroup, level, class, fileName, zone, online
- name
- Provides the name of the character as a string.
- Possible values: Any valid character name
- rank
- Provides an integer of the character's current rank in the raid. 0 is a standard member of the raid. 1 is the Assistant - labeled (A) in the standard raid window. 2 is the Leader of the raid - labeled (L) in the standard raid window.
- Possible values: 0, 1, 2
- subgroup
- Provides the raid group this character is currently a member of. Raid subgroups are numbered on the standard raid window.
- Possible values: 1, 2, 3, 4, 5, 6, 7, 8
- level
- Provides the level of the character. If this character is offline, the level will show as 0 (not nil).
- Possible values: 0, any valid character level
- class
- Provides a string of the class of character. Capitalization seems to be standard (ex: Priest). This function works as normal for offline characters.
- Possible values: Any valid character class
- fileName
- This seems to also provide the character class, but fully capitalized (ex: PRIEST). This function works as normal for offline characters.
- Possible values: Any valid character class, but capitalized
- zone
- Provides 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.
- Possible values: nil, 'Offline', any valid location
- online
- Player's current online status
- Possible values: 1, nil
- Example
name, rank, subgroup, level, class, fileName, zone, online = GetRaidRosterInfo(Raid_Member_ID_Number);
- Result
- Description
- Returns all those values.