Talidan at 20:29, 23 September 2016

2016-09-23T20:29:22Z

← Older revision		Revision as of 20:29, 23 September 2016
Line 30:		Line 30:
	==Code==		==Code==
	<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"~~ lang="lua">		<syntaxhighlight lang="lua">
	-- modifiers: v - verbose (all subtables), n - normal, s - silent (no output), dx - up to depth x, u - unnamed		-- modifiers: v - verbose (all subtables), n - normal, s - silent (no output), dx - up to depth x, u - unnamed
	function var_dump(...)		function var_dump(...)
Line 162:		Line 162:
	<section name="Serverside Example" class="server" show="true">		<section name="Serverside Example" class="server" show="true">
	Get a table of all players on the server (if there are 4 players).		Get a table of all players on the server (if there are 4 players).
	<syntaxhighlight ~~lang="lua"~~ lang="lua">		<syntaxhighlight lang="lua">
	var_dump(getElementsByType("player"))		var_dump(getElementsByType("player"))
	</syntaxhighlight>		</syntaxhighlight>

Norby89: minor typo

2009-12-23T10:02:39Z

minor typo

← Older revision		Revision as of 10:02, 23 December 2009
Line 180:		Line 180:
	</syntaxhighlight>		</syntaxhighlight>

	Now another table we created before (please ~~not~~ that the table 'test2' is both key and value in this example):		Now another table we created before (please note that the table 'test2' is both key and value in this example):
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	test = {hello="test"}		test = {hello="test"}

Driver2 at 20:53, 5 November 2009

2009-11-05T20:53:40Z

← Older revision		Revision as of 20:53, 5 November 2009
Line 2:		Line 2:
	<lowercasetitle>var_dump</lowercasetitle>		<lowercasetitle>var_dump</lowercasetitle>
	__NOTOC__		__NOTOC__
	This function outputs information about one or more variables.		This function outputs information about one or more variables using outputConsole().

	==Syntax==		==Syntax==

Driver2: Created page with '{{Useful Function}} var_dump NOTOC This function outputs information about one or more variables. ==Syntax== string/table var_d…'

2009-11-05T20:51:49Z

Created page with '{{Useful Function}} <lowercasetitle>var_dump</lowercasetitle> __NOTOC__ This function outputs information about one or more variables. ==Syntax== <syntaxhighlight lang="lua">string/table var_d…'

New page

{{Useful Function}}
<lowercasetitle>var_dump</lowercasetitle>
__NOTOC__
This function outputs information about one or more variables.

==Syntax==
<syntaxhighlight lang="lua">string/table var_dump( ... )</syntaxhighlight>

===Arguments===
The function can have a variable number of arguments. Those arguments can be of three types:
* '''Modifiers:''' A ''string'' that begins with a "-" (minus) and that is followed by at least another parameter is a modifier. A modifier can change the behaviour of the function. Modifiers don't have to be the first argument, they always work on all arguments after it (see examples).
* '''Names:''' A ''string'' that is followed by at least another parameter and isn't preceeded by another ''string'' (that is not a modifier), is a name. A name is output before the variable output, to make it recognizable (basicially a description of the variable that is being output, e.g. the name).
* '''Values:''' Any value that is not one of the two above will generate an output with information about the variable:
** For ''strings'': string(''lengthOfString'') "''value''"
** For ''userdata'': userdata(''MTA element type'') "''value''"
** For ''tables'': table(''numerOfElements'') "''value''"
*** If the table contains any elements, they will also be output if the appropriate modifiers are set. This will always be in the form [''key''] => ''value'', while ''key'' and ''value'' are formatted by var_dump.

===Modifiers===
* '''v''' (verbose): Dumps more data than usual (for now it outputs whole tables including subtables)
* '''n''' (normal): Switches back into 'normal' non-verbose mode.
* '''s''' (silent): With this activated, it outputs nothing at all, however it still returns the output, so you can use it yourself (also used internally for recursion).
* '''u''' (unnamed): Don't use names. Every ''string'' that is not a modifier will be output as a value, not a decription.
* '''d[number]''' (depth): Output nested tables up to this depth (e.g. "d1" means output all values of the initial table, but not the values of the values, if they are also tables).

