WoW:API unpack - Revision history

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

2023-08-15T04:47:50Z

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

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 07:34, 19 September 2013

2013-09-19T07:34:58Z

← Older revision		Revision as of 07:34, 19 September 2013
Line 1:		Line 1:
	{{~~luaapi~~}}		{{wowlua}}
	Returns the values in a consecutive-integer indexed table		Returns the values in a consecutive-integer indexed table
	ret1, ret2, ... retN = unpack(table[, start [, end]])		ret1, ret2, ... retN = unpack(table[, start [, end]])

	Will not return values with hash style indexes. For example:		Will not return values with hash style indexes. For example:
	local t = {1, "two", "3", x = "ecks", y = "why?"}		local t = {1, "two", "3", x = "ecks", y = "why?"}
	unpack(t) -- returns: 1, "two", "3"		unpack(t) -- returns: 1, "two", "3"

	== Arguments ==		== Arguments ==
	;table: (table) - A table		;table
	;start: Integer - Starting index, defaults to 1 if nil		: (table) - A table
	;end: Integer - Ending index, appends nil values if the table does not contain enough		;start
			: Integer - Starting index, defaults to 1 if nil
			;end
			: Integer - Ending index, appends nil values if the table does not contain enough

	=== Returns ===		=== Returns ===
	;ret1, ret2, ... retN : A list of the values contained in the given table.		;ret1, ret2, ... retN
			: A list of the values contained in the given table.

	== Examples ==		== Examples ==

WoWWiki>Starlightblunder: {{luaapi}}

2010-03-25T23:10:07Z

← Older revision		Revision as of 23:10, 25 March 2010
Line 1:		Line 1:
	{{~~tocright~~}}		{{luaapi}}
	Returns the values in a consecutive-integer indexed table		Returns the values in a consecutive-integer indexed table
	ret1, ret2, ... retN = unpack(table[, start][, end])		ret1, ret2, ... retN = unpack(table[, start [, end]])

	Will not return values with hash style indexes. For example:		Will not return values with hash style indexes. For example:
Line 8:		Line 8:

	== Arguments ==		== Arguments ==
	~~=== Parameters ===~~		;table: (table) - A table
	:;table: (table) - A table		;start: Integer - Starting index, defaults to 1 if nil
	:;start: Integer - Starting index, defaults to 1 if nil		;end: Integer - Ending index, appends nil values if the table does not contain enough
	:;end: Integer - Ending index, appends nil values if the table does not contain enough

	=== Returns ===		=== Returns ===
	:;ret1, ret2, ... retN: A list of the values contained in the given table.		;ret1, ret2, ... retN : A list of the values contained in the given table.

	== Examples ==		== Examples ==
Line 46:		Line 45:
	t[5] = 1		t[5] = 1
	print(unpack(t)) -- prints 1 even though it's the same contents as in Notes Example 2.		print(unpack(t)) -- prints 1 even though it's the same contents as in Notes Example 2.

	~~{{LUA}}~~

WoWWiki>Egingell: /* Notes */ I R has gud grammar...

2009-11-27T08:11:18Z

Notes: I R has gud grammar...

← Older revision		Revision as of 08:11, 27 November 2009
Line 25:		Line 25:

	== Notes ==		== Notes ==
	~~Unpack~~() ~~appears to be buggy when dealing with multiple nil~~ values ~~and~~ the ~~last value~~ is ~~nil~~.		unpack() doesn't return all the values in the following example because it is not a contiguous table.
	t = {1,nil,"something",nil)		-- Notes Example 1
	~~x1,x2,x3,x4 =~~ unpack(t) -- ~~returns~~ 1~~,nil~~		t = {1,nil,"something",nil}
			print(unpack(t)) -- prints 1

	A simple fix ~~that~~ works ~~could be~~ adding ~~an empty value~~.		A simple fix would be to add a value at the end of the list. This works because when you assign a table in this manner, Lua treats it as a contiguous table as long as there is a value at the last index. Nuking this value before adding new values at the end will break this behavior.
	t = {1,nil,"something",nil,1)		-- Notes Example 2
	~~x1,x2,x3,x4~~ = unpack(t) -- ~~returns~~ 1,nil,"something",nil		t = {1,nil,"something",nil,1}
			print(unpack(t)) -- prints 1 nil "something" nil 1
			t[5] = nil
			print(unpack(t)) -- prints 1

			If you assign each value individually, unpack() will behave the same way it does in Notes Example 1.
			-- Notes Example 3
			t = {}
			t[1] = 1
			t[2] = nil
			t[3] = "something"
			t[4] = nil
			t[5] = 1
			print(unpack(t)) -- prints 1 even though it's the same contents as in Notes Example 2.

	~~--Peeka, sentinels~~
	{{LUA}}		{{LUA}}

WoWWiki>Hans Kamp: /* Notes */ I think only the first 4 values will be assigned to x1, x2, x3 and x4.

