WoW:API GetGuildInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
(conformist layout)
Line 1: Line 1:
{{wowapi}}
{{wowapi}} __NOTOC__
=GetGuildInfo(unit)=
Returns guild-related informationa bout a unit.
guildName, guildRankName, guildRankIndex = GetGuildInfo(unit);


===Usage===
==Parameters==
guildName, guildRankName, guildRankIndex = GetGuildInfo(unit);
===Arguments===
 
:; unit : [[UnitId]] - The unit whose guild information you wish to query.
===Description===
===Returns===
 
:;guildName : String - The name of the guild the unit is in (or nil?).
Returns the name of the unit's guild, that unit's rank title in the guild and its rank index.
:;guildRankName : String - unit's rank in unit's guild.
 
:;guildRankIndex : Integer - unit's rank (index).
 
===Example===
local guildName, guildRankName, guildRankIndex = GetGuildInfo("player");
 
 
[[API_PrototypeStyle]]

Revision as of 01:41, 24 December 2006

WoW API < GetGuildInfo

Returns guild-related informationa bout 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).