WoW:API GetGuildRosterInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(Update for 1.9)
Line 24: Line 24:
:;class : String - The class (Mage, Warrior, etc) of the player.
:;class : String - The class (Mage, Warrior, etc) of the player.
:;zone : String - The position of the player ( or the last if he is off line )  
:;zone : String - The position of the player ( or the last if he is off line )  
:;group : Boolean ( yes or no ) - Return if this member is in a group (obsolete after patch 1.9)
:;group : Obsolete
:;note : String - ''Not Documented''
:;note : String - Returns the character's public note if one exists, returns "" if there is no note or the current player does not have access to the public notes
:;officernote : String - ''Not Documented''
:;officernote : String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes
:;online : Return 1 if the player is online, else it's nil
:;online : Return 1 if the player is online, else it's nil
:;status : String - ''Not Documented'' (patch 1.9 or newer)
:;status : String - ''Not Documented'' (patch 1.9 or newer)
Obsolete
:;group : Boolean ( yes or no ) - Return if this member is in a group (REMOVED IN 1.9)


[[Category:API Functions|GetGuildRosterInfo]]
[[Category:API Functions|GetGuildRosterInfo]]
[[Category:API Guild Functions|GetGuildRosterInfo]]
[[Category:API Guild Functions|GetGuildRosterInfo]]

Revision as of 01:55, 4 January 2006

GetGuildRosterInfo

It returns information about the player of a guild

name, rank, rankIndex, level, class, zone, group, note, officernote, online = GetGuildRosterInfo(index);

The results from this function are changing in patch 1.9. The group parameter is being removed and a new parameter, status, is being added:

name, rank, rankIndex, level, class, zone, note, officernote, online, status = GetGuildRosterInfo(index);

Arguments
(index)
index
Integer - It's a number corresponding to one player in the Guild

Returns
name, rank, rankIndex, level, class, zone, group, note, officernote, online
name
String - The name of one member of the guild
rank
String - The member's rank in the guild ( Guild Master, Member ...)
rankIndex
Number - The number corresponding to the guild's rank.
level
Number - The level of the player.
class
String - The class (Mage, Warrior, etc) of the player.
zone
String - The position of the player ( or the last if he is off line )
group
Obsolete
note
String - Returns the character's public note if one exists, returns "" if there is no note or the current player does not have access to the public notes
officernote
String - Returns the character's officer note if one exists, returns "" if there is no note or the current player does not have access to the officer notes
online
Return 1 if the player is online, else it's nil
status
String - Not Documented (patch 1.9 or newer)

Obsolete

group
Boolean ( yes or no ) - Return if this member is in a group (REMOVED IN 1.9)