WoW:API GetGuildRosterInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(updated possible status return values)
m (Rank Index starts at 0, while the other functions start at 1)
Line 20: Line 20:
:;name : String - The name of one member of the guild
:;name : String - The name of one member of the guild
:;rank : String - The member's rank in the guild ( Guild Master, Member ...)
:;rank : String - The member's rank in the guild ( Guild Master, Member ...)
:;rankIndex : Number - The number corresponding to the guild's rank.
:;rankIndex : Number - The number corresponding to the guild's rank. The Rank Index starts at 0, add 1 to correspond with the index used in GuildControlGetRankName(index)
:;level : Number - The level of the player.
:;level : Number - The level of the player.
:;class : String - The class (Mage, Warrior, etc) of the player.
:;class : String - The class (Mage, Warrior, etc) of the player.

Revision as of 19:15, 8 June 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. The Rank Index starts at 0, add 1 to correspond with the index used in GuildControlGetRankName(index)
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
The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)

Obsolete

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

Template:WoW API