WoW:API GetGuildRosterInfo: Difference between revisions
Jump to navigation
Jump to search
({{wowapi}}, format) |
m (linebreaks are good) |
||
Line 1: | Line 1: | ||
{{wowapi}} __NOTOC__ | {{wowapi}} __NOTOC__ | ||
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, officernote, online, status = GetGuildRosterInfo(index); | name, rank, rankIndex, level, class, zone, note, | ||
officernote, online, status = GetGuildRosterInfo(index); | |||
==Parameters== | ==Parameters== |
Revision as of 06:27, 2 May 2008
← WoW API < GetGuildRosterInfo
Returns information about the player in the guild roster.
name, rank, rankIndex, level, class, zone, note, officernote, online, status = 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)