WoW:API GetGuildRosterInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 4: Line 4:


  name, rank, rankIndex, level, class, zone, group, note, officernote, online = GetGuildRosterInfo(index);
  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);


----
----
Line 20: 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
:;group : Boolean ( yes or no ) - Return if this member is in a group (obsolete after patch 1.9)
:;note : String - ''Not Documented''
:;note : String - ''Not Documented''
:;officernote : String - ''Not Documented''
:;officernote : String - ''Not Documented''
:;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)


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

Revision as of 22:05, 16 December 2005

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
Boolean ( yes or no ) - Return if this member is in a group (obsolete after patch 1.9)
note
String - Not Documented
officernote
String - Not Documented
online
Return 1 if the player is online, else it's nil
status
String - Not Documented (patch 1.9 or newer)