Alvesvin: /* Example */

2021-08-12T22:39:32Z

Example

← Older revision		Revision as of 22:39, 12 August 2021
Line 54:		Line 54:
	<section name="Server- and/or clientside Script" class="both" show="true">		<section name="Server- and/or clientside Script" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table.deepmerge(		local result = table.deepmerge(
	{ a = 3 }, -- 'from'		{ a = 3 }, -- 'from'
	{ b = { c = 3 } } -- 'to'		{ b = { c = 3 } } -- 'to'
	)		)

			outputDebugString(inspect(result))
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Alvesvin: Created page with "{{Useful Function}} NOTOC This function deep merges two tables. Every nested table will be correspondingly merged. ==Syntax==
2021-08-12T22:10:44Z

Created page with "{{Useful Function}} <lowercasetitle></lowercasetitle> NOTOC This function deep merges two tables. Every nested table will be correspondingly merged. ==Syntax== <syntaxhig..."

New page
{{Useful Function}}
<lowercasetitle></lowercasetitle>
NOTOC
This function deep merges two tables. Every nested table will be correspondingly merged.

==Syntax==
<syntaxhighlight lang="lua">table table.deepmerge( table from, table to[, table options] )</syntaxhighlight>

===Required Arguments===
* '''from''': The table which will be modified.
* '''to''': The table with new values.

===Optional Arguments===
* '''options''': A table of options. Possible options are:
** '''allowNew''': Allows previously nonexistent values to be created. If table '''to''' includes some key not defined in table '''from''' you can choose to include it in the result table. Default is true.

===Returns===
Returns the '''from''' table merged with '''to''' table.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
function table.deepmerge(from, to, options)
options = type(options) == "table" and options or { allowNew = true }
from = type(from) == "table" and from or {}
to = type(to) == "table" and to or {}

local result = from

for key, value in pairs(to) do
local from_type = type(from[key])
local to_type = type(value)

if (from_type == "nil" and not options.allowNew) and -- It's okay to merge previous nonexistent values if 'allowNew' is specified
from_type ~= to_type
then
error(string.format("'table.deepmerge' failed to merge incompatible types from '%s' to '%s' on key '%s'", from_type, to_type, key))
end

if to_type == "table" then
result[key] = table.deepmerge(from[key], value)
else
result[key] = to[key]
end
end

return result
end
</syntaxhighlight>
</section>

==Example==
Merges two tables allowing new values
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
table.deepmerge(
{ a = 3 }, -- 'from'
{ b = { c = 3 } } -- 'to'
)
</syntaxhighlight>
</section>

Try to merge two tables but result in an error since key '''b''' doesn't exist in table '''from'''
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua">
table.deepmerge(
{ a = 3 }, -- 'from'
{ b = { c = 3 } }, -- 'to'
{ allowNew = false }
)
</syntaxhighlight>
</section>

'''Hint''': This function can be useful for ensuring default values in a table

Author: Alvesvin

==See Also==
{{Useful_Functions}}