WoW:API select - Revision history

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

2023-08-15T04:47:14Z

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

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 07:32, 19 September 2013

2013-09-19T07:32:55Z

← Older revision		Revision as of 07:32, 19 September 2013
Line 1:		Line 1:
	{{~~luaapi~~}}		{{wowlua}}
	Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).		Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).
	local ret1, ret2, retN = select(index, list)		local ret1, ret2, retN = select(index, list)
Line 5:		Line 5:
	== Arguments ==		== Arguments ==
	=== Parameters ===		=== Parameters ===
	:;index : Any non-zero number or the string "#".		:;index
	:;list : Usually an ellipsis (...).		:: Any non-zero number or the string "#".
			:;list
			:: Usually an ellipsis (...).

	=== Returns ===		=== Returns ===
	:;retN : The number of items in the list or every value starting from index to the end of the list.		:;retN
			:: The number of items in the list or every value starting from index to the end of the list.

	== Examples ==		== Examples ==
Line 29:		Line 32:

	=== Catenation ===		=== Catenation ===
	select can be used to catenate a vararg list into an array. This is useful for returning info from [[API_GetBinding \| GetBinding]], which returns a vararg list of unknown size.		select can be used to catenate a vararg list into an array. This is useful for returning info from [[API_GetBinding \| GetBinding]], which returns a vararg list of unknown size.

	function MyAddon_Catenate(...)		function MyAddon_Catenate(...)

WoWWiki>Starlightblunder: {{luaapi}}

2010-03-25T23:22:06Z

← Older revision		Revision as of 23:22, 25 March 2010
Line 1:		Line 1:
			{{luaapi}}
	Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).		Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).
	local ret1, ret2, retN = select(index, list)		local ret1, ret2, retN = select(index, list)
Line 57:		Line 58:
	-- number 2		-- number 2
	DEFAULT_CHAT_FRAME:AddMessage(select(1, ...))</pre>		DEFAULT_CHAT_FRAME:AddMessage(select(1, ...))</pre>

	~~{{LUA}}~~

WoWWiki>Egingell: Cleanup

2008-12-18T06:01:08Z

Cleanup

← Older revision		Revision as of 06:01, 18 December 2008
Line 16:		Line 16:

	-- Print all of the function's arguments (those passed to the ellipsis (...) only) to the default chat frame.		-- Print all of the function's arguments (those passed to the ellipsis (...) only) to the default chat frame.
			local msg
	for i = 1, select('#', ...) do		for i = 1, select('#', ...) do
	~~DEFAULT_CHAT_FRAME:AddMessage(~~select(i, ...))		msg = select(i, ...)
			DEFAULT_CHAT_FRAME:AddMessage(msg)
	end		end

Line 29:		Line 31:

	function MyAddon_Catenate(...)		function MyAddon_Catenate(...)
	local t~~,n,i~~,v;		local t,v
			t = {}
	n=select("#",...);		for i = 1, select("#", ...) do
	~~t={};~~		v = select(i, ...)
	~~for i=1,n~~ do		tinsert(t, v)
	v=select(i, ...)~~; -- Have to save to a variable before adding to get each element separately~~		end
	tinsert(t,v);		return t
	end
	return t;
	end		end

Line 49:		Line 49:
	: <pre>select(-1, 1, 2, 3, 4, 5) -- returns 5</pre>		: <pre>select(-1, 1, 2, 3, 4, 5) -- returns 5</pre>
	* A decimal index will be rounded to the nearest integer (1.1 rounds to 1, 1.9 rounds to 2).		* A decimal index will be rounded to the nearest integer (1.1 rounds to 1, 1.9 rounds to 2).
			* Passing a function that returns a list as a parameter to another function will pass each return as a parameter to the function as if you were manually passing each variable to that function, so ''tinsert(tab, select(1, ...))'', will have unpredictable results.
			<pre>-- these are identical
			-- number 1
			local msg, r, g, b, a, id = select(1, ...)
			DEFAULT_CHAT_FRAME:AddMessage(msg, r, g, b, a, id)

	~~== Disclaimer ==~~		-- number 2
	* Tested using the command line. Lua v5.1.2. ~~Not tested in the WoW environment~~.		DEFAULT_CHAT_FRAME:AddMessage(select(1, ...))</pre>

	{{LUA}}		{{LUA}}

WoWWiki>DrDoom: Updated with new information - Added example function

2008-12-18T04:29:45Z

Updated with new information - Added example function

