Inspect - Revision history

Qaisjp: specify that return value _could_ change if we updated inspect

2020-01-29T22:04:22Z

specify that return value _could_ change if we updated inspect

← Older revision		Revision as of 22:04, 29 January 2020
Line 15:		Line 15:

	===Returns===		===Returns===
	Always returns a string.		Always returns a string. The contents can change if we update the inspect library, so it is not expected to be consistent across Lua versions.

	==Example==		==Example==

Pirulax: /* Example */

2018-02-07T21:12:24Z

Example

← Older revision		Revision as of 21:12, 7 February 2018
Line 25:		Line 25:
	["localplayer"] = getPlayerName(localPlayer),		["localplayer"] = getPlayerName(localPlayer),
	}		}
			local inspectedTblStr = inspect(Table)

	addEventHandler("onClientRender",root,		addEventHandler("onClientRender",root,
	function( )		function( )
	dxDrawText(~~inspect(Table)~~,10,250)		--> then draw the created string.
			--> Try to NOT use such functions under onClientRender, since it works with loops, and if we want to print a bigger table, it will drop some frames.
			dxDrawText(inspectedTblStr,10,250)
	end		end
	)		)

Wherry: /* Syntax */

2017-12-08T12:06:14Z

Syntax

← Older revision		Revision as of 12:06, 8 December 2017
Line 7:		Line 7:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	string inspect ( mixed var )		string inspect ( mixed var [, table options] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''var:''' A variable of any datatype.		*'''var:''' A variable of any datatype.
			*'''options:''' A table of options. It is not mandatory, but when it is provided, it must be a table. For a list of options, see the [https://github.com/kikito/inspect.lua#options Inspect's GitHub page].

	===Returns===		===Returns===

Loki: added image to example

2016-12-17T19:52:05Z

added image to example

← Older revision		Revision as of 19:52, 17 December 2016
Line 31:		Line 31:
	)		)
	</syntaxhighlight>		</syntaxhighlight>
	An example of what it should ~~draw~~:		This is an example of what it should look like:
	~~<pre>~~		[[File:InspectReturn.png\|frame\|none]]
	{
	~~localplayer = "Loki",~~
	~~matrix= {~~
	~~position = { 2496.3908691406, -1669.853515625, 13.335947036743 },~~
	~~rotation = { -0, 0, 155~~.~~4147644043 }~~
	}
	}
	~~</pre>~~
	</section>		</section>

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

Loki: /* Example */

2016-12-15T18:41:59Z

Example

← Older revision		Revision as of 18:41, 15 December 2016
Line 21:		Line 21:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local Table = {		local Table = {
	["~~position~~"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},		["matrix"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},
	["localplayer"] = getPlayerName(localPlayer),		["localplayer"] = getPlayerName(localPlayer),
	}		}
Line 35:		Line 35:
	{		{
	localplayer = "Loki",		localplayer = "Loki",
	~~position~~ = {		matrix= {
	position = { 2496.3908691406, -1669.853515625, 13.335947036743 },		position = { 2496.3908691406, -1669.853515625, 13.335947036743 },
	rotation = { -0, 0, 155.4147644043 }		rotation = { -0, 0, 155.4147644043 }
Line 42:		Line 42:
	</pre>		</pre>
	</section>		</section>

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

Loki: created page for Inspect

2016-12-15T18:38:49Z

created page for Inspect

New page

{{Server client function}}
__NOTOC__
{{New items|3.0153|1.5.3|
This function returns human-readable representations of tables and MTA datatypes as a string.
}}

==Syntax==
<syntaxhighlight lang="lua">
string inspect ( mixed var )
</syntaxhighlight>

===Required Arguments===
*'''var:''' A variable of any datatype.

===Returns===
Always returns a string.

==Example==
<section name="Client" class="client" show="true">
This example draws the contents of a table and its data type:
<syntaxhighlight lang="lua">
local Table = {
["position"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},
["localplayer"] = getPlayerName(localPlayer),
}

addEventHandler("onClientRender",root,
function( )
dxDrawText(inspect(Table),10,250)
end
)
</syntaxhighlight>
An example of what it should draw:
<pre>
{
localplayer = "Loki",
position = {
position = { 2496.3908691406, -1669.853515625, 13.335947036743 },
rotation = { -0, 0, 155.4147644043 }
}
}
</pre>
</section>
==See Also==
{{Utility functions}}