Open main menu
Home
Random
Log in
Settings
About AddOn Studio
Disclaimers
AddOn Studio
Search
Editing
WoW:USERAPI GuildNameToIndex
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{userfunc}} A simple function that takes a players name and returns their index within the currently stored Guild Roster. Note that the index for a player in each Guild Roster will depend on how it is sorted and can be different from player to player. The index only remains constant between all calls to [[API GuildRoster|GuildRoster]]() and local to each machine. GuildNameToIndex(name [, searchOffline]) == Function Parameters == === Arguments === :;name: String - The name of the player to search for. Case-insensitive. :;searchOffline: Boolean - Whether to search the offline players for this player. Default is '''false'''. === Returns === :;index: Number - A number between 1 and the size of the guild (inclusive) if the player is found. Nil if they are not found. Note, most predefined guild functions do not error if passed an index of 0 and will return a null result (such a nil, 0, false or ""), however it is best you check for a return value before calling them (use better coding standards than Blizzard did!) == Example == local bob_i = GuildNameToIndex("bob") local offline_bob_i = GuildNameToIndex("bob", true) ==Code== <pre> local function GuildNameToIndex(name, searchOffline) name = string.lower(name) for i = 1,GetNumGuildMembers(searchOffline) do if string.lower((GetGuildRosterInfo(i))) == name then return i end end end </pre>
Summary:
Please note that all contributions to AddOn Studio are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see
AddOn Studio Wiki:Copyrights
for details).
Submissions must be written by you, or copied from a public domain or similar free resource (see
AddOn Studio Wiki:Copyrights
for details).
Cancel
Editing help
(opens in new window)
Templates used on this page:
Template:Apinav
(
edit
)
Template:Editlink
(
edit
)
Template:Notebox
(
edit
)
Template:Userfunc
(
edit
)