WoW:API GetGuildRosterInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Added classFileName to return values.)
mNo edit summary
Line 2: Line 2:
Returns information about the player in the guild roster.
Returns information about the player in the guild roster.
  name, rank, rankIndex, level, class, zone, note,  
  name, rank, rankIndex, level, class, zone, note,  
   officernote, online, status, classFileName = GetGuildRosterInfo(index);
   officernote, online, status, classFileName,
  achievementPoints, achievementRank, isMobile = GetGuildRosterInfo(index);


==Parameters==
==Parameters==
Line 19: Line 20:
:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)
:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)
:;classFileName : Upper-case English classname - localisation independant.
:;classFileName : Upper-case English classname - localisation independant.
:;achievementPoints : The guild achievement points of the member
:;achievementRank : The guild achievement rank of the member
:;isMobile : If member is logged on using the mobile armory application

Revision as of 11:13, 24 October 2010

WoW API < GetGuildRosterInfo

Returns information about the player in the guild roster.

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

Parameters

Arguments

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

Returns

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 )
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)
classFileName
Upper-case English classname - localisation independant.
achievementPoints
The guild achievement points of the member
achievementRank
The guild achievement rank of the member
isMobile
If member is logged on using the mobile armory application