WoW:API GetRaidRosterInfo: Difference between revisions

m
Move page script moved page API GetRaidRosterInfo to WoW:API GetRaidRosterInfo without leaving a redirect
(Snip outdated discussion about raidids remaining the same. Put in warning about making no assumptions about it instead.)
m (Move page script moved page API GetRaidRosterInfo to WoW:API GetRaidRosterInfo without leaving a redirect)
 
(4 intermediate revisions by 4 users not shown)
Line 9: Line 9:
=== Arguments ===
=== 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.
;{{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 18: 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 24: 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 ("maintank" or "mainassist").
;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


Anonymous user