WoW:API GetGuildRosterInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(updated possible status return values)
m (Move page script moved page API GetGuildRosterInfo to API GetGuildRosterInfo without leaving a redirect)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<center>'''GetGuildRosterInfo'''</center>
{{wowapi}} __NOTOC__
Returns information about the player in the guild roster.
name, rank, rankIndex, level, class, zone, note,
  officernote, online, status, classFileName,
  achievementPoints, achievementRank, isMobile, isSoREligible, standingID = GetGuildRosterInfo(index);


It returns information about the player of a guild
==Parameters==
 
===Arguments===
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
:;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, 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 ...)
:;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.
:;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 : 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
:;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 : String - Upper-case English classname - localisation independant.
Obsolete
:;achievementPoints : Integer - The guild achievement points of the member
:;group : Boolean ( yes or no ) - Return if this member is in a group (REMOVED IN 1.9)
:;achievementRank : Integer - The guild achievement rank of the member
 
:;isMobile : Boolean - If member is logged on using the mobile armory application
{{Template:WoW API}}
:;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
:

Latest revision as of 04:45, 15 August 2023

← 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, isSoREligible, standingID = GetGuildRosterInfo(index);

Parameters[edit]

Arguments[edit]

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

Returns[edit]

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
Boolean - Whether the player is online
status
Integer (0,1,2) - The availability of the player; Available, Away, Busy
classFileName
String - Upper-case English classname - localisation independant.
achievementPoints
Integer - The guild achievement points of the member
achievementRank
Integer - The guild achievement rank of the member
isMobile
Boolean - If member is logged on using the mobile armory application
isSoREligible
Boolean - is member eligible for Scroll of Resurrection
standingID
Integer StandingId (0-8) - Numeric representation of standing (Neutral, friendly etc) with the guild
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetGuildRosterInfo&oldid=19051"