@@ Line 24: / Line 24: @@
   -- b = 'c'
   -- c = nil
 == Notes ==

WoWWiki>Pcj at 00:54, 28 September 2008

2008-09-28T00:54:03Z

← Older revision		Revision as of 00:54, 28 September 2008
Line 1:		Line 1:
	~~{{tocright}}~~
	Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).		Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).
	local ret1, ret2, retN = select(index, list)		local ret1, ret2, retN = select(index, list)

WoWWiki>Wolftankk at 07:51, 17 February 2008

2008-02-17T07:51:25Z

← Older revision		Revision as of 07:51, 17 February 2008
Line 1:		Line 1:
	{{tocright}}		{{tocright}}
	Used to traverse a list. This function is usually used to capture the arguments passed to an ~~ellipse~~ (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).		Used to traverse a list. This function is usually used to capture the arguments passed to an ellipsis (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).
	local ret1, ret2, retN = select(index, list)		local ret1, ret2, retN = select(index, list)

Line 6:		Line 6:
	=== Parameters ===		=== Parameters ===
	:;index : Any non-zero number or the string "#".		:;index : Any non-zero number or the string "#".
	:;list : Usually an ~~ellipse~~ (...).		:;list : Usually an ellipsis (...).

	=== Returns ===		=== Returns ===
Line 13:		Line 13:
	== Examples ==		== Examples ==
	-- Common usage.		-- Common usage.
	local num = select('#', ...) -- Returns the number of arguments in the ~~ellipse~~.		local num = select('#', ...) -- Returns the number of arguments in the ellipsis.
	local arg = select(i, ...) -- Returns the value at index '''i'''.		local arg = select(i, ...) -- Returns the value at index '''i'''.

	-- Print all of the function's arguments (those passed to the ~~ellipse~~ (...) only) to the default chat frame.		-- Print all of the function's arguments (those passed to the ellipsis (...) only) to the default chat frame.
	for i = 1, select('#', ...) do		for i = 1, select('#', ...) do
	DEFAULT_CHAT_FRAME:AddMessage(select(i, ...))		DEFAULT_CHAT_FRAME:AddMessage(select(i, ...))

WoWWiki>Egingell: New page: {{tocright}} Used to traverse a list. This function usually used to capture the arguments passed to an ellipse (...). local num = select('#', ...) -- Returns the number of arguments in th...

2008-01-14T09:59:43Z

New page: {{tocright}} Used to traverse a list. This function usually used to capture the arguments passed to an ellipse (...). local num = select('#', ...) -- Returns the number of arguments in th...

New page

{{tocright}}
Used to traverse a list. This function is usually used to capture the arguments passed to an ellipse (...). The official usage of this function is to return a list (retN) starting from index to the end of the list (list).
local ret1, ret2, retN = select(index, list)

== Arguments ==
=== Parameters ===
:;index : Any non-zero number or the string "#".
:;list : Usually an ellipse (...).

=== Returns ===
:;retN : The number of items in the list or every value starting from index to the end of the list.

== Examples ==
-- Common usage.
local num = select('#', ...) -- Returns the number of arguments in the ellipse.
local arg = select(i, ...) -- Returns the value at index '''i'''.

-- Print all of the function's arguments (those passed to the ellipse (...) only) to the default chat frame.
for i = 1, select('#', ...) do
DEFAULT_CHAT_FRAME:AddMessage(select(i, ...))
end

local a, b, c = select(2, 'a', 'b', 'c')
-- a = 'b'
-- b = 'c'
-- c = nil

== Notes ==
* ''list'' can be value1, value2, value3, ... valueN; although, you will never see it used in that manner since you can just access value1 through valueN directly.
* It is not recommended that you use this method on a table as you would have to pass the table to [[API_unpack|unpack]]() for every call to select (once plus the number of consecutive numeric indexes). For tables, use [[API_pairs|pairs]]() or [[API_ipairs|ipairs]]().
* Indexes beyond the number of list items will return nil.
: <pre>select(6, 'see', 'dog', 'run') -- returns nil</pre>
* An index of 0 will produce an "index out or range" error.
* Negative values wrap to the end of the list.
: <pre>select(-1, 1, 2, 3, 4, 5) -- returns 5</pre>
* A decimal index will be rounded to the nearest integer (1.1 rounds to 1, 1.9 rounds to 2).

== Disclaimer ==
* Tested using the command line. Lua v5.1.2. Not tested in the WoW environment.

{{LUA}}