WoW:API GetGuildInfo - Revision history

Move page script: Move page script moved page API GetGuildInfo to WoW:API GetGuildInfo without leaving a redirect

2023-08-15T04:45:58Z

Move page script moved page API GetGuildInfo to API GetGuildInfo without leaving a redirect

← Older revision	Revision as of 04:45, 15 August 2023
(No difference)

125.178.125.85: /* Returns */

2018-11-02T19:22:21Z

Returns

← Older revision		Revision as of 19:22, 2 November 2018
Line 8:		Line 8:

	===Returns===		===Returns===
	:;guildName : String - The name of the guild the unit is in (or nil?).		:;guildName
	:;guildRankName : String - unit's rank in unit's guild.		:: String - The name of the guild the unit is in (or nil?).
	:;guildRankIndex : Integer - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks)		:;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)
			:;realmName
			:: String - the host realm name for connected realms, otherwise nil (same as player's realm).

	==Details==		==Details==

WoWWiki>Pmcc: Fixed links to GUILD_ROSTER_UPDATE and PLAYER_GUILD_UPDATE events

2009-12-30T17:58:56Z

Fixed links to GUILD_ROSTER_UPDATE and PLAYER_GUILD_UPDATE events

← Older revision		Revision as of 17:58, 30 December 2009
Line 15:		Line 15:
	:*You may use a name in the argument for this function		:*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.		:*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.
	:*If using with [[UnitId]] "player" on loading it happens that this value is nil even if the player is in a guild. I wrote a little function which checks in the [[G#GUILD_ROSTER_UPDATE\|GUILD_ROSTER_UPDATE]] and [[#PLAYER_GUILD_UPDATE\|PLAYER_GUILD_UPDATE]] events, if guild name is available. As long as it is not, no actions are fired by my guild event handling.		:*If using with [[UnitId]] "player" on loading it happens that this value is nil even if the player is in a guild. I wrote a little function which checks in the [[Events/Guild#GUILD_ROSTER_UPDATE\|GUILD_ROSTER_UPDATE]] and [[Events/Guild#PLAYER_GUILD_UPDATE\|PLAYER_GUILD_UPDATE]] events, if guild name is available. As long as it is not, no actions are fired by my guild event handling.

WoWWiki>Sandmahn: /* added details on loading problems */

2009-09-17T17:14:35Z

added details on loading problems

← Older revision		Revision as of 17:14, 17 September 2009
Line 15:		Line 15:
	:*You may use a name in the argument for this function		:*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.		:*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.
			:*If using with [[UnitId]] "player" on loading it happens that this value is nil even if the player is in a guild. I wrote a little function which checks in the [[G#GUILD_ROSTER_UPDATE\|GUILD_ROSTER_UPDATE]] and [[#PLAYER_GUILD_UPDATE\|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 status = true
			if IsInGuild()
			then
			local test = GetGuildInfo("player")
			if (test == nil)
			then
			status = false
			end
			end

			return status

WoWWiki>DrDoom: Added details

2009-07-23T10:31:46Z

Added details

← Older revision		Revision as of 10:31, 23 July 2009
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.

WoWWiki>Curtwulf: Indicated where index began on rank index

2008-06-09T19:02:29Z

Indicated where index began on rank index

← Older revision		Revision as of 19:02, 9 June 2008
Line 9:		Line 9:
	:;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		:;guildRankIndex : Integer - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks)

WoWWiki>Peeka at 22:46, 22 September 2007

2007-09-22T22:46:35Z

← Older revision		Revision as of 22:46, 22 September 2007
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
	Returns guild-related ~~informationa bout~~ a unit.		Returns guild-related information about a unit.
	guildName, guildRankName, guildRankIndex = GetGuildInfo(unit);		guildName, guildRankName, guildRankIndex = GetGuildInfo(unit);

WoWWiki>VelvetPaw: /* Returns */

2006-12-29T19:53:34Z

Returns

← Older revision		Revision as of 19:53, 29 December 2006
Line 9:		Line 9:
	:;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).		:;guildRankIndex : Integer - unit's rank (index). - zero based index

WoWWiki>Starlightblunder: conformist layout

2006-12-24T01:41:51Z

conformist layout

← Older revision		Revision as of 01:41, 24 December 2006
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]]~~

WoWWiki>Fsdfs at 22:05, 18 July 2006

2006-07-18T22:05:30Z

← Older revision		Revision as of 22:05, 18 July 2006
Line 1:		Line 1:
			{{wowapi}}
	=GetGuildInfo(unit)=		=GetGuildInfo(unit)=

Line 7:		Line 8:

	Returns the name of the unit's guild, that unit's rank title in the guild and its rank index.		Returns the name of the unit's guild, that unit's rank title in the guild and its rank index.


	===Example===		===Example===
			local guildName, guildRankName, guildRankIndex = GetGuildInfo("player");

	~~local guildName, guildRankName, guildRankIndex = GetGuildInfo("player");~~

	~~__NOTOC__~~		[[API_PrototypeStyle]]
	~~{{Template:WoW API}}~~