Inspect

From Multi Theft Auto: Wiki
Revision as of 22:04, 29 January 2020 by Qaisjp (talk | contribs) (specify that return value _could_ change if we updated inspect)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function returns human-readable representations of tables and MTA datatypes as a string.

Syntax

string inspect ( mixed var [, table options] )    

Required Arguments

  • 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 Inspect's GitHub page.

Returns

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

Click to collapse [-]
Client

This example draws the contents of a table and its data type:

local Table = {    
    ["matrix"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},
    ["localplayer"] = getPlayerName(localPlayer),
}
local inspectedTblStr = inspect(Table)

addEventHandler("onClientRender",root,
    function( )
        --> 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
)

This is an example of what it should look like:

InspectReturn.png

See Also