2009-11-27T06:27:08Z

Notes: I think only the first 4 values will be assigned to x1, x2, x3 and x4.

← Older revision		Revision as of 06:27, 27 November 2009
Line 31:		Line 31:
	A simple fix that works could be adding an empty value.		A simple fix that works could be adding an empty value.
	t = {1,nil,"something",nil,1)		t = {1,nil,"something",nil,1)
	x1,x2,x3,x4 = unpack(t) -- returns 1,nil,"something",nil,1		x1,x2,x3,x4 = unpack(t) -- returns 1,nil,"something",nil

	--Peeka, sentinels		--Peeka, sentinels
	{{LUA}}		{{LUA}}

WoWWiki>Peeka at 05:27, 27 November 2009

2009-11-27T05:27:39Z

← Older revision		Revision as of 05:27, 27 November 2009
Line 24:		Line 24:
	unpack({1,2,3,4,5},2,7) -- returns 2, 3, 4, 5, nil, nil		unpack({1,2,3,4,5},2,7) -- returns 2, 3, 4, 5, nil, nil

			== Notes ==
			Unpack() appears to be buggy when dealing with multiple nil values and the last value is nil.
			t = {1,nil,"something",nil)
			x1,x2,x3,x4 = unpack(t) -- returns 1,nil

			A simple fix that works could be adding an empty value.
			t = {1,nil,"something",nil,1)
			x1,x2,x3,x4 = unpack(t) -- returns 1,nil,"something",nil,1

			--Peeka, sentinels
	{{LUA}}		{{LUA}}

WoWWiki>Mecdemort at 00:39, 17 September 2009

2009-09-17T00:39:20Z

← Older revision		Revision as of 00:39, 17 September 2009
Line 1:		Line 1:
	{{tocright}}		{{tocright}}
	Returns the values in a consecutive-integer indexed table		Returns the values in a consecutive-integer indexed table
	ret1, ret2, ... retN = unpack(table)		ret1, ret2, ... retN = unpack(table[, start][, end])

	Will not return values with hash style indexes. For example:		Will not return values with hash style indexes. For example:
Line 10:		Line 10:
	=== Parameters ===		=== Parameters ===
	:;table: (table) - A table		:;table: (table) - A table
			:;start: Integer - Starting index, defaults to 1 if nil
			:;end: Integer - Ending index, appends nil values if the table does not contain enough

	=== Returns ===		=== Returns ===
Line 19:		Line 21:
	-- This does the same thing:		-- This does the same thing:
	local arg1, arg2, arg3 = 1, 5, "Hearthstone"		local arg1, arg2, arg3 = 1, 5, "Hearthstone"

			unpack({1,2,3,4,5},2,7) -- returns 2, 3, 4, 5, nil, nil

	{{LUA}}		{{LUA}}

WoWWiki>Tekkub at 08:44, 18 July 2007

2007-07-18T08:44:45Z

← Older revision		Revision as of 08:44, 18 July 2007
Line 1:		Line 1:
	{{tocright}}		{{tocright}}
	Returns the values in a table ~~as a list~~		Returns the values in a consecutive-integer indexed table
	ret1, ret2, ... retN = unpack(table);		ret1, ret2, ... retN = unpack(table)

			Will not return values with hash style indexes. For example:
			local t = {1, "two", "3", x = "ecks", y = "why?"}
			unpack(t) -- returns: 1, "two", "3"

	== Arguments ==		== Arguments ==
Line 11:		Line 15:

	== Examples ==		== Examples ==
	local arg1, arg2, arg3 = unpack(		local arg1, arg2, arg3 = unpack({1, 5, "Hearthstone"})
	{
	1,
	5,
	"Hearthstone"
	}
	);

	-- This does the same thing:		-- This does the same thing:
	local arg1, arg2, arg3 = 1, 5, "Hearthstone";		local arg1, arg2, arg3 = 1, 5, "Hearthstone"

	~~-- As does this:~~
	~~local arg1 = 1;~~
	~~local arg2 = 5;~~
	~~local arg3 = "Hearthstone";~~

	{{LUA}}		{{LUA}}

WoWWiki>Egingell: It's new

2007-07-16T04:28:29Z

It's new

New page

{{tocright}}
Returns the values in a table as a list
ret1, ret2, ... retN = unpack(table);

== Arguments ==
=== Parameters ===
:;table: (table) - A table

=== Returns ===
:;ret1, ret2, ... retN: A list of the values contained in the given table.

== Examples ==
local arg1, arg2, arg3 = unpack(
{
1,
5,
"Hearthstone"
}
);

-- This does the same thing:
local arg1, arg2, arg3 = 1, 5, "Hearthstone";

-- As does this:
local arg1 = 1;
local arg2 = 5;
local arg3 = "Hearthstone";

{{LUA}}