WoW:API GetGuildRosterInfo: Difference between revisions

Added isSoREligible, standingID returned values, updated descriptions for other returned values
mNo edit summary
(Added isSoREligible, standingID returned values, updated descriptions for other returned values)
Line 3: Line 3:
  name, rank, rankIndex, level, class, zone, note,  
  name, rank, rankIndex, level, class, zone, note,  
   officernote, online, status, classFileName,  
   officernote, online, status, classFileName,  
   achievementPoints, achievementRank, isMobile = GetGuildRosterInfo(index);
   achievementPoints, achievementRank, isMobile, isSoREligible, standingID = GetGuildRosterInfo(index);


==Parameters==
==Parameters==
Line 9: Line 9:
:;index : Integer - It's a number corresponding to one player in the Guild
:;index : Integer - It's a number corresponding to one player in the Guild
===Returns===
===Returns===
:;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.  The Rank Index starts at 0, add 1 to correspond with the index used in GuildControlGetRankName(index)
:;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)
Line 17: Line 17:
:;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
:;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
:;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 : Boolean - Whether the player is online
:;status : The availability of the player; may be "<AFK>", "<DND>", or "" for no special status. (Introduced in patch 1.9)
:;status : Integer (0,1,2) - The availability of the player; Available, Away, Busy
:;classFileName : Upper-case English classname - localisation independant.
:;classFileName : String - Upper-case English classname - localisation independant.
:;achievementPoints : The guild achievement points of the member
:;achievementPoints : Integer - The guild achievement points of the member
:;achievementRank : The guild achievement rank of the member
:;achievementRank : Integer - The guild achievement rank of the member
:;isMobile : If member is logged on using the mobile armory application
:;isMobile : Boolean - If member is logged on using the mobile armory application
:;isSoREligible : Boolean - is member eligible for Scroll of Resurrection
:;standingID : Integer [[API TYPE StandingId|StandingId]] (0-8) - Numeric representation of standing (Neutral, friendly etc) with the guild
:
Anonymous user