===Returns===
Returns a string with all the output in one line and a table with several lines of output.

==Code==
<section name="Server- and/or clientside Script" class="both" show="true">
<syntaxhighlight lang="lua" lang="lua">
-- modifiers: v - verbose (all subtables), n - normal, s - silent (no output), dx - up to depth x, u - unnamed
function var_dump(...)
-- default options
local verbose = false
local firstLevel = true
local outputDirectly = true
local noNames = false
local indentation = "\t\t\t\t\t\t"
local depth = nil

local name = nil
local output = {}
for k,v in ipairs(arg) do
-- check for modifiers
if type(v) == "string" and k < #arg and v:sub(1,1) == "-" then
local modifiers = v:sub(2)
if modifiers:find("v") ~= nil then
verbose = true
end
if modifiers:find("s") ~= nil then
outputDirectly = false
end
if modifiers:find("n") ~= nil then
verbose = false
end
if modifiers:find("u") ~= nil then
noNames = true
end
local s,e = modifiers:find("d%d+")
if s ~= nil then
depth = tonumber(string.sub(modifiers,s+1,e))
end
-- set name if appropriate
elseif type(v) == "string" and k < #arg and name == nil and not noNames then
name = v
else
if name ~= nil then
name = ""..name..": "
else
name = ""
end

local o = ""
if type(v) == "string" then
table.insert(output,name..type(v).."("..v:len()..") \""..v.."\"")
elseif type(v) == "userdata" then
local elementType = "no valid MTA element"
if isElement(v) then
elementType = getElementType(v)
end
table.insert(output,name..type(v).."("..elementType..") \""..tostring(v).."\"")
elseif type(v) == "table" then
local count = 0
for key,value in pairs(v) do
count = count + 1
end
table.insert(output,name..type(v).."("..count..") \""..tostring(v).."\"")
if verbose and count > 0 and (depth == nil or depth > 0) then
table.insert(output,"\t{")
for key,value in pairs(v) do
-- calls itself, so be careful when you change anything
local newModifiers = "-s"
if depth == nil then
newModifiers = "-sv"
elseif depth > 1 then
local newDepth = depth - 1
newModifiers = "-svd"..newDepth
end
local keyString, keyTable = var_dump(newModifiers,key)
local valueString, valueTable = var_dump(newModifiers,value)

if #keyTable == 1 and #valueTable == 1 then
table.insert(output,indentation.."["..keyString.."]\t=>\t"..valueString)
elseif #keyTable == 1 then
table.insert(output,indentation.."["..keyString.."]\t=>")
for k,v in ipairs(valueTable) do
table.insert(output,indentation..v)
end
elseif #valueTable == 1 then
for k,v in ipairs(keyTable) do
if k == 1 then
table.insert(output,indentation.."["..v)
elseif k == #keyTable then
table.insert(output,indentation..v.."]")
else
table.insert(output,indentation..v)
end
end
table.insert(output,indentation.."\t=>\t"..valueString)
else
for k,v in ipairs(keyTable) do
if k == 1 then
table.insert(output,indentation.."["..v)
elseif k == #keyTable then
table.insert(output,indentation..v.."]")
else
table.insert(output,indentation..v)
end
end
for k,v in ipairs(valueTable) do
if k == 1 then
table.insert(output,indentation.." => "..v)
else
table.insert(output,indentation..v)
end
end
end
end
table.insert(output,"\t}")
end
else
table.insert(output,name..type(v).." \""..tostring(v).."\"")
end
name = nil
end
end
local string = ""
for k,v in ipairs(output) do
if outputDirectly then
outputConsole(v)
end
string = string..v
end
return string, output
end
</syntaxhighlight>
</section>

