Cloning Tables

5 min

Sometimes it’s useful to be able to copy or “clone” a table. Lua provides no built-in function to copy tables, but the following methods can help.

Shallow Copies

A “shallow copy” is useful for copying a table that’s one level deep — meaning, a basic array or dictionary table without any nested tables inside it.

Dictionaries

A dictionary table can be shallow copied by looping over the original table’s keys using pairs and assigning them to another table:

				
					Shallow Copy Dictionary Table
				
					Expected Output
				
					Expand
					
			local function shallowCopy(original)
	local copy = {}
	for key, value in pairs(original) do
		copy[key] = value
	end
	return copy
end
		
				Copy Code
			
				Light Theme

In practice, the copy can be made as follows:

				
					Shallow Copy Dictionary Table
				
					Expected Output
				
					Expand
					
			local original = {
	key = "value",
	engine = "Roblox",
	playerID = 505306092
}
local clone = shallowCopy(original)

for key, value in pairs(clone) do
	print(key, value)
end
		
			playerID 505306092
key value
engine Roblox
		
				Copy Code
			
				Light Theme

Arrays

For arrays, the Lua unpack() function can do most of the work:

				
					Shallow Copy Array
				
					Expected Output
				
					Expand
					
			local original = {1, 3, 5, 7, 9}
local clone = {unpack(original)}

for i = 1, #clone do
	print(clone[i])
end
		
			1
3
5
7
9
		
				Copy Code
			
				Light Theme

In Roblox, this only works for arrays up to 7999 items due to tuple behavior.

Deep Copies

Sometimes a shallow copy isn’t enough. Tables with nested tables inside it must be copied with a recursive function:

				
					Deep Copy
				
					Expected Output
				
					Expand
					
			local function deepCopy(original)
	local copy = {}
	for k, v in pairs(original) do
		if type(v) == "table" then
			v = deepCopy(v)
		end
		copy[k] = v
	end
	return copy
end
		
				Copy Code
			
				Light Theme

With the function in place, a deep copy can be made as follows:

				
					Deep Copy
				
					Expected Output
				
					Expand
					
			local original = {
	key = "value",
	playerInfo = {
		playerID = 505306092,
		playerName = "IgnisRBX"
	},
	otherInfo = {
		{
			{1, 3, 5, 7, 9}
		}
	}
}
local clone = deepCopy(original)

print(clone["playerInfo"]["playerID"])
print(clone["otherInfo"][1][1][4])
		
			505306092
7
		
				Copy Code
			
				Light Theme

Tags:

cloning
tables

Cloning Tables

Cloning Tables

Shallow Copies

Dictionaries

Arrays

Deep Copies

Related Articles

Tables