WoW:USERAPI GuildNameToIndex - Revision history

Move page script: Move page script moved page USERAPI GuildNameToIndex to WoW:USERAPI GuildNameToIndex without leaving a redirect

2023-08-15T04:49:12Z

Move page script moved page USERAPI GuildNameToIndex to USERAPI GuildNameToIndex without leaving a redirect

← Older revision

Revision as of 04:49, 15 August 2023

Bear at 07:43, 18 May 2020

2020-05-18T07:43:02Z

← Older revision		Revision as of 07:43, 18 May 2020
Line 1:		Line 1:
	{{userfunc}} ~~<!-- Leave this line 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.		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.

Line 31:		Line 30:
	end		end
	</pre>		</pre>

	~~__NOTOC__~~

WoWWiki>Tekkub at 21:09, 22 June 2009

2009-06-22T21:09:08Z

← Older revision		Revision as of 21:09, 22 June 2009
Line 3:		Line 3:
	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.		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.

	~~''<PREFIX>''_GuildNameToIndex~~(name [, searchOffline])		GuildNameToIndex(name [, searchOffline])

	== Function Parameters ==		== Function Parameters ==
	=== Arguments ===		=== Arguments ===

	:;name: String - The name of the player to search for. ~~Is case~~-insensitive.		:;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'''.		:;searchOffline: Boolean - Whether to search the offline players for this player. Default is '''false'''.

	=== Returns ===		=== Returns ===

	:;index: Number - A number between 1 and the size of the guild (inclusive) if the player is found. 0 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 "")		:;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 ==		== Example ==
	~~''<PREFIX>''_GuildNameToIndex~~("bob")		local bob_i = GuildNameToIndex("bob")
	~~''<PREFIX>''_GuildNameToIndex~~("bob", true)		local offline_bob_i = GuildNameToIndex("bob", true)

	==Code==		==Code==

	<pre>		<pre>
	local function ~~<PREFIX>_GuildNameToIndex~~(name, searchOffline)		local function GuildNameToIndex(name, searchOffline)
	~~local index~~ = ~~GetNumGuildMembers~~(~~searchOffline or false~~);		name = string.lower(name)
	~~while~~(~~index~=0~~) do		for i = 1,GetNumGuildMembers(searchOffline) do
	~~local gName = GetGuildRosterInfo(index);~~		if string.lower((GetGuildRosterInfo(i))) == name then
	if( string.lower(~~gName~~) == ~~string.lower(~~name~~) )~~ then		return i
	return ~~index;~~		end
	end		end
	~~index = index - 1;~~
	end
	~~return 0;~~
	end		end
	</pre>		</pre>

	__NOTOC__		__NOTOC__
	~~[[Category:User defined functions]]~~

WoWWiki>Condo2k4: Created page with '{{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...'

2009-06-22T11:36:11Z

Created page with '{{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...'

New page

{{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.

''<PREFIX>''_GuildNameToIndex(name [, searchOffline])

== Function Parameters ==
=== Arguments ===

:;name: String - The name of the player to search for. Is 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. 0 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 "")

== Example ==
''<PREFIX>''_GuildNameToIndex("bob")
''<PREFIX>''_GuildNameToIndex("bob", true)

==Code==

<pre>
local function <PREFIX>_GuildNameToIndex(name, searchOffline)
local index = GetNumGuildMembers(searchOffline or false);
while(index~=0) do
local gName = GetGuildRosterInfo(index);
if( string.lower(gName) == string.lower(name) ) then
return index;
end
index = index - 1;
end
return 0;
end
</pre>

__NOTOC__
[[Category:User defined functions]]