WoW:API IsGuildLeader: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (New page: This function is used to determine if a player is the guild leader. There is a required variable. The variable is the a players name. When the function is run it will return a boolean re...)
 
(This article was poorly written....)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Returns the a boolean value.
  guildmaster = IsGuildMaster("PlayerName")
  TrueFalse = IsGuildLeader("PlayerName");
This function checks to see if 'PlayerName' is the guild master of a guild and returns the appropriate result.


==Parameters==
==Parameters==
===Arguments===
===Arguments===
:;PlayerName : Boolean - Player to check for guild master status?
:;PlayerName : String - The name of the player you are checking.
===Returns===
===Returns===
:;TrueFalse : True is person is Guild Master, False if they are not.
:;guildmaster : True if this person is a guild master, otherwise false.


==Example==
==Example==

Revision as of 15:50, 14 June 2009

WoW API < IsGuildLeader

guildmaster = IsGuildMaster("PlayerName")

This function checks to see if 'PlayerName' is the guild master of a guild and returns the appropriate result.

Parameters

Arguments

PlayerName
String - The name of the player you are checking.

Returns

guildmaster
True if this person is a guild master, otherwise false.

Example

player = UnitName("player");
if (IsGuildLeader(player) == true) then
    DEFAULT_CHAT_FRAME:AddMessage(player.." you are a Guild master");
else
    DEFAULT_CHAT_FRAME:AddMessage(player.." you are not a Guild master");
end

Result

Displays a message stating if your a guild master or not.