==Example==
<section name="Serverside Example" class="server" show="true">
Get a table of all players on the server (if there are 4 players).
<syntaxhighlight lang="lua" lang="lua">
var_dump(getElementsByType("player"))
</syntaxhighlight>
Output:
<syntaxhighlight lang="lua">
table(4) "table: 02998058"
</syntaxhighlight>
With 'verbose' modifier.
<syntaxhighlight lang="lua">
var_dump("-v",getElementsByType("player"))
</syntaxhighlight>
<syntaxhighlight lang="lua">
table(1) "table: 043C6900"
{
[number "1"] => userdata(player) "userdata: 00000134"
}
</syntaxhighlight>

Now another table we created before (please not that the table 'test2' is both key and value in this example):
<syntaxhighlight lang="lua">
test = {hello="test"}
test2 = {"haha","naja"}
test[test2] = test2
var_dump("-v",getElementsByType("player"),test)
</syntaxhighlight>

<syntaxhighlight lang="lua">
table(1) "table: 020B7838"
{
[number "1"] => userdata(player) "userdata: 00000134"
}
table(2) "table: 021770A0"
{
[string(5) "hello"] => string(4) "test"
[table(2) "table: 02313070"
{
[number "1"] => string(4) "haha"
[number "2"] => string(4) "naja"
}]
=> table(2) "table: 02313070"
{
[number "1"] => string(4) "haha"
[number "2"] => string(4) "naja"
}
}
</syntaxhighlight>

The same as before, but now with a modifier to output the second table 'normal':
<syntaxhighlight lang="lua">
test = {hello="test"}
test2 = {"haha","naja"}
test[test2] = test2
var_dump("-v",getElementsByType("player"),"-n",test)
</syntaxhighlight>

<syntaxhighlight lang="lua">
table(1) "table: 01BB9030"
{
[number "1"] => userdata(player) "userdata: 00000134"
}
table(2) "table: 0223B2D8"
</syntaxhighlight>

The same as before, but now with a modifier to output the second table only to depth 1 (the verbose is still active from the first argument):
<syntaxhighlight lang="lua">
test = {hello="test"}
test2 = {"haha","naja"}
test[test2] = test2
var_dump("-v",getElementsByType("player"),"-d1",test)
</syntaxhighlight>

<syntaxhighlight lang="lua">
table(1) "table: 029BE6E8"
{
[number "1"] => userdata(player) "userdata: 00000134"
}
table(2) "table: 01E2CDF8"
{
[string(5) "hello"] => string(4) "test"
[table(2) "table: 021C6378"] => table(2) "table: 021C6378"
}
</syntaxhighlight>

The same as before, but now with names to make clear which output belongs to which variable (of course in this small example, it's not really needed):
<syntaxhighlight lang="lua">
test = {hello="test"}
test2 = {"haha","naja"}
test[test2] = test2
var_dump("-v","players",getElementsByType("player"),"-d1","test tables",test)
</syntaxhighlight>

<syntaxhighlight lang="lua">
players: table(1) "table: 0219F4D0"
{
[number "1"] => userdata(player) "userdata: 00000134"
}
test tables: table(2) "table: 0219DB20"
{
[string(5) "hello"] => string(4) "test"
[table(2) "table: 01B68048"] => table(2) "table: 01B68048"
}
</syntaxhighlight>

The same as before, but now 'unnamed', meaning all values that are not modifiers will be output as values. However, the last two arguments were also removed, which leaves the last modifier as last argument, which will output the modifier as a normal value:
<syntaxhighlight lang="lua">
var_dump("-u","players",getElementsByType("player"),"-d1")
</syntaxhighlight>

<syntaxhighlight lang="lua">
string(7) "players"
table(1) "table: 028B8A10"
string(3) "-d1"
</syntaxhighlight>

</section>

==See Also==
{{Useful_Functions}}

Var dump - Revision history

Talidan at 20:29, 23 September 2016

Norby89: minor typo

Driver2 at 20:53, 5 November 2009

Driver2: Created page with '{{Useful Function}} var_dump __NOTOC__ This function outputs information about one or more variables. ==Syntax== string/table var_d…'

Driver2: Created page with '{{Useful Function}} var_dump NOTOC This function outputs information about one or more variables. ==Syntax== string/table var_d…'