WoW:API GetGuildInfo: Difference between revisions
Jump to navigation
Jump to search
m (Indicated where index began on rank index) |
(Added details) |
||
| Line 6: | Line 6: | ||
===Arguments=== | ===Arguments=== | ||
:; unit : [[UnitId]] - The unit whose guild information you wish to query. | :; unit : [[UnitId]] - The unit whose guild information you wish to query. | ||
===Returns=== | ===Returns=== | ||
:;guildName : String - The name of the guild the unit is in (or nil?). | :;guildName : String - The name of the guild the unit is in (or nil?). | ||
:;guildRankName : String - unit's rank in unit's guild. | :;guildRankName : String - unit's rank in unit's guild. | ||
:;guildRankIndex : Integer - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks) | :;guildRankIndex : Integer - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks) | ||
==Details== | |||
:*You may use a name in the argument for this function | |||
:*This function only works in close proximity to the unit you are trying to get info from. I don't know the distance, but it is the same distance that the character portrait loads if you are in party with them. It will abandon the data shortly after you leave the area, even if the portrait is remembered. | |||
Revision as of 10:31, 23 July 2009
← WoW API < GetGuildInfo
Returns guild-related information about a unit.
guildName, guildRankName, guildRankIndex = GetGuildInfo(unit);
Parameters
Arguments
- unit
- UnitId - The unit whose guild information you wish to query.
Returns
- guildName
- String - The name of the guild the unit is in (or nil?).
- guildRankName
- String - unit's rank in unit's guild.
- guildRankIndex
- Integer - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks)
Details
- You may use a name in the argument for this function
- This function only works in close proximity to the unit you are trying to get info from. I don't know the distance, but it is the same distance that the character portrait loads if you are in party with them. It will abandon the data shortly after you leave the area, even if the portrait is remembered.