API GetGuildInfo

From Wowpedia
Jump to: navigation, search

Returns guild-related information about a unit.

guildName, guildRankName, guildRankIndex, realm = 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)
realm
String - The name of the realm the guild is in. returns nil if the guild's realm is the same as your current realm

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. 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.
  • If using with UnitId "player" on loading it happens that this value is nil even if the player is in a guild. Here's a little function which checks in the GUILD_ROSTER_UPDATE and PLAYER_GUILD_UPDATE events, if guild name is available. As long as it is not, no actions are fired by my guild event handling.
local function IsPlayerInGuild()
    return IsInGuild() and GetGuildInfo("